Package com.rabbitmq.tools.jsonrpc
Class ServiceDescription
java.lang.Object
com.rabbitmq.tools.jsonrpc.ServiceDescription
Description of a JSON-RPC service.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Human-readable instructions for how to get information on the service's operationprivate String
ID for the servicestatic final String
private String
The service nameprivate Map
<String, ProcedureDescription> Map from procedure name toProcedureDescription
private String
Human-readable summary for the serviceprivate String
Version of the service -
Constructor Summary
ConstructorsConstructorDescriptionServiceDescription
(Class<?> klass) ServiceDescription
(Map<String, Object> rawServiceDescription) -
Method Summary
Modifier and TypeMethodDescriptionprivate void
Private API - used during initializationgetHelp()
getId()
getName()
getProcedure
(String newname, int arity) Looks up a single ProcedureDescription by name and arity.getProcs()
Gets a collection of allProcedureDescription
for this servicevoid
void
void
void
setProcs
(Collection<Map<String, Object>> p) Private API - used via reflection during parsing/loadingvoid
setSummary
(String summary) void
setVersion
(String version)
-
Field Details
-
JSON_RPC_VERSION
- See Also:
-
name
The service name -
id
ID for the service -
version
Version of the service -
summary
Human-readable summary for the service -
help
Human-readable instructions for how to get information on the service's operation -
procedures
Map from procedure name toProcedureDescription
-
-
Constructor Details
-
ServiceDescription
-
ServiceDescription
-
ServiceDescription
public ServiceDescription()
-
-
Method Details
-
getProcs
Gets a collection of allProcedureDescription
for this service -
setProcs
Private API - used via reflection during parsing/loading -
addProcedure
Private API - used during initialization -
getProcedure
Looks up a single ProcedureDescription by name and arity.- Returns:
- non-null ProcedureDescription if a match is found
- Throws:
IllegalArgumentException
- if no match is found
-
getName
-
getId
-
getVersion
-
getSummary
-
getHelp
-
setName
-
setId
-
setVersion
-
setSummary
-
setHelp
-