org.jboss.remoting.transport
Interface ClientInvoker

All Superinterfaces:

Invoker

All Known Implementing Classes:

HTTPClientInvoker, HTTPSClientInvoker, LocalClientInvoker, MultiplexClientInvoker, RemoteClientInvoker, RMIClientInvoker, SocketClientInvoker, SSLMultiplexClientInvoker, SSLSocketClientInvoker

public interface ClientInvoker
extends Invoker

Interface to be used for calling on all the different invoker types (LocalClientInvoker and RemoteClientInvoker).

Author:

Tom Elrod

Method Summary

void	addClientLocator(java.lang.String listenerId, InvokerLocator locator) This should be set when want to override the default behavior of automatically getting s suitable locator.
void	connect() connect to the remote invoker
void	disconnect() disconnect from the remote invokere
InvokerLocator	getClientLocator(java.lang.String listenerId) Gets the client locator.
Marshaller	getMarshaller()
UnMarshaller	getUnMarshaller()
java.lang.Object	invoke(InvocationRequest in) transport a request against a remote ServerInvoker
boolean	isConnected() subclasses must provide this method to return true if their remote connection is connected and false if disconnected.
void	setMarshaller(Marshaller marshaller)
void	setUnMarshaller(UnMarshaller unmarshaller)

Methods inherited from interface org.jboss.remoting.Invoker

getLocator

Method Detail

addClientLocator

void addClientLocator(java.lang.String listenerId,
                      InvokerLocator locator)

This should be set when want to override the default behavior of automatically getting s suitable locator. This should be used want want to control what type of callbacks to receive (pull or push). Set to null to poll for callback messages. This can also be used to receive callbacks using another transport and subsystem, if desired.

Parameters:

locator -

getClientLocator

InvokerLocator getClientLocator(java.lang.String listenerId)

Gets the client locator. This locator will be used by the server side to make callbacks to the handler for this locator.

Returns:

invoke

java.lang.Object invoke(InvocationRequest in)
                        throws java.lang.Throwable

transport a request against a remote ServerInvoker

Parameters:

in -

Returns:

Throws:

java.lang.Throwable

isConnected

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).

Returns:

boolean true if connected, false if not

connect

void connect()
             throws ConnectionFailedException

connect to the remote invoker

Throws:

ConnectionFailedException

disconnect

void disconnect()

disconnect from the remote invokere

setMarshaller

void setMarshaller(Marshaller marshaller)

getMarshaller

Marshaller getMarshaller()

setUnMarshaller

void setUnMarshaller(UnMarshaller unmarshaller)

getUnMarshaller

UnMarshaller getUnMarshaller()