isc.sensor.outputadaptor.oaextensions
Class OALocalAsyncSource

java.lang.Object
  org.openadaptor.adaptor.SimpleComponent
      org.openadaptor.adaptor.AbstractReader
          org.openadaptor.adaptor.AbstractSimpleSource
              org.openadaptor.adaptor.AbstractSimpleSourceSink
                  org.openadaptor.adaptor.LocalAsyncSource
                      isc.sensor.outputadaptor.oaextensions.OALocalAsyncSource

All Implemented Interfaces:

java.lang.Runnable, org.openadaptor.adaptor.CallbackProvider, org.openadaptor.adaptor.Component, org.openadaptor.adaptor.Configurable, org.openadaptor.adaptor.IbafTransactionalResource, org.openadaptor.adaptor.Sink, org.openadaptor.adaptor.Source, org.openadaptor.doconverter.DOMessageReaderDelegate

public class OALocalAsyncSource
extends org.openadaptor.adaptor.LocalAsyncSource

This is an overridden version of OpenAdaptor V 1.7.x LocalAsyncSource, which adds functions to wait for the Async Queue Calls to complete.

Functions added:

• getAsyncQueueSize - Returns the current queue size to be process by OA
• waitAsyncQueueComplete - Function returns when the async queue has been drained.

Author:

John Casey
Project: DNA_sensor - Aug 12, 2005

See Also:

LocalAsyncSource

Nested Class Summary

Nested classes/interfaces inherited from class org.openadaptor.adaptor.AbstractSimpleSource

org.openadaptor.adaptor.AbstractSimpleSource.SourceListenThread

Nested classes/interfaces inherited from class org.openadaptor.adaptor.SimpleComponent

org.openadaptor.adaptor.SimpleComponent.StateHolder

Field Summary

protected static org.apache.log4j.Logger

log log4j

Fields inherited from class org.openadaptor.adaptor.LocalAsyncSource

_data

Fields inherited from class org.openadaptor.adaptor.AbstractSimpleSourceSink

responses

Fields inherited from class org.openadaptor.adaptor.AbstractSimpleSource

_last_processed_time, _max_calls_per_poll, _num_polls, _num_processed, _source_type, CALLBACK_SOURCE, LISTEN_SOURCE, POLL_SOURCE

Fields inherited from class org.openadaptor.adaptor.AbstractReader

_batch_size, _comment_regexps, _end_data, _file_name, _file_name_att, _header_lines, _re_compiler, _re_matcher, _reader, _rec_num, _rec_num_att, _record_regexps, _start_data, _stream_reader, _string_reader, _useAlternateDOXMLReader

Fields inherited from class org.openadaptor.adaptor.SimpleComponent

_controller, _formatter, _name, _propsPrefix, _readerDelegate, _textEncoding, MESSAGE_WRITER_PREFIX, MESSAGEID_ATTR, TEXT_ENCODING_ATTR

Constructor Summary

OALocalAsyncSource()
Constructor: noop - initialize LocalAsyncSource

Method Summary

int	getAsyncQueueSize() Get the current size of the Queue, representing how many outstanding dataobject are left to be sent.
void	waitAsyncQueueComplete() Convenience wait routine.

Methods inherited from class org.openadaptor.adaptor.LocalAsyncSource

init, process, process, sourcePoll, txnCommit

Methods inherited from class org.openadaptor.adaptor.AbstractSimpleSourceSink

processHospitalException, processMessage, sourceProcess

Methods inherited from class org.openadaptor.adaptor.AbstractSimpleSource

getPollPeriod, getSourceType, getStatus, processMessage, processMessage, processMessageWithTxn, run, runCallback, runListen, runPoll, setMaxCallsPerPoll, setPollPeriod, setSourceType, sourceCleanUp, sourceHasTransactionRecovery, sourceListen, sourcePause, sourceProcess, sourceProcess, sourceResume, sourceStartUp, sourceStop, sourceTransactionBegin, sourceTransactionProcess

Methods inherited from class org.openadaptor.adaptor.AbstractReader

getDOStreamReader, getDOStringReader, getLineNumberReader, getReader, getXMLString, isReaderEOF, isWhitespace, nextDataObjectArray, readDOStreamReader, readDOStringReader, readDOXML, readDOXMLAlternate, readerCleanUp, readerEOF, readerException, readerStartUp, setDOStringReader, setHeaderLines, setReader

Methods inherited from class org.openadaptor.adaptor.SimpleComponent

addCallback, canUpdateWhileRunning, cleanUp, customControl, didReceiveMessage, getAsProperties, getCallbackManager, getCurrentState, getCustomControlProperties, getLastUID, getName, getProperty, getProperty, getPropsPrefix, getRequestedState, getSecurityManager, getTextEncoding, getXMLFormatter, notifyEvent, pause, removeCallback, resume, setCallbackManager, setCallbackManager, setCurrentState, setFromProperties, setFromProperties, setFromResource, setName, setPropsPrefix, setRequestedState, terminate, txnBegin, txnCommitWithExceptions, txnRollback, txnRollback, waitForRequestedStateChange

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openadaptor.adaptor.Component

cleanUp, customControl, getName, getPropsPrefix, getRequestedState, getStatus, pause, resume, setName, setPropsPrefix, terminate

Methods inherited from interface org.openadaptor.adaptor.IbafTransactionalResource

txnBegin, txnCommitWithExceptions, txnRollback, txnRollback

Methods inherited from interface org.openadaptor.adaptor.Configurable

canUpdateWhileRunning, getAsProperties, setFromProperties, setFromProperties

Methods inherited from interface org.openadaptor.adaptor.CallbackProvider

addCallback, getCallbackManager, notifyEvent, removeCallback, setCallbackManager, setCallbackManager

Field Detail

log

protected static org.apache.log4j.Logger log

log4j

Constructor Detail

OALocalAsyncSource

public OALocalAsyncSource()

Constructor: noop - initialize LocalAsyncSource

Method Detail

getAsyncQueueSize

public int getAsyncQueueSize()

Get the current size of the Queue, representing how many outstanding dataobject are left to be sent.

Returns:

The size of the queue.

waitAsyncQueueComplete

public void waitAsyncQueueComplete()

Convenience wait routine. This will return only when there are no more data objects to be sent (Queue is drained). This is useful when exiting the process and needing to wait for all messages to be sent.