org.jboss.remoting
Class RemoteClientInvoker

java.lang.Object
  org.jboss.remoting.AbstractInvoker (src) 
      org.jboss.remoting.RemoteClientInvoker

All Implemented Interfaces:

ClientInvoker (src) , Invoker (src)

Direct Known Subclasses:

HTTPClientInvoker (src) , RMIClientInvoker (src) , SocketClientInvoker (src)

public abstract class RemoteClientInvoker

extends AbstractInvoker (src)

implements ClientInvoker (src)

RemoteClientInvoker is an abstract client part handler that implements the bulk of the heavy lifting to process a remote method and dispatch it to a remote ServerInvoker and handle the result.

Specialized Client/Server Invokers might add additional functionality as part of the invocation - such as delivering queued notifcations from a remote server by adding the notification objects during each invocation to the invocation result payload and then having the client re-dispatch the notifications locally upon receiving the return invocation result.

connected

protected boolean connected

RemoteClientInvoker

public RemoteClientInvoker(InvokerLocator (src)  locator)

invoke

public java.lang.Object invoke(InvocationRequest (src)  invocationReq)
                        throws java.lang.Throwable

transport a request against a remote ServerInvoker

Specified by:

invoke in interface ClientInvoker (src)

Parameters:

invocationReq -

Returns:

Throws:

java.lang.Throwable

preProcess

protected void preProcess(java.lang.String sessionId,
                          java.lang.Object param,
                          java.util.Map sendPayload,
                          java.util.Map receivedPayload)

this method is called prior to making the remote invocation to allow the subclass the ability to provide additional data or modify the invocation

Parameters:

sessionId -

param -

sendPayload -

receivedPayload -

postProcess

protected void postProcess(java.lang.String sessionId,
                           java.lang.Object param,
                           java.util.Map sendPayload,
                           java.util.Map receivedPayload)

this method is called prior to returning the result for the invocation to allow the subclass the ability to modify the result result

Parameters:

sessionId -

param -

sendPayload -

receivedPayload -

transport

protected abstract java.lang.Object transport(java.lang.String sessionId,
                                              java.lang.Object invocation,
                                              java.util.Map metadata,
                                              Marshaller (src)  marshaller,
                                              UnMarshaller (src)  unmarshaller)
                                       throws java.io.IOException,
                                              ConnectionFailedException (src) ,
                                              java.lang.ClassNotFoundException

Parameters:

sessionId -

invocation -

marshaller -

Returns:

Throws:

java.io.IOException

ConnectionFailedException (src)

java.lang.ClassNotFoundException

isConnected

public boolean isConnected()

subclasses must provide this method to return true if their remote connection is connected and false if disconnected. in some transports, such as SOAP, this method may always return true, since the remote connectivity is done on demand and not kept persistent like other transports (such as socket-based transport).

Specified by:

isConnected in interface ClientInvoker (src)

Returns:

boolean true if connected, false if not

connect

public void connect()
             throws ConnectionFailedException (src) 

connect to the remote invoker

Specified by:

connect in interface ClientInvoker (src)

Throws:

ConnectionFailedException (src)

handleConnect

protected abstract void handleConnect()
                               throws ConnectionFailedException (src) 

subclasses must implement this method to provide a hook to connect to the remote server, if this applies to the specific transport. However, in some transport implementations, this may not make must difference since the connection is not persistent among invocations, such as SOAP. In these cases, the method should silently return without any processing.

Throws:

ConnectionFailedException (src)

handleDisconnect

protected abstract void handleDisconnect()

subclasses must implement this method to provide a hook to disconnect from the remote server, if this applies to the specific transport. However, in some transport implementations, this may not make must difference since the connection is not persistent among invocations, such as SOAP. In these cases, the method should silently return without any processing.

disconnect

public void disconnect()

disconnect from the remote invokere

Specified by:

disconnect in interface ClientInvoker (src)

setMarshaller

public void setMarshaller(Marshaller (src)  marshaller)

Specified by:

setMarshaller in interface ClientInvoker (src)

getMarshaller

public Marshaller (src)  getMarshaller()

Specified by:

getMarshaller in interface ClientInvoker (src)

setUnMarshaller

public void setUnMarshaller(UnMarshaller (src)  unmarshaller)

Specified by:

setUnMarshaller in interface ClientInvoker (src)

getUnMarshaller

public UnMarshaller (src)  getUnMarshaller()

Specified by:

getUnMarshaller in interface ClientInvoker (src)

getDefaultDataType

protected abstract java.lang.String getDefaultDataType()

Each implementation of the remote client invoker should have a default data type that is uses in the case it is not specified in the invoker locator uri.

Returns:

finalize

protected void finalize()
                 throws java.lang.Throwable

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java^TM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will transport the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Throws:

java.lang.Throwable - the Exception raised by this method