Package chemaxon.marvin.services.json

Class JsonServiceDescriptor

java.lang.Object

chemaxon.marvin.services.ServiceDescriptor

chemaxon.marvin.services.json.JsonServiceDescriptor

@PublicApi
public class JsonServiceDescriptor
extends ServiceDescriptor

Service descriptor of JSON type requests.

Since:

5.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JsonServiceDescriptor.Method	request method

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTOR_URI	Property key for Service descriptor as String

Fields inherited from class chemaxon.marvin.services.ServiceDescriptor

ALIAS, ARGUMENTS, DESCRIPTION, METHOD, NAME, propertyChangeSupport, serviceHandler, URL

Constructor Summary

Constructors

Constructor	Description
JsonServiceDescriptor()

Method Summary

Modifier and Type	Method	Description
JsonServiceHandler	createServiceHandler()	Creates a new service handler for this descriptor.
String	getDescriptorURI()	Gets the URI of the JSON RPC descriptor file
static int	getId(String operationName)	Gets an ID for a method name, to make sure the client can identify the answer for the request.
JsonServiceDescriptor.Method	getRequestMethod()	Gets the HTTP method of the request.
String	getSimpleName()	Returns the simple name of the service type
void	setDescriptorURI(String descriptorURI)	Sets the URI of the JSON RPC descriptor file
void	setRequestMethod(JsonServiceDescriptor.Method requestMethod)	Sets the HTTP method of the request.

Methods inherited from class chemaxon.marvin.services.ServiceDescriptor

addArgument, getAlias, getArgument, getArgumentCount, getArguments, getDescription, getIcon, getMethodName, getName, getProperty, getPropertyChangeSupport, getPropertyKeys, getServiceHandler, getURL, isAvailable, removeArgument, setAlias, setArgument, setDescription, setMethodName, setName, setProperty, setURL, toString

Methods inherited from class java.lang.Object

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

Field Details

DESCRIPTOR_URI

public static final String DESCRIPTOR_URI

Property key for Service descriptor as String

See Also:

• Constant Field Values

Constructor Details

JsonServiceDescriptor

public JsonServiceDescriptor()

Method Details

getRequestMethod

public JsonServiceDescriptor.Method getRequestMethod()

Gets the HTTP method of the request.

Returns:

The HTTP method of the request

setRequestMethod

public void setRequestMethod(JsonServiceDescriptor.Method requestMethod)

Sets the HTTP method of the request.

Parameters:

requestMethod - The HTTP method of the request

getSimpleName

public String getSimpleName()

Description copied from class: ServiceDescriptor

Returns the simple name of the service type

Overrides:

getSimpleName in class ServiceDescriptor

Returns:

the simple name of the service type

getDescriptorURI

public String getDescriptorURI()

Gets the URI of the JSON RPC descriptor file

Returns:

URI of JSON RPC descriptor file

setDescriptorURI

public void setDescriptorURI(String descriptorURI)

Sets the URI of the JSON RPC descriptor file

Parameters:

descriptorURI - URI of JSON RPC descriptor file

getId

public static int getId(String operationName)

Gets an ID for a method name, to make sure the client can identify the answer for the request.

Parameters:

operationName - The name of the selected operation.

Returns:

An integer ID that is usable for the next method call of the given operation.

createServiceHandler

public JsonServiceHandler createServiceHandler()

Description copied from class: ServiceDescriptor

Creates a new service handler for this descriptor. The returned handler is capable to perform service call on the service described by this descriptor

Specified by:

createServiceHandler in class ServiceDescriptor

Returns:

a service handler instance for this descriptor