org.refcodes.remoting.impls

Class RemoteServerImpl

java.lang.Object

org.refcodes.component.impls.AbstractConnectableAutomaton

org.refcodes.remoting.impls.AbstractRemote

org.refcodes.remoting.impls.RemoteServerImpl

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, RemoteServer

public class RemoteServerImpl
extends AbstractRemote
implements RemoteServer

Abstract implementation of the RemoteServer's base functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RemoteServerImpl.MethodReplyJobFactoryImpl Implementation of the TypedRecyclingFactory creating instances of the according type.
protected static class	RemoteServerImpl.PublishProxyJobFactoryImpl Implementation of the TypedRecyclingFactory creating instances of the according type.
protected static class	RemoteServerImpl.SignOffJobFactoryImpl 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.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
RemoteServerImpl()
RemoteServerImpl(ExecutorService aExecutorService)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	close()
protected void	close(CloseConnectionMessage aJob) Takes care of closing the RemoteServer depending on the CloseConnectionMessage received from the RemoteClient counterpart.
void	destroy()
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.
boolean	hasSubject(Object obj) Returns true if the provided subject is contained inside this RemoteServer.
boolean	isBusy() ------------------------------------------------------------------------- TODO: Enhance the isBusy() method, e.g. are there any threads active?
boolean	isEmpty()
protected void	onSubjectPublished(Object aSubject) Hook when a subject has been published.
protected void	onSubjectSignedOff(Object aSubject) Hook when a subject has been signed-off.
boolean	publishSubject(Object aSubject) Publishes an object to any RemoteClient connected to the RemoteServer.
boolean	signOffSubject(Object aSubject) Tries to sign off the (previously published) subject, this can be vetoed in case the subject is still in use by a RemoteClient.
boolean	signOffSubject(Object aSubject, int aTimeoutInMs) Signs off the (previously published) subject, this be vetoed even in case the subject is still in use by a RemoteClient, but the veto will only delay the sign off by the given timeout.
int	size()
Iterator<Object>	subjects() Returns an (immutable) iterator containing all the proxy objects previously being published.

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

RemoteServerImpl

public RemoteServerImpl()

RemoteServerImpl

public RemoteServerImpl(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

hasSubject

public boolean hasSubject(Object obj)

Returns true if the provided subject is contained inside this RemoteServer.

Specified by:

hasSubject in interface RemoteServer

Parameters:

obj - The subject to be tested if it is contained inside the RemoteServer.

Returns:

True if the given subject is contained inside the RemoteServer.

subjects

public Iterator<Object> subjects()

Returns an (immutable) iterator containing all the proxy objects previously being published. Use the RemoteServer.signOffSubject(Object) method in order to remove a published subject.

Specified by:

subjects in interface RemoteServer

Returns:

An iterator containing the published proxy objects.

isEmpty

public boolean isEmpty()

Specified by:

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

publishSubject

public boolean publishSubject(Object aSubject)
                       throws org.refcodes.component.traps.OpenException

Publishes an object to any RemoteClient connected to the RemoteServer.

Specified by:

publishSubject in interface RemoteServer

Parameters:

aSubject - A subject being published for inter-process communication such as remote procedure calls or remote method invocations.

Returns:

True is returned if the subject could be published, else false is returned

Throws:

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

signOffSubject

public boolean signOffSubject(Object aSubject)
                       throws org.refcodes.component.traps.OpenException,
                              org.refcodes.exception.traps.VetoException

Tries to sign off the (previously published) subject, this can be vetoed in case the subject is still in use by a RemoteClient.

Specified by:

signOffSubject in interface RemoteServer

Parameters:

aSubject - Description is currently not available!

Returns:

True if the removal of the subject has been successful. If the subject has not been found then false is returned. If a RemoteClient threw a VetoException then the sign-off is aborted.

Throws:

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

org.refcodes.exception.traps.VetoException

signOffSubject

public boolean signOffSubject(Object aSubject,
                              int aTimeoutInMs)
                       throws org.refcodes.component.traps.OpenException

Signs off the (previously published) subject, this be vetoed even in case the subject is still in use by a RemoteClient, but the veto will only delay the sign off by the given timeout.

Specified by:

signOffSubject in interface RemoteServer

Parameters:

aSubject - The subject to be signed off.

aTimeoutInMs - The timeout to be granted in case the sign-off has been vetoed, nevertheless the subject will be signed off after the timeout elapsed.

Returns:

True if the removal of the subject has been successful. If the subject has not been found then false is returned. If a RemoteClient threw a VetoException then the sign-off is aborted.

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

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

Description copied from class: AbstractRemote

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 RemoteServer depending on the CloseConnectionMessage received from the RemoteClient counterpart. In case a RemoteServer manages a one-to-many connection to different RemoteClient instances, then the CloseConnectionMessage provides meta data on which RemoteClient 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 RemoteClient connection to close.

onSubjectPublished

protected void onSubjectPublished(Object aSubject)

Hook when a subject has been published.

Parameters:

aSubject - The subject being published.

onSubjectSignedOff

protected void onSubjectSignedOff(Object aSubject)

Hook when a subject has been signed-off.

Parameters:

aSubject - The subject which has been signed-off.