org.apache.avro.ipc
Class RPCContext

java.lang.Object
  org.apache.avro.ipc.RPCContext

public class RPCContext
extends Object

This class represents the context of an RPC call or RPC handshake. Designed to provide information to RPC plugin writers, this class encapsulates information about the rpc exchange, including per-session and per-call metadata.

Field Summary

protected AvroRemoteException	error
protected Map<Utf8,ByteBuffer>	requestCallMeta
protected Map<Utf8,ByteBuffer>	requestSessionMeta
protected Object	response
protected Map<Utf8,ByteBuffer>	responseCallMeta
protected Map<Utf8,ByteBuffer>	responseSessionMeta

Constructor Summary

RPCContext()

Method Summary

AvroRemoteException	error() The exception generated at the server, or null if no such exception has occured
boolean	isError() Indicates whether an exception was generated at the server
Map<Utf8,ByteBuffer>	requestCallMeta() This is an access method for the per-call state provided by the client to the server.
Map<Utf8,ByteBuffer>	requestSessionMeta() This is an access method for the session state provided by the client to the server.
Object	response() The response object generated at the server, if it exists.
Map<Utf8,ByteBuffer>	responseCallMeta() This is an access method for the per-call state provided by the server back to the client.
Map<Utf8,ByteBuffer>	responseSessionMeta() This is an access method for the session state provided by the server back to the client

Methods inherited from class java.lang.Object

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

Field Detail

requestSessionMeta

protected Map<Utf8,ByteBuffer> requestSessionMeta

responseSessionMeta

protected Map<Utf8,ByteBuffer> responseSessionMeta

requestCallMeta

protected Map<Utf8,ByteBuffer> requestCallMeta

responseCallMeta

protected Map<Utf8,ByteBuffer> responseCallMeta

response

protected Object response

error

protected AvroRemoteException error

Constructor Detail

RPCContext

public RPCContext()

Method Detail

requestSessionMeta

public Map<Utf8,ByteBuffer> requestSessionMeta()

This is an access method for the session state provided by the client to the server.

Returns:

a map representing session state from the client to the server

responseSessionMeta

public Map<Utf8,ByteBuffer> responseSessionMeta()

This is an access method for the session state provided by the server back to the client

Returns:

a map representing session state from the server to the client

requestCallMeta

public Map<Utf8,ByteBuffer> requestCallMeta()

This is an access method for the per-call state provided by the client to the server.

Returns:

a map representing per-call state from the client to the server

responseCallMeta

public Map<Utf8,ByteBuffer> responseCallMeta()

This is an access method for the per-call state provided by the server back to the client.

Returns:

a map representing per-call state from the server to the client

response

public Object response()

The response object generated at the server, if it exists. If an exception was generated, this will be null.

Returns:

the response created by this RPC, no null if an exception was generated

error

public AvroRemoteException error()

The exception generated at the server, or null if no such exception has occured

Returns:

the exception generated at the server, or null if no such exception

isError

public boolean isError()

Indicates whether an exception was generated at the server

Returns:

true is an exception was generated at the server, or false if not