com.cleo.lexicom.external

Class LexiComOutgoingThread

java.lang.Object

com.cleo.lexicom.external.LexiComOutgoingThread

All Implemented Interfaces:

java.lang.Runnable

public abstract class LexiComOutgoingThread
extends java.lang.Object
implements java.lang.Runnable

Class intended to be used for waiting for and then streaming outgoing payload

Implementation can be configured to run directly within the VersaLex service/daemon by setting "Custom LexiComOutgoingThread Class" in Configure>Options>Other and copying an archive containing the implementation into VersaLex's lib/api/ folder. If configured this way, VersaLex will instantiate the implementation and invoke the start() method at service/daemon startup and will invoke the stop() method and wait for the thread to finish when the service/daemon shuts down.

Constructor Summary

Constructors

Constructor and Description
LexiComOutgoingThread() Constructor used by VersaLex itself when LexiComOutgoingThread implementation is configured directly in VersaLex Configure>Options>Other>Custom LexiComOutgoingThread Class.
LexiComOutgoingThread(ILexiCom lexicom) Constructor used by developer when LexiComOutgoingThread implementation is being used outside of VersaLex via LexiComFactory.getVersaLex() ILexiCom object.

Method Summary

Modifier and Type	Method and Description
IActionController	getActionController(java.lang.String[] path) Get an action controller
IListenerController	getListenerController() Get the listener controller
IMailboxController	getMailboxController(java.lang.String[] path) Get a mailbox controller
ILexiCom	getVersaLex() Gets a VersaLex product API object
boolean	isAlive() Tests if thread is alive
protected boolean	isStopped() Tests whether stop has been requested on the running thread
abstract void	run() Method is wide-open, but the expectation is to continuously wait/watch for new outgoing payload in an VersaLex-independent repository (e.g. database, message queue, directory, etc.) and when new payload is found that needs to be routed outbound, acquire an IMailboxController for the appropriate trading partner and stream out the payload
void	setVersaLex(ILexiCom lexicom) Sets a VersaLex product API object
void	start() Creates a new Thread, which calls the run() method
void	stop() Sets a stop flag and calls interrupt() on the running thread

Methods inherited from class java.lang.Object

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

Constructor Detail

LexiComOutgoingThread

public LexiComOutgoingThread()

Constructor used by VersaLex itself when LexiComOutgoingThread implementation is configured directly in VersaLex Configure>Options>Other>Custom LexiComOutgoingThread Class. Note: setVersaLex(ILexiCom lexicom) should be called after this constructor

LexiComOutgoingThread

public LexiComOutgoingThread(ILexiCom lexicom)

Constructor used by developer when LexiComOutgoingThread implementation is being used outside of VersaLex via LexiComFactory.getVersaLex() ILexiCom object.

Parameters:

lexicom - LexiCom instance - can be obtained using LexiComFactory.getCurrentInstance()

Method Detail

start

public void start()

Creates a new Thread, which calls the run() method

stop

public void stop()

Sets a stop flag and calls interrupt() on the running thread

isStopped

protected boolean isStopped()

Tests whether stop has been requested on the running thread

Returns:

true if stop flag has been set

isAlive

public boolean isAlive()

Tests if thread is alive

Returns:

true if thread is alive

run

public abstract void run()

Method is wide-open, but the expectation is to continuously wait/watch for new outgoing payload in an VersaLex-independent repository (e.g. database, message queue, directory, etc.) and when new payload is found that needs to be routed outbound, acquire an IMailboxController for the appropriate trading partner and stream out the payload

Specified by:

run in interface java.lang.Runnable

getVersaLex

public ILexiCom getVersaLex()
                     throws java.lang.Exception

Gets a VersaLex product API object

Returns:

ILexiCom

Throws:

java.lang.Exception - if the VersaLex installation is invalid or if request conflicted with other VersaLex objects

setVersaLex

public void setVersaLex(ILexiCom lexicom)
                 throws java.lang.Exception

Sets a VersaLex product API object

Parameters:

lexicom - LexiCom instance - can be obtained using LexiComFactory.getCurrentInstance()

Throws:

java.lang.Exception - if the VersaLex installation is invalid or if request conflicted with other VersaLex objects

getMailboxController

public IMailboxController getMailboxController(java.lang.String[] path)
                                        throws java.lang.Exception

Get a mailbox controller

Parameters:

path - the alias path to the mailbox

Returns:

the mailbox controller

Throws:

java.lang.Exception - if VersaLex object no longer open or if running in CLIENT mode and remote method invocation error

getActionController

public IActionController getActionController(java.lang.String[] path)
                                      throws java.lang.Exception

Get an action controller

Parameters:

path - the alias path to the action

Returns:

the action controller

Throws:

java.lang.Exception - if VersaLex object no longer open or if running in CLIENT mode and remote method invocation error

getListenerController

public IListenerController getListenerController()
                                          throws java.lang.Exception

Get the listener controller

Returns:

the listener controller

Throws:

java.lang.Exception - if VersaLex object no longer open or if running in CLIENT mode and remote method invocation error