org.stefaniuk.json.service

Annotation Type JsonService

@Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD})
 @Documented
public @interface JsonService

JSON service annotation.

Each class registered with JsonServiceRegistry should provide methods to be available to call by a client. It is up to a developer to decide if a public method needs to be exposed to a JSON-RPC client. Only annotated methods with JsonService declared with the public modifier will be reflected in Service Mapping Description and made accessible to a client.

Since:

2010/09/20

Version:

1.0.0

Author:

Daniel Stefaniuk

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
JsonServiceInvoker.ContentType	contentType This is the expected content type of the content returned by a service.
String	description This is a description of the service.
JsonServiceInvoker.Envelope	envelope Envelope defines how a service message string is created from the provided parameters.
String	target This should indicate what URL to use for the method call requests.
JsonServiceInvoker.Transport	transport The transport property defines the transport mechanism to be used to deliver service calls to server.

Element Detail

transport

public abstract JsonServiceInvoker.Transport transport

The transport property defines the transport mechanism to be used to deliver service calls to server.

Default:

org.stefaniuk.json.service.JsonServiceInvoker.Transport.POST

contentType

public abstract JsonServiceInvoker.ContentType contentType

This is the expected content type of the content returned by a service.

Default:

org.stefaniuk.json.service.JsonServiceInvoker.ContentType.APPLICATION_JSON

envelope

public abstract JsonServiceInvoker.Envelope envelope

Envelope defines how a service message string is created from the provided parameters.

Default:

org.stefaniuk.json.service.JsonServiceInvoker.Envelope.JSON_RPC_2_0

target

public abstract String target

This should indicate what URL to use for the method call requests.

Default:

""

description

public abstract String description

This is a description of the service.

Default:

""