org.refcodes.remoting.impls

Class RemoteClientImpl

java.lang.Object

org.refcodes.component.impls.AbstractConnectableAutomaton

org.refcodes.remoting.impls.AbstractRemote

org.refcodes.remoting.impls.RemoteClientImpl

All Implemented Interfaces:

org.refcodes.collection.mixins.Clearable, org.refcodes.collection.mixins.Containable, org.refcodes.component.Component, org.refcodes.component.ConnectableComponent, org.refcodes.component.ConnectableComponent.ConnectableAutomaton, org.refcodes.component.ConnectionComponent<Transceiver<Serializable>>, org.refcodes.component.ConnectionComponent.ConnectionAutomaton<Transceiver<Serializable>>, org.refcodes.component.mixins.Closable, org.refcodes.component.mixins.Closable.CloseAutomaton, org.refcodes.component.mixins.ClosedAccessor, org.refcodes.component.mixins.ConnectionOpenable<Transceiver<Serializable>>, org.refcodes.component.mixins.ConnectionOpenable.ConnectionOpenAutomaton<Transceiver<Serializable>>, org.refcodes.component.mixins.ConnectionStatusAccessor, org.refcodes.component.mixins.Destroyable, org.refcodes.component.mixins.OpenedAccessor, org.refcodes.mixin.mixins.BusyAccessor, Remote, RemoteClient

public class RemoteClientImpl
extends AbstractRemote
implements RemoteClient

Abstract implementation of the RemoteClient's base functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RemoteClientImpl.MethodRequestJobFactoryImpl Implementation of the TypedRecyclingFactory creating instances of the according type.
protected static class	RemoteClientImpl.SignOffProxyJobFactoryImpl Implementation of the TypedRecyclingFactory creating instances of the according type.

Nested classes/interfaces inherited from class org.refcodes.remoting.impls.AbstractRemote

AbstractRemote.CancelMethodReplyJobFactoryImpl, AbstractRemote.JobDigesterDaemonFactoryImpl, AbstractRemote.PublishSubjectReplyJobFactoryImpl

Nested classes/interfaces inherited from interface org.refcodes.remoting.RemoteClient

RemoteClient.ProxyControl

Nested classes/interfaces inherited from interface org.refcodes.component.mixins.Destroyable

org.refcodes.component.mixins.Destroyable.DestroyAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectableComponent

org.refcodes.component.ConnectableComponent.ConnectableAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionComponent

org.refcodes.component.ConnectionComponent.ConnectionAutomaton<CON>

Nested classes/interfaces inherited from interface org.refcodes.component.mixins.ConnectionOpenable

org.refcodes.component.mixins.ConnectionOpenable.ConnectionOpenAutomaton<CON>

Nested classes/interfaces inherited from interface org.refcodes.component.mixins.OpenedAccessor

org.refcodes.component.mixins.OpenedAccessor.OpenedMutator, org.refcodes.component.mixins.OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface org.refcodes.component.mixins.Closable

org.refcodes.component.mixins.Closable.CloseAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.mixins.ClosedAccessor

org.refcodes.component.mixins.ClosedAccessor.ClosedMutator, org.refcodes.component.mixins.ClosedAccessor.ClosedProperty

Nested classes/interfaces inherited from interface org.refcodes.component.mixins.ConnectionStatusAccessor

org.refcodes.component.mixins.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.mixins.ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.mixins.BusyAccessor

org.refcodes.mixin.mixins.BusyAccessor.BusyMutator, org.refcodes.mixin.mixins.BusyAccessor.BusyProperty

Constructor Summary

Constructors

Constructor and Description
RemoteClientImpl()
RemoteClientImpl(ExecutorService aExecutorService)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	close()
protected void	close(CloseConnectionMessage aJob) Takes care of closing the RemoteClient depending on the CloseConnectionMessage received from the RemoteServer counterpart.
void	destroy()
protected void	digest(Message aJob) The AbstractRemote.digest(Message) method is invoked in order to trigger processing of the provided Message, e.g. start execution depending on the Message instance being provided from the outside.
protected void	doSendJob(Message aJob) For testing purposes, any job can be manually pushed into the job process to the receiver.
<T> T	getProxy(Class<T> aType) Returns the proxy which can be cast to the given type.
boolean	hasProxy(Class<?> aType) Returns true if there is at least one proxy of the given type.
boolean	hasProxy(Object proxy) Returns true if the provided proxy is contained inside the RemoteClient.
boolean	isBusy() ------------------------------------------------------------------------- TODO: Enhance the isBusy() method, e.g. are there any threads active?
boolean	isEmpty()
protected void	onProxyPublished(Object aProxy) Hook when a proxy has been published.
protected void	onProxySignedOff(Object aProxy) Hook when a proxy has been signed-off.
protected void	onPublishProxy(Class<?> aType) Hook when a proxy is about to be published.
Iterator<Object>	proxies() Returns a read-only iterator containing all the proxy objects previously being published.
boolean	signOffProxy(Object aProxy) Signs off an instance previously published using the publishClassDescriptor() method.
int	size()

Methods inherited from class org.refcodes.remoting.impls.AbstractRemote

fromSender, getExecutorService, isDestroyed, isOpenable, onClosed, onOpened, open, toReceiver

Methods inherited from class org.refcodes.component.impls.AbstractConnectableAutomaton

getConnectionStatus, isClosable, isClosed, isOpenable, isOpened, open, setConnectionStatus

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.component.mixins.ConnectionOpenable.ConnectionOpenAutomaton

isOpenable

Methods inherited from interface org.refcodes.component.mixins.ConnectionOpenable

open

Methods inherited from interface org.refcodes.component.mixins.OpenedAccessor

isOpened

Methods inherited from interface org.refcodes.component.mixins.Closable.CloseAutomaton

isClosable

Methods inherited from interface org.refcodes.component.mixins.ClosedAccessor

isClosed

Methods inherited from interface org.refcodes.component.mixins.ConnectionStatusAccessor

getConnectionStatus

Constructor Detail

RemoteClientImpl

public RemoteClientImpl()

RemoteClientImpl

public RemoteClientImpl(ExecutorService aExecutorService)

Method Detail

clear

public void clear()

Specified by:

clear in interface org.refcodes.collection.mixins.Clearable

close

public void close()

Specified by:

close in interface org.refcodes.component.mixins.Closable

Overrides:

close in class AbstractRemote

isBusy

public boolean isBusy()

------------------------------------------------------------------------- TODO: Enhance the isBusy() method, e.g. are there any threads active? -------------------------------------------------------------------------

Specified by:

isBusy in interface org.refcodes.mixin.mixins.BusyAccessor

hasProxy

public boolean hasProxy(Object proxy)

Returns true if the provided proxy is contained inside the RemoteClient.

Specified by:

hasProxy in interface RemoteClient

Parameters:

proxy - The proxy to be tested if it is contained inside the RemoteClient.

Returns:

True if the given proxy is contained inside the RemoteClient.

getProxy

public <T> T getProxy(Class<T> aType)
               throws AmbiguousProxyException,
                      NoSuchProxyException

Returns the proxy which can be cast to the given type. Note that this method may throw an AmbiguousProxyException even if RemoteClient.hasProxy(Class) returns true! The method RemoteClient.hasProxy(Class) returns true in case at least one proxy of the given type was found whereas this method only returns a proxy in case there is exactly one proxy of the required type is present.

Specified by:

getProxy in interface RemoteClient

Returns:

The proxy for an instance of the given type.

Throws:

AmbiguousProxyException - Thrown in case a proxy for a given type was requested but more than one proxies matched the requested type.

NoSuchProxyException - Thrown in case a proxy for a given type was requested but not any proxy matched the requested type.

hasProxy

public boolean hasProxy(Class<?> aType)

Returns true if there is at least one proxy of the given type.

Specified by:

hasProxy in interface RemoteClient

Returns:

True in case there is at least one proxy of the given type.

proxies

public Iterator<Object> proxies()

Returns a read-only iterator containing all the proxy objects previously being published. Use the sign-off methods in order to remove a published proxy object.

Specified by:

proxies in interface RemoteClient

Returns:

An iterator containing the published proxy objects.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.refcodes.collection.mixins.Containable

signOffProxy

public boolean signOffProxy(Object aProxy)
                     throws org.refcodes.component.traps.OpenException

Signs off an instance previously published using the publishClassDescriptor() method.

Specified by:

signOffProxy in interface RemoteClient

Parameters:

aProxy - An object of type GenericInstanceDescriptor containing the information needed to sign-off an instance.

Returns:

True is returned if the instance described by the proxy object could be signed off, else false is returned

Throws:

org.refcodes.component.traps.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

size

public int size()

Specified by:

size in interface org.refcodes.collection.mixins.Containable

destroy

public void destroy()

Specified by:

destroy in interface org.refcodes.component.mixins.Destroyable

Overrides:

destroy in class AbstractRemote

doSendJob

protected void doSendJob(Message aJob)
                  throws org.refcodes.component.traps.OpenException

For testing purposes, any job can be manually pushed into the job process to the receiver.

Parameters:

aJob - The job to be pushed to the receiver.

Throws:

org.refcodes.component.traps.OpenException - Thrown in case the operation failed due to an I/O malfunction such as the input- or output-connection (of an input- and output-connection pair) is not available or being disconnected.

digest

protected void digest(Message aJob)
               throws org.refcodes.component.traps.DigestException

The AbstractRemote.digest(Message) method is invoked in order to trigger processing of the provided Message, e.g. start execution depending on the Message instance being provided from the outside. A RemoteClient digests such a Message different than a RemoteServer. This method is inspired by the Digester.digest(Object) method.

Specified by:

digest in class AbstractRemote

Parameters:

aJob - The Message to be digested.

Throws:

org.refcodes.component.traps.DigestException - Thrown in case digesting (processing) a job by a Digester.digest(Object) caused problems; the cause is usually wrapped by this Exception.

See Also:

Digester

close

protected void close(CloseConnectionMessage aJob)

Takes care of closing the RemoteClient depending on the CloseConnectionMessage received from the RemoteServer counterpart. In case a RemoteClient manages a one-to-many connection to different RemoteServer instances, then the CloseConnectionMessage provides meta data on which RemoteServer connection to close. By default just close() is being invoked as if having a one-to-one connection.

Overrides:

close in class AbstractRemote

Parameters:

aJob - The CloseConnectionMessage providing additional information on which RemoteServer connection to close.

onPublishProxy

protected void onPublishProxy(Class<?> aType)
                       throws org.refcodes.exception.traps.VetoException

Hook when a proxy is about to be published.

Parameters:

aType - The type to be stored by the property.

Throws:

org.refcodes.exception.traps.VetoException - Thrown to signal that an operation is being vetoed by a third party observing the invocation of the given operation.

onProxyPublished

protected void onProxyPublished(Object aProxy)

Hook when a proxy has been published.

Parameters:

aProxy - The proxy to being published.

onProxySignedOff

protected void onProxySignedOff(Object aProxy)

Hook when a proxy has been signed-off.

Parameters:

aProxy - The proxy which has been signed-off.