Package org.apache.uima.aae.controller
Class AnalysisEngineControllerAdapter
java.lang.Object
org.apache.uima.aae.controller.AnalysisEngineControllerAdapter
- All Implemented Interfaces:
AnalysisEngineController
,ControllerLifecycle
- Direct Known Subclasses:
UimacppServiceController
public abstract class AnalysisEngineControllerAdapter
extends Object
implements AnalysisEngineController
Abstract class meant to provide default implementations for AnalysisEngineController instances.
-
Field Summary
Fields inherited from interface org.apache.uima.aae.controller.AnalysisEngineController
AEInstanceCount, CasPoolSize
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAbortedCasReferenceId
(String casReferenceId) void
Register one or more listeners through which the controller can send notification of events.void
addEndpointToDoNotProcessList
(String anEndpointName) void
addInputChannel
(InputChannel anInputChannel) void
addServiceInfo
(ServiceInfo serviceInfo) void
addTimeSnapshot
(long snapshot, String key) void
beginProcess
(int msgType) void
cacheClientEndpoint
(Endpoint anEndpoint) void
void
collectionProcessComplete
(Endpoint anEndpoint) void
void
dropCAS
(org.apache.uima.cas.CAS acas) void
void
endProcess
(int msgType) void
void
long
getCasStatistics
(String casReferenceId) org.apache.uima.UimaContext
getChildUimaContext
(String delegateEndpointName) long
long
long
getIdleTimeBetweenProcessCalls
(int msgType) int
getIndex()
getInputChannel
(String queueName) getName()
getReplyInputChannel
(String delegateKey) long
getState()
getStats()
long
long
getTimeSnapshot
(String key) getTransport
(String key) getTransport
(UimaAsContext context, String key) getUimaMessageListener
(String delegateKey) void
handleDelegateLifeCycleEvent
(String anEndpoint, int delegateCount) void
incrementDeserializationTime
(long cpuTime) void
incrementSerializationTime
(long cpuTime) void
void
initializeVMTransport
(int parentControllerReplyConsumerCount) boolean
boolean
boolean
isEndpointOnDontProcessList
(String anEndpointName) boolean
boolean
Returns true if the AnalysisEngineController has been (or is in the process of) shutdown.boolean
void
void
void
void
process
(org.apache.uima.cas.CAS acas, String anInputCasReferenceId, String newCasReferenceId, String newCASProducedBy) void
abstract void
void
registerVmQueueWithJMX
(Object o, String name) void
releaseNextCas
(String casReferenceId) void
Removes named application listener.void
saveReplyTime
(long snapshot, String key) void
void
sendMetadata
(Endpoint anEndpoint) void
setCasManager
(AsynchAECasManager casManager) void
setDeployDescriptor
(String deployDescriptor) void
setInputChannel
(InputChannel anInputChannel) void
setOutputChannel
(OutputChannel anOutputChannel) void
Called to set the state of the AnalysisEngineController to STOPPED.void
setUimaEEAdminContext
(UimaEEAdminContext anAdminContext) void
stop()
void
takeAction
(String anAction, String anEndpointName, ErrorContext anErrorContext) void
Called to initiate shutdown of the Asynchronous Service.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.uima.aae.controller.AnalysisEngineController
dumpState, getKey
-
Constructor Details
-
AnalysisEngineControllerAdapter
public AnalysisEngineControllerAdapter()
-
-
Method Details
-
addAbortedCasReferenceId
- Specified by:
addAbortedCasReferenceId
in interfaceAnalysisEngineController
-
addInputChannel
- Specified by:
addInputChannel
in interfaceAnalysisEngineController
- Throws:
Exception
-
addServiceInfo
- Specified by:
addServiceInfo
in interfaceAnalysisEngineController
-
addTimeSnapshot
-
beginProcess
public void beginProcess(int msgType) - Specified by:
beginProcess
in interfaceAnalysisEngineController
-
cacheClientEndpoint
- Specified by:
cacheClientEndpoint
in interfaceAnalysisEngineController
-
collectionProcessComplete
- Specified by:
collectionProcessComplete
in interfaceAnalysisEngineController
- Throws:
AsynchAEException
-
dropCAS
- Specified by:
dropCAS
in interfaceAnalysisEngineController
-
dropCAS
public void dropCAS(org.apache.uima.cas.CAS acas) - Specified by:
dropCAS
in interfaceAnalysisEngineController
-
dropStats
- Specified by:
dropStats
in interfaceAnalysisEngineController
-
endProcess
public void endProcess(int msgType) - Specified by:
endProcess
in interfaceAnalysisEngineController
-
forceTimeoutOnPendingCases
- Specified by:
forceTimeoutOnPendingCases
in interfaceAnalysisEngineController
-
getAnalysisTime
public long getAnalysisTime()- Specified by:
getAnalysisTime
in interfaceAnalysisEngineController
-
getCasManagerWrapper
- Specified by:
getCasManagerWrapper
in interfaceAnalysisEngineController
-
getCasStatistics
- Specified by:
getCasStatistics
in interfaceAnalysisEngineController
-
getChildUimaContext
public org.apache.uima.UimaContext getChildUimaContext(String delegateEndpointName) throws Exception - Specified by:
getChildUimaContext
in interfaceAnalysisEngineController
- Throws:
Exception
-
getClientEndpoint
- Specified by:
getClientEndpoint
in interfaceAnalysisEngineController
-
getComponentName
- Specified by:
getComponentName
in interfaceAnalysisEngineController
-
getDeadClientMap
- Specified by:
getDeadClientMap
in interfaceAnalysisEngineController
-
getControllerLatch
- Specified by:
getControllerLatch
in interfaceAnalysisEngineController
-
getCpuTime
public long getCpuTime()- Specified by:
getCpuTime
in interfaceAnalysisEngineController
-
getErrorHandlerChain
- Specified by:
getErrorHandlerChain
in interfaceAnalysisEngineController
-
getEventListener
- Specified by:
getEventListener
in interfaceAnalysisEngineController
-
getIdleTime
public long getIdleTime()- Specified by:
getIdleTime
in interfaceAnalysisEngineController
-
getIdleTimeBetweenProcessCalls
public long getIdleTimeBetweenProcessCalls(int msgType) - Specified by:
getIdleTimeBetweenProcessCalls
in interfaceAnalysisEngineController
-
getInProcessCache
- Specified by:
getInProcessCache
in interfaceAnalysisEngineController
-
getIndex
public int getIndex()- Specified by:
getIndex
in interfaceAnalysisEngineController
-
getInputChannel
- Specified by:
getInputChannel
in interfaceAnalysisEngineController
-
getInputChannel
- Specified by:
getInputChannel
in interfaceAnalysisEngineController
-
getJMXDomain
- Specified by:
getJMXDomain
in interfaceAnalysisEngineController
-
getJmxContext
- Specified by:
getJmxContext
in interfaceAnalysisEngineController
-
getLocalCache
- Specified by:
getLocalCache
in interfaceAnalysisEngineController
-
getManagementInterface
- Specified by:
getManagementInterface
in interfaceAnalysisEngineController
-
getMonitor
- Specified by:
getMonitor
in interfaceAnalysisEngineController
-
getName
- Specified by:
getName
in interfaceAnalysisEngineController
-
getOutputChannel
- Specified by:
getOutputChannel
in interfaceAnalysisEngineController
-
getParentController
- Specified by:
getParentController
in interfaceAnalysisEngineController
-
getReplyInputChannel
- Specified by:
getReplyInputChannel
in interfaceAnalysisEngineController
-
getReplyTime
public long getReplyTime()- Specified by:
getReplyTime
in interfaceAnalysisEngineController
-
getServiceEndpointName
- Specified by:
getServiceEndpointName
in interfaceAnalysisEngineController
-
getServiceErrors
- Specified by:
getServiceErrors
in interfaceAnalysisEngineController
-
getServiceInfo
- Specified by:
getServiceInfo
in interfaceAnalysisEngineController
-
getServicePerformance
- Specified by:
getServicePerformance
in interfaceAnalysisEngineController
-
getStats
- Specified by:
getStats
in interfaceAnalysisEngineController
-
getTime
- Specified by:
getTime
in interfaceAnalysisEngineController
-
getTimeSnapshot
-
getTransport
- Specified by:
getTransport
in interfaceAnalysisEngineController
- Throws:
Exception
-
getTransport
- Specified by:
getTransport
in interfaceAnalysisEngineController
- Throws:
Exception
-
getUimaEEAdminContext
- Specified by:
getUimaEEAdminContext
in interfaceAnalysisEngineController
-
getUimaMessageListener
- Specified by:
getUimaMessageListener
in interfaceAnalysisEngineController
-
handleDelegateLifeCycleEvent
- Specified by:
handleDelegateLifeCycleEvent
in interfaceAnalysisEngineController
-
incrementDeserializationTime
public void incrementDeserializationTime(long cpuTime) - Specified by:
incrementDeserializationTime
in interfaceAnalysisEngineController
-
incrementSerializationTime
public void incrementSerializationTime(long cpuTime) - Specified by:
incrementSerializationTime
in interfaceAnalysisEngineController
-
initialize
- Specified by:
initialize
in interfaceAnalysisEngineController
- Throws:
AsynchAEException
-
initializeVMTransport
- Specified by:
initializeVMTransport
in interfaceAnalysisEngineController
- Throws:
Exception
-
isAwaitingCacheCallbackNotification
public boolean isAwaitingCacheCallbackNotification()- Specified by:
isAwaitingCacheCallbackNotification
in interfaceAnalysisEngineController
-
isCasMultiplier
public boolean isCasMultiplier()- Specified by:
isCasMultiplier
in interfaceAnalysisEngineController
-
isPrimitive
public boolean isPrimitive()- Specified by:
isPrimitive
in interfaceAnalysisEngineController
-
isStopped
public boolean isStopped()Description copied from interface:AnalysisEngineController
Returns true if the AnalysisEngineController has been (or is in the process of) shutdown.- Specified by:
isStopped
in interfaceAnalysisEngineController
- Returns:
- - true if stopped
-
isTopLevelComponent
public boolean isTopLevelComponent()- Specified by:
isTopLevelComponent
in interfaceAnalysisEngineController
-
notifyListenersWithInitializationStatus
- Specified by:
notifyListenersWithInitializationStatus
in interfaceAnalysisEngineController
-
onInitialize
public void onInitialize()- Specified by:
onInitialize
in interfaceAnalysisEngineController
-
process
- Specified by:
process
in interfaceAnalysisEngineController
-
process
public void process(org.apache.uima.cas.CAS acas, String anInputCasReferenceId, String newCasReferenceId, String newCASProducedBy) - Specified by:
process
in interfaceAnalysisEngineController
-
process
- Specified by:
process
in interfaceAnalysisEngineController
-
quiesceAndStop
public abstract void quiesceAndStop()- Specified by:
quiesceAndStop
in interfaceAnalysisEngineController
-
registerVmQueueWithJMX
- Specified by:
registerVmQueueWithJMX
in interfaceAnalysisEngineController
- Throws:
Exception
-
releaseNextCas
- Specified by:
releaseNextCas
in interfaceAnalysisEngineController
-
saveReplyTime
- Specified by:
saveReplyTime
in interfaceAnalysisEngineController
-
saveTime
- Specified by:
saveTime
in interfaceAnalysisEngineController
-
sendMetadata
- Specified by:
sendMetadata
in interfaceAnalysisEngineController
- Throws:
AsynchAEException
-
setCasManager
- Specified by:
setCasManager
in interfaceAnalysisEngineController
-
setDeployDescriptor
- Specified by:
setDeployDescriptor
in interfaceAnalysisEngineController
-
setInputChannel
- Specified by:
setInputChannel
in interfaceAnalysisEngineController
- Throws:
Exception
-
setOutputChannel
- Specified by:
setOutputChannel
in interfaceAnalysisEngineController
- Throws:
Exception
-
setStopped
public void setStopped()Description copied from interface:AnalysisEngineController
Called to set the state of the AnalysisEngineController to STOPPED. This method does not stop input or output channels.- Specified by:
setStopped
in interfaceAnalysisEngineController
-
setUimaEEAdminContext
- Specified by:
setUimaEEAdminContext
in interfaceAnalysisEngineController
-
stop
public void stop()- Specified by:
stop
in interfaceAnalysisEngineController
-
takeAction
- Specified by:
takeAction
in interfaceAnalysisEngineController
-
addControllerCallbackListener
Description copied from interface:ControllerLifecycle
Register one or more listeners through which the controller can send notification of events.- Specified by:
addControllerCallbackListener
in interfaceControllerLifecycle
- Parameters:
listener
- - application listener object to register
-
removeControllerCallbackListener
Description copied from interface:ControllerLifecycle
Removes named application listener.- Specified by:
removeControllerCallbackListener
in interfaceControllerLifecycle
- Parameters:
listener
- - application listener to remove
-
terminate
public void terminate()Description copied from interface:ControllerLifecycle
Called to initiate shutdown of the Asynchronous Service. An implementation can close an input and output channels and do any necessary cleanup before terminating.- Specified by:
terminate
in interfaceControllerLifecycle
-
addEndpointToDoNotProcessList
-
isEndpointOnDontProcessList
-
evictExpiredEntries
public void evictExpiredEntries() -
changeState
- Specified by:
changeState
in interfaceAnalysisEngineController
-
getState
- Specified by:
getState
in interfaceAnalysisEngineController
-