com.vmware.vapi.protocol.server.rpc

Interface RequestReceiver.TransportContext

Enclosing interface:

RequestReceiver

public static interface RequestReceiver.TransportContext

Transport handle which can be used to send responses or retrieve transport specific information.

Method Summary

Modifier and Type	Method and Description
RequestReceiver.RequestContext	getRequestContext() Gets information about the client request.
void	send(InputStream response, int responseLength, boolean isFinal) Sends a response frame for the request which is associated with this transport handle.
void	setHeader(String name, String value) Sets a response header with the given name and value.

Method Detail

send

void send(InputStream response,
          int responseLength,
          boolean isFinal)
   throws IOException

Sends a response frame for the request which is associated with this transport handle. If the response is flagged as final, the handling of the request is considered complete and no more response frames can be sent. For each request there must be exactly one response frame flagged as final.

Parameters:

response - response frame; must not be null

responseLength - length of the request as number of bytes; this is just a hint to the implementation, pass -1 if the length is unknown

isFinal - whether this is the final response frame for the request

Throws:

IOException - transport error

getRequestContext

RequestReceiver.RequestContext getRequestContext()

Gets information about the client request.

Returns:

the request context.

setHeader

void setHeader(String name,
               String value)

Sets a response header with the given name and value. If the header has already been set, the new value overwrites the previous one. Case-sensitivity of the header name depends on the underlying transport (e.g. header names are case insensitive for HTTP 1.1).

Parameters:

name - the name of the header

value - the header value