org.acplt.oncrpc.server

Class OncRpcTcpConnectionServerTransport

java.lang.Object

org.acplt.oncrpc.server.OncRpcServerTransport

org.acplt.oncrpc.server.OncRpcTcpConnectionServerTransport

public class OncRpcTcpConnectionServerTransport
extends OncRpcServerTransport

Instances of class OncRpcTcpServerTransport encapsulate TCP/IP-based XDR streams of ONC/RPC servers. This server transport class is responsible for receiving ONC/RPC calls over TCP/IP.

Version:

$Revision: 1.5 $ $Date: 2008/01/02 15:13:35 $ $State: Exp $ $Locker: $

Author:

Harald Albrecht

See Also:

OncRpcServerTransport, OncRpcTcpServerTransport, OncRpcUdpServerTransport

Field Summary

Fields

Modifier and Type	Field and Description
protected int	transmissionTimeout Timeout during the phase where data is received within calls, or data is sent within replies.

Fields inherited from class org.acplt.oncrpc.server.OncRpcServerTransport

dispatcher, info, port

Constructor Summary

Constructors

Constructor and Description
OncRpcTcpConnectionServerTransport(OncRpcDispatchable dispatcher, Socket socket, int program, int version, int bufferSize, OncRpcTcpServerTransport parent, int transmissionTimeout) Create a new instance of a OncRpcTcpSConnectionerverTransport which encapsulates TCP/IP-based XDR streams of an ONC/RPC server.
OncRpcTcpConnectionServerTransport(OncRpcDispatchable dispatcher, Socket socket, OncRpcServerTransportRegistrationInfo[] info, int bufferSize, OncRpcTcpServerTransport parent, int transmissionTimeout) Create a new instance of a OncRpcTcpSConnectionerverTransport which encapsulates TCP/IP-based XDR streams of an ONC/RPC server.

Method Summary

Modifier and Type	Method and Description
protected void	beginEncoding(OncRpcCallInformation callInfo, OncRpcServerReplyMessage state) Begins the sending phase for ONC/RPC replies.
void	close() Close the server transport and free any resources associated with it.
protected void	endDecoding() Finishes call parameter deserialization.
protected void	endEncoding() Finishes encoding the reply to this ONC/RPC call.
protected void	finalize() Finalize object by making sure that we're removed from the list of open transports which our parent transport maintains.
String	getCharacterEncoding() Get the character encoding for (de-)serializing strings.
protected XdrDecodingStream	getXdrDecodingStream() Returns XDR stream which can be used for deserializing the parameters of this ONC/RPC call.
protected XdrEncodingStream	getXdrEncodingStream() Returns XDR stream which can be used for eserializing the reply to this ONC/RPC call.
void	listen() Creates a new thread and uses this thread to handle the new connection to receive ONC/RPC requests, then dispatching them and finally sending back reply messages.
void	register() Do not call.
protected void	reply(OncRpcCallInformation callInfo, OncRpcServerReplyMessage state, XdrAble reply) Send back an ONC/RPC reply to the original caller.
void	retrieveCall(XdrAble call) Retrieves the parameters sent within an ONC/RPC call message.
void	setCharacterEncoding(String characterEncoding) Set the character encoding for (de-)serializing strings.

Methods inherited from class org.acplt.oncrpc.server.OncRpcServerTransport

getPort, unregister

Methods inherited from class java.lang.Object

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

Field Detail

transmissionTimeout

protected int transmissionTimeout

Timeout during the phase where data is received within calls, or data is sent within replies.

Constructor Detail

OncRpcTcpConnectionServerTransport

public OncRpcTcpConnectionServerTransport(OncRpcDispatchable dispatcher,
                                          Socket socket,
                                          int program,
                                          int version,
                                          int bufferSize,
                                          OncRpcTcpServerTransport parent,
                                          int transmissionTimeout)
                                   throws OncRpcException,
                                          IOException

Create a new instance of a OncRpcTcpSConnectionerverTransport which encapsulates TCP/IP-based XDR streams of an ONC/RPC server. This particular server transport handles individual ONC/RPC connections over TCP/IP. This constructor is a convenience constructor for those transports handling only a single ONC/RPC program and version number.

Parameters:

dispatcher - Reference to interface of an object capable of dispatching (handling) ONC/RPC calls.

socket - TCP/IP-based socket of new connection.

program - Number of ONC/RPC program handled by this server transport.

version - Version number of ONC/RPC program handled.

bufferSize - Size of buffer used when receiving and sending chunks of XDR fragments over TCP/IP. The fragments built up to form ONC/RPC call and reply messages.

parent - Parent server transport which created us.

transmissionTimeout - Inherited transmission timeout.

Throws:

OncRpcException - if an RPC error occurs.

IOException - if an IO error occurs.

OncRpcTcpConnectionServerTransport

public OncRpcTcpConnectionServerTransport(OncRpcDispatchable dispatcher,
                                          Socket socket,
                                          OncRpcServerTransportRegistrationInfo[] info,
                                          int bufferSize,
                                          OncRpcTcpServerTransport parent,
                                          int transmissionTimeout)
                                   throws OncRpcException,
                                          IOException

Create a new instance of a OncRpcTcpSConnectionerverTransport which encapsulates TCP/IP-based XDR streams of an ONC/RPC server. This particular server transport handles individual ONC/RPC connections over TCP/IP.

Parameters:

dispatcher - Reference to interface of an object capable of dispatching (handling) ONC/RPC calls.

socket - TCP/IP-based socket of new connection.

info - Array of program and version number tuples of the ONC/RPC programs and versions handled by this transport.

bufferSize - Size of buffer used when receiving and sending chunks of XDR fragments over TCP/IP. The fragments built up to form ONC/RPC call and reply messages.

parent - Parent server transport which created us.

transmissionTimeout - Inherited transmission timeout.

Throws:

OncRpcException - if an RPC error occurs.

IOException - if an IO error occurs.

Method Detail

close

public void close()

Close the server transport and free any resources associated with it.

Note that the server transport is not deregistered. You'll have to do it manually if you need to do so. The reason for this behaviour is, that the portmapper removes all entries regardless of the protocol (TCP/IP or UDP/IP) for a given ONC/RPC program number and version.

Calling this method on a OncRpcTcpServerTransport results in the listening TCP network socket immediately being closed. The handler thread will therefore either terminate directly or when it tries to sent back replies.

Specified by:

close in class OncRpcServerTransport

finalize

protected void finalize()

Finalize object by making sure that we're removed from the list of open transports which our parent transport maintains.

Overrides:

finalize in class Object

register

public void register()
              throws OncRpcException

Do not call.

Specified by:

register in class OncRpcServerTransport

Throws:

Error - because this method must not be called for an individual TCP/IP-based server transport.

OncRpcException - if the portmapper could not be contacted successfully.

retrieveCall

public void retrieveCall(XdrAble call)
                  throws OncRpcException,
                         IOException

Retrieves the parameters sent within an ONC/RPC call message. It also makes sure that the deserialization process is properly finished after the call parameters have been retrieved. Under the hood this method therefore calls XdrDecodingStream.endDecoding() to free any pending resources from the decoding stage.

Specified by:

retrieveCall in class OncRpcServerTransport

Parameters:

call - An XDR able object instance, where to decode the call information in.

Throws:

OncRpcException - if an ONC/RPC exception occurs, like the data could not be successfully deserialized.

IOException - if an I/O exception occurs, like transmission failures over the network, etc.

getXdrDecodingStream

protected XdrDecodingStream getXdrDecodingStream()

Returns XDR stream which can be used for deserializing the parameters of this ONC/RPC call. This method belongs to the lower-level access pattern when handling ONC/RPC calls.

Specified by:

getXdrDecodingStream in class OncRpcServerTransport

Returns:

Reference to decoding XDR stream.

endDecoding

protected void endDecoding()
                    throws OncRpcException,
                           IOException

Finishes call parameter deserialization. Afterwards the XDR stream returned by getXdrDecodingStream() must not be used any more. This method belongs to the lower-level access pattern when handling ONC/RPC calls.

Specified by:

endDecoding in class OncRpcServerTransport

Throws:

OncRpcException - if an ONC/RPC exception occurs, like the data could not be successfully deserialized.

IOException - if an I/O exception occurs, like transmission failures over the network, etc.

getXdrEncodingStream

protected XdrEncodingStream getXdrEncodingStream()

Returns XDR stream which can be used for eserializing the reply to this ONC/RPC call. This method belongs to the lower-level access pattern when handling ONC/RPC calls.

Specified by:

getXdrEncodingStream in class OncRpcServerTransport

Returns:

Reference to enecoding XDR stream.

beginEncoding

protected void beginEncoding(OncRpcCallInformation callInfo,
                             OncRpcServerReplyMessage state)
                      throws OncRpcException,
                             IOException

Begins the sending phase for ONC/RPC replies. This method belongs to the lower-level access pattern when handling ONC/RPC calls.

Specified by:

beginEncoding in class OncRpcServerTransport

Parameters:

callInfo - Information about ONC/RPC call for which we are about to send back the reply.

state - ONC/RPC reply header indicating success or failure.

Throws:

OncRpcException - if an ONC/RPC exception occurs, like the data could not be successfully serialized.

IOException - if an I/O exception occurs, like transmission

endEncoding

protected void endEncoding()
                    throws OncRpcException,
                           IOException

Finishes encoding the reply to this ONC/RPC call. Afterwards you must not use the XDR stream returned by getXdrEncodingStream() any longer.

Specified by:

endEncoding in class OncRpcServerTransport

Throws:

OncRpcException - if an ONC/RPC exception occurs, like the data could not be successfully serialized.

IOException - if an I/O exception occurs, like transmission failures over the network, etc.

reply

protected void reply(OncRpcCallInformation callInfo,
                     OncRpcServerReplyMessage state,
                     XdrAble reply)
              throws OncRpcException,
                     IOException

Send back an ONC/RPC reply to the original caller. This is rather a low-level method, typically not used by applications. Dispatcher handling ONC/RPC calls have to use the OncRpcCallInformation.reply(XdrAble) method instead on the call object supplied to the handler.

Specified by:

reply in class OncRpcServerTransport

Parameters:

callInfo - information about the original call, which are necessary to send back the reply to the appropriate caller.

state - ONC/RPC reply message header indicating success or failure and containing associated state information.

reply - If not null, then this parameter references the reply to be serialized after the reply message header.

Throws:

OncRpcException - if an ONC/RPC exception occurs, like the data could not be successfully serialized.

IOException - if an I/O exception occurs, like transmission failures over the network, etc.

See Also:

OncRpcCallInformation, OncRpcDispatchable

listen

public void listen()

Creates a new thread and uses this thread to handle the new connection to receive ONC/RPC requests, then dispatching them and finally sending back reply messages. Control in the calling thread immediately returns after the handler thread has been created.

Currently only one call after the other is dispatched, so no multithreading is done when receiving multiple calls. Instead, later calls have to wait for the current call to finish before they are handled.

Specified by:

listen in class OncRpcServerTransport

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)

Set the character encoding for (de-)serializing strings.

Specified by:

setCharacterEncoding in class OncRpcServerTransport

Parameters:

characterEncoding - the encoding to use for (de-)serializing strings. If null, the system's default encoding is to be used.

getCharacterEncoding

public String getCharacterEncoding()

Get the character encoding for (de-)serializing strings.

Specified by:

getCharacterEncoding in class OncRpcServerTransport

Returns:

the encoding currently used for (de-)serializing strings. If null, then the system's default encoding is used.