Package com.rabbitmq.tools.jsonrpc

Class ServiceDescription

java.lang.Object

com.rabbitmq.tools.jsonrpc.ServiceDescription

public class ServiceDescription
extends Object

Description of a JSON-RPC service.

Field Summary

Fields

Modifier and Type	Field	Description
String	help	Human-readable instructions for how to get information on the service's operation
String	id	ID for the service
static final String	JSON_RPC_VERSION
String	name	The service name
String	summary	Human-readable summary for the service
String	version	Version of the service

Constructor Summary

Constructors

Constructor	Description
ServiceDescription()
ServiceDescription(Class<?> klass)
ServiceDescription(Map<String,Object> rawServiceDescription)

Method Summary

Modifier and Type	Method	Description
ProcedureDescription	getProcedure(String newname, int arity)	Looks up a single ProcedureDescription by name and arity.
Collection<ProcedureDescription>	getProcs()	Gets a collection of all ProcedureDescription for this service
void	setProcs(Collection<Map<String,Object>> p)	Private API - used via reflection during parsing/loading

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JSON_RPC_VERSION

public static final String JSON_RPC_VERSION

See Also:

• Constant Field Values

name

public String name

The service name

id

public String id

ID for the service

version

public String version

Version of the service

summary

public String summary

Human-readable summary for the service

help

public String help

Human-readable instructions for how to get information on the service's operation

Constructor Details

ServiceDescription

public ServiceDescription(Map<String,Object> rawServiceDescription)

ServiceDescription

public ServiceDescription(Class<?> klass)

ServiceDescription

public ServiceDescription()

Method Details

getProcs

public Collection<ProcedureDescription> getProcs()

Gets a collection of all ProcedureDescription for this service

setProcs

public void setProcs(Collection<Map<String,Object>> p)

Private API - used via reflection during parsing/loading

getProcedure

public ProcedureDescription getProcedure(String newname,
 int arity)

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