Class ServiceDescription


  • public class ServiceDescription
    extends java.lang.Object
    Description of a JSON-RPC service.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String help
      Human-readable instructions for how to get information on the service's operation
      private java.lang.String id
      ID for the service
      static java.lang.String JSON_RPC_VERSION  
      private java.lang.String name
      The service name
      private java.util.Map<java.lang.String,​ProcedureDescription> procedures
      Map from procedure name to ProcedureDescription
      private java.lang.String summary
      Human-readable summary for the service
      private java.lang.String version
      Version of the service
    • Field Detail

      • JSON_RPC_VERSION

        public static final java.lang.String JSON_RPC_VERSION
        See Also:
        Constant Field Values
      • name

        private java.lang.String name
        The service name
      • id

        private java.lang.String id
        ID for the service
      • version

        private java.lang.String version
        Version of the service
      • summary

        private java.lang.String summary
        Human-readable summary for the service
      • help

        private java.lang.String help
        Human-readable instructions for how to get information on the service's operation
    • Constructor Detail

      • ServiceDescription

        public ServiceDescription​(java.util.Map<java.lang.String,​java.lang.Object> rawServiceDescription)
      • ServiceDescription

        public ServiceDescription​(java.lang.Class<?> klass)
      • ServiceDescription

        public ServiceDescription()
    • Method Detail

      • setProcs

        public void setProcs​(java.util.Collection<java.util.Map<java.lang.String,​java.lang.Object>> p)
        Private API - used via reflection during parsing/loading
      • addProcedure

        private void addProcedure​(ProcedureDescription proc)
        Private API - used during initialization
      • getProcedure

        public ProcedureDescription getProcedure​(java.lang.String newname,
                                                 int arity)
        Looks up a single ProcedureDescription by name and arity.
        Returns:
        non-null ProcedureDescription if a match is found
        Throws:
        java.lang.IllegalArgumentException - if no match is found
      • getName

        public java.lang.String getName()
      • getId

        public java.lang.String getId()
      • getVersion

        public java.lang.String getVersion()
      • getSummary

        public java.lang.String getSummary()
      • getHelp

        public java.lang.String getHelp()
      • setName

        public void setName​(java.lang.String name)
      • setId

        public void setId​(java.lang.String id)
      • setVersion

        public void setVersion​(java.lang.String version)
      • setSummary

        public void setSummary​(java.lang.String summary)
      • setHelp

        public void setHelp​(java.lang.String help)