com.vmware.vapi.protocol.server.msg.json

Class JsonServerConnection

java.lang.Object

com.vmware.vapi.protocol.server.msg.json.JsonServerConnection

All Implemented Interfaces:

RequestReceiver

public final class JsonServerConnection
extends Object
implements RequestReceiver

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vapi.protocol.server.rpc.RequestReceiver

RequestReceiver.RequestContext, RequestReceiver.TransportContext

Constructor Summary

Constructors

Constructor and Description
JsonServerConnection(ApiProvider provider, List<RequestProcessor> processorChain) Creates a handler which translates JSON-RPC 2.0 requests to ApiProvider method calls.

Method Summary

Modifier and Type	Method and Description
void	requestReceived(InputStream request, RequestReceiver.TransportContext transport) Notifies the request receiver that a new request is received.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonServerConnection

public JsonServerConnection(ApiProvider provider,
                            List<RequestProcessor> processorChain)

Creates a handler which translates JSON-RPC 2.0 requests to ApiProvider method calls.

Parameters:

provider - all ApiProvider method calls will be delegated to this provider; must not be null

processorChain - chain of processors which will be invoked on each JSON request; the input of each processor is the output of the previous processor in the chain; the input to the first processor is the original JSON request; processors are executed before the request gets translated into an ApiProvider call; must not be null

Method Detail

requestReceived

public void requestReceived(InputStream request,
                            RequestReceiver.TransportContext transport)
                     throws IOException

Description copied from interface: RequestReceiver

Notifies the request receiver that a new request is received.

There is no guarantee that the request is completely handled when this method exits. The implementation is free to handle the request asynchronously. Only after the RequestReceiver.TransportContext.send(java.io.InputStream, int, boolean) with true value for the isFinal parameter is invoked, it is certain that the request is completely processed and all responses have been sent.

Specified by:

requestReceived in interface RequestReceiver

Parameters:

request - request frame; must not be null

transport - transport handle which can be used to send responses; this handle is strongly correlated with the request; use it to send responses only for this particular request; must not be null

Throws:

IOException - propagate an error coming from the transport module (e.g. thrown by the request stream or by the transport handle)