org.marketcetera.modules.remote.emitter

Class RemoteDataEmitter

java.lang.Object

org.marketcetera.modules.remote.emitter.RemoteDataEmitter

public class RemoteDataEmitter
extends Object

A class that abstracts out receiving and publishing of data from the remote receiver so that it can be reused without having to go via the module framework.

Since:

2.0.0

Version:

$Id: RemoteDataEmitter.java 17401 2017-04-25 15:59:46Z colin $

Author:

anshul@marketcetera.com

Constructor Summary

Constructors

Constructor and Description
RemoteDataEmitter(String inURL, String inUsername, String inPassword, EmitterAdapter inAdapter) Creates an instance that connects to the specified remote source of data and publishes the received data and notifications to the supplied adapter instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection to the remote source of data.
Exception	getLastFailure() The last failure encountered when receiving data.
boolean	isConnected() Returns true if no failures have been encountered when receiving data from the remote source.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteDataEmitter

public RemoteDataEmitter(String inURL,
                         String inUsername,
                         String inPassword,
                         EmitterAdapter inAdapter)

Creates an instance that connects to the specified remote source of data and publishes the received data and notifications to the supplied adapter instance.

Parameters:

inURL - the URL of remote source of data. Cannot be null.

inUsername - the user name to authenticate to the remote source. Cannot be null.

inPassword - the password to authenticate to the remote source. Cannot be null.

inAdapter - the adapter instance. Cannot be null.

Throws:

RuntimeException - if there were errors connecting.

Method Detail

close

public void close()

Closes the connection to the remote source of data. This instance is unusable after this method is invoked.

If one needs to reconnect to the remote source, a new instance of this class should be created.

This method does not fail if the attempt to close the connection fails. In case of failures, the failures are logged and the method returns silently.

getLastFailure

public Exception getLastFailure()

The last failure encountered when receiving data.

Returns:

last failure encountered when receiving data.

isConnected

public boolean isConnected()

Returns true if no failures have been encountered when receiving data from the remote source.

Returns:

if no failures have been encountered when receiving data from the remote source.