org.marketcetera.saclient

Class AbstractSAClient

java.lang.Object

org.marketcetera.saclient.AbstractSAClient

All Implemented Interfaces:

EmitterAdapter, SAClient, org.springframework.context.Lifecycle

Direct Known Subclasses:

RpcSAClientImpl

public abstract class AbstractSAClient
extends Object
implements SAClient, EmitterAdapter, org.springframework.context.Lifecycle

Provides common behavior for SAClient implementations.

Since:

2.4.0

Version:

$Id: AbstractSAClient.java 17412 2017-05-02 19:56:45Z colin $

Author:

Colin DuPlantis

Field Summary

Fields

Modifier and Type	Field and Description
protected SAClientParameters	parameters SA connection parameters
protected AtomicBoolean	running indicates if the connection is active or not

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSAClient(SAClientParameters inParameters) Create a new AbstractSAClient instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnectionStatusListener(ConnectionStatusListener inListener) Adds a connection status listener so that it can receive connection status notifications.
void	addDataReceiver(DataReceiver inReceiver) Adds a data receiver so that it can receive all the data received from the remote source that this client is connected to.
void	close() Closes the connection to the remote strategy agent.
void	connectionStatusChanged(boolean inOldStatus, boolean inNewStatus)
protected void	doStart() Execute on start.
protected void	doStop() Execute on stop.
protected void	failIfClosed() Fails if the connection to the client has been closed.
protected void	failIfDisconnected() Fails if the connection to the client is closed or disconnected.
SAClientParameters	getParameters() The parameters that were specified when connecting to the remote strategy agent.
boolean	isRunning()
void	receiveData(Object inObject)
void	removeConnectionStatusListener(ConnectionStatusListener inListener) Removes a connection status listener that was added previously so that it no longer receives connection status notifications.
void	removeDataReciever(DataReceiver inReceiver) Removes a data receiver that was previously added so that it no longer receives data from the remote source.
void	start()
void	stop()
protected ConnectionException	wrapRemoteFailure(Exception inFailure) Creates a connection exception wrapping the supplied exception.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.marketcetera.saclient.SAClient

createStrategy, delete, getInstances, getModuleInfo, getProperties, getProviders, getStrategyCreateParms, sendData, setProperties, start, stop

Field Detail

parameters

protected final SAClientParameters parameters

SA connection parameters

running

protected final AtomicBoolean running

indicates if the connection is active or not

Constructor Detail

AbstractSAClient

protected AbstractSAClient(SAClientParameters inParameters)

Create a new AbstractSAClient instance.

Parameters:

inParameters - an SAClientParameters value

Throws:

ConnectionException - if a connection could not be made

Method Detail

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

start

public final void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public final void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

doStart

protected void doStart()

Execute on start.

doStop

protected void doStop()

Execute on stop.

close

public final void close()

Description copied from interface: SAClient

Closes the connection to the remote strategy agent. The behavior of the client after this method is invoked is undefined. If one needs to reconnect to the server, a new instance of the client should be created.

This operation does not throw any exceptions. If any failures are encountered when closing the connection, they are logged.

Specified by:

close in interface SAClient

addDataReceiver

public void addDataReceiver(DataReceiver inReceiver)

Description copied from interface: SAClient

Adds a data receiver so that it can receive all the data received from the remote source that this client is connected to.

If the same receiver is added more than once, it will receive data as many times as it's been added.

The receivers are notified in the reverse order of their addition.

Specified by:

addDataReceiver in interface SAClient

Parameters:

inReceiver - the receiver to add. Cannot be null.

removeDataReciever

public void removeDataReciever(DataReceiver inReceiver)

Description copied from interface: SAClient

Removes a data receiver that was previously added so that it no longer receives data from the remote source.

If the receiver was added more than once, only its most recently added occurrence will be removed.

Specified by:

removeDataReciever in interface SAClient

Parameters:

inReceiver - the receiver to remove. Cannot be null.

addConnectionStatusListener

public void addConnectionStatusListener(ConnectionStatusListener inListener)

Description copied from interface: SAClient

Adds a connection status listener so that it can receive connection status notifications.

If the same listener is added more than once, it will receive notifications as many times as it's been added.

The listeners are notified in the reverse order of their addition.

Specified by:

addConnectionStatusListener in interface SAClient

Parameters:

inListener - the listener to add. Cannot be null.

removeConnectionStatusListener

public void removeConnectionStatusListener(ConnectionStatusListener inListener)

Description copied from interface: SAClient

Removes a connection status listener that was added previously so that it no longer receives connection status notifications.

If the listener was added more than once, only its most recently added occurrence will be removed.

Specified by:

removeConnectionStatusListener in interface SAClient

Parameters:

inListener - the listener to remove. Cannot be null.

getParameters

public SAClientParameters getParameters()

Description copied from interface: SAClient

The parameters that were specified when connecting to the remote strategy agent.

Specified by:

getParameters in interface SAClient

Returns:

the connection parameters.

receiveData

public void receiveData(Object inObject)

Specified by:

receiveData in interface EmitterAdapter

connectionStatusChanged

public void connectionStatusChanged(boolean inOldStatus,
                           boolean inNewStatus)

Specified by:

connectionStatusChanged in interface EmitterAdapter

failIfDisconnected

protected void failIfDisconnected()
                           throws ConnectionException

Fails if the connection to the client is closed or disconnected.

Throws:

ConnectionException - if the connection to the client is closed or disconnected.

failIfClosed

protected void failIfClosed()
                     throws IllegalStateException

Fails if the connection to the client has been closed.

Throws:

IllegalStateException - if the connection to the client has been closed.

wrapRemoteFailure

protected ConnectionException wrapRemoteFailure(Exception inFailure)

Creates a connection exception wrapping the supplied exception.

If the supplied exception is a RemoteException, the exception wrapped by it is extracted and wrapped into the returned exception.

Parameters:

inFailure - the exception that needs to be wrapped.

Returns:

the connection exception wrapping the failure.