|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.aae.controller.AnalysisEngineControllerAdapter
public abstract class AnalysisEngineControllerAdapter
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 | |
---|---|
AnalysisEngineControllerAdapter()
|
Method Summary | |
---|---|
void |
addAbortedCasReferenceId(java.lang.String casReferenceId)
|
void |
addControllerCallbackListener(ControllerCallbackListener listener)
Register one or more listeners through which the controller can send notification of events. |
void |
addEndpointToDoNotProcessList(java.lang.String anEndpointName)
|
void |
addInputChannel(InputChannel anInputChannel)
|
void |
addServiceInfo(ServiceInfo serviceInfo)
|
void |
addTimeSnapshot(long snapshot,
java.lang.String key)
|
void |
beginProcess(int msgType)
|
void |
cacheClientEndpoint(Endpoint anEndpoint)
|
void |
changeState(BaseAnalysisEngineController.ServiceState state)
|
void |
collectionProcessComplete(Endpoint anEndpoint)
|
void |
dropCAS(org.apache.uima.cas.CAS acas)
|
void |
dropCAS(java.lang.String casReferenceId,
boolean dropCacheEntry)
|
void |
dropStats(java.lang.String casReferenceId,
java.lang.String anEndpointName)
|
void |
endProcess(int msgType)
|
void |
evictExpiredEntries()
|
void |
forceTimeoutOnPendingCases(java.lang.String key)
|
long |
getAnalysisTime()
|
AsynchAECasManager |
getCasManagerWrapper()
|
ServicePerformance |
getCasStatistics(java.lang.String casReferenceId)
|
org.apache.uima.UimaContext |
getChildUimaContext(java.lang.String delegateEndpointName)
|
Endpoint |
getClientEndpoint()
|
java.lang.String |
getComponentName()
|
ControllerLatch |
getControllerLatch()
|
long |
getCpuTime()
|
java.util.Map<java.lang.String,java.lang.String> |
getDeadClientMap()
|
ErrorHandlerChain |
getErrorHandlerChain()
|
EventSubscriber |
getEventListener()
|
long |
getIdleTime()
|
long |
getIdleTimeBetweenProcessCalls(int msgType)
|
int |
getIndex()
|
InProcessCache |
getInProcessCache()
|
InputChannel |
getInputChannel()
|
InputChannel |
getInputChannel(java.lang.String queueName)
|
java.lang.String |
getJmxContext()
|
java.lang.String |
getJMXDomain()
|
LocalCache |
getLocalCache()
|
JmxManagement |
getManagementInterface()
|
Monitor |
getMonitor()
|
java.lang.String |
getName()
|
OutputChannel |
getOutputChannel()
|
AnalysisEngineController |
getParentController()
|
InputChannel |
getReplyInputChannel(java.lang.String delegateKey)
|
long |
getReplyTime()
|
java.lang.String |
getServiceEndpointName()
|
ServiceErrors |
getServiceErrors()
|
ServiceInfo |
getServiceInfo()
|
ServicePerformance |
getServicePerformance()
|
BaseAnalysisEngineController.ServiceState |
getState()
|
java.util.Map |
getStats()
|
long |
getTime(java.lang.String casReferenceId,
java.lang.String anEndpointName)
|
long |
getTimeSnapshot(java.lang.String key)
|
UimaTransport |
getTransport(java.lang.String key)
|
UimaTransport |
getTransport(UimaAsContext context,
java.lang.String key)
|
UimaEEAdminContext |
getUimaEEAdminContext()
|
UimaMessageListener |
getUimaMessageListener(java.lang.String delegateKey)
|
void |
handleDelegateLifeCycleEvent(java.lang.String anEndpoint,
int delegateCount)
|
void |
incrementDeserializationTime(long cpuTime)
|
void |
incrementSerializationTime(long cpuTime)
|
void |
initialize()
|
void |
initializeVMTransport(int parentControllerReplyConsumerCount)
|
boolean |
isAwaitingCacheCallbackNotification()
|
boolean |
isCasMultiplier()
|
boolean |
isEndpointOnDontProcessList(java.lang.String anEndpointName)
|
boolean |
isPrimitive()
|
boolean |
isStopped()
Returns true if the AnalysisEngineController has been (or is in the process of) shutdown. |
boolean |
isTopLevelComponent()
|
void |
notifyListenersWithInitializationStatus(java.lang.Exception e)
|
void |
onInitialize()
|
void |
process(org.apache.uima.cas.CAS cas,
java.lang.String casId)
|
void |
process(org.apache.uima.cas.CAS acas,
java.lang.String casReferenceId,
Endpoint anEndpoint)
|
void |
process(org.apache.uima.cas.CAS acas,
java.lang.String anInputCasReferenceId,
java.lang.String newCasReferenceId,
java.lang.String newCASProducedBy)
|
abstract void |
quiesceAndStop()
|
void |
registerVmQueueWithJMX(java.lang.Object o,
java.lang.String name)
|
void |
releaseNextCas(java.lang.String casReferenceId)
|
void |
removeControllerCallbackListener(ControllerCallbackListener listener)
Removes named application listener. |
void |
saveReplyTime(long snapshot,
java.lang.String key)
|
void |
saveTime(long anArrivalTime,
java.lang.String casReferenceId,
java.lang.String anEndpointName)
|
void |
sendMetadata(Endpoint anEndpoint)
|
void |
setCasManager(AsynchAECasManager casManager)
|
void |
setDeployDescriptor(java.lang.String deployDescriptor)
|
void |
setInputChannel(InputChannel anInputChannel)
|
void |
setOutputChannel(OutputChannel anOutputChannel)
|
void |
setStopped()
Called to set the state of the AnalysisEngineController to STOPPED. |
void |
setUimaEEAdminContext(UimaEEAdminContext anAdminContext)
|
void |
stop()
|
void |
takeAction(java.lang.String anAction,
java.lang.String anEndpointName,
ErrorContext anErrorContext)
|
void |
terminate()
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 Detail |
---|
public AnalysisEngineControllerAdapter()
Method Detail |
---|
public void addAbortedCasReferenceId(java.lang.String casReferenceId)
addAbortedCasReferenceId
in interface AnalysisEngineController
public void addInputChannel(InputChannel anInputChannel) throws java.lang.Exception
addInputChannel
in interface AnalysisEngineController
java.lang.Exception
public void addServiceInfo(ServiceInfo serviceInfo)
addServiceInfo
in interface AnalysisEngineController
public void addTimeSnapshot(long snapshot, java.lang.String key)
public void beginProcess(int msgType)
beginProcess
in interface AnalysisEngineController
public void cacheClientEndpoint(Endpoint anEndpoint)
cacheClientEndpoint
in interface AnalysisEngineController
public void collectionProcessComplete(Endpoint anEndpoint) throws AsynchAEException
collectionProcessComplete
in interface AnalysisEngineController
AsynchAEException
public void dropCAS(java.lang.String casReferenceId, boolean dropCacheEntry)
dropCAS
in interface AnalysisEngineController
public void dropCAS(org.apache.uima.cas.CAS acas)
dropCAS
in interface AnalysisEngineController
public void dropStats(java.lang.String casReferenceId, java.lang.String anEndpointName)
dropStats
in interface AnalysisEngineController
public void endProcess(int msgType)
endProcess
in interface AnalysisEngineController
public void forceTimeoutOnPendingCases(java.lang.String key)
forceTimeoutOnPendingCases
in interface AnalysisEngineController
public long getAnalysisTime()
getAnalysisTime
in interface AnalysisEngineController
public AsynchAECasManager getCasManagerWrapper()
getCasManagerWrapper
in interface AnalysisEngineController
public ServicePerformance getCasStatistics(java.lang.String casReferenceId)
getCasStatistics
in interface AnalysisEngineController
public org.apache.uima.UimaContext getChildUimaContext(java.lang.String delegateEndpointName) throws java.lang.Exception
getChildUimaContext
in interface AnalysisEngineController
java.lang.Exception
public Endpoint getClientEndpoint()
getClientEndpoint
in interface AnalysisEngineController
public java.lang.String getComponentName()
getComponentName
in interface AnalysisEngineController
public java.util.Map<java.lang.String,java.lang.String> getDeadClientMap()
getDeadClientMap
in interface AnalysisEngineController
public ControllerLatch getControllerLatch()
getControllerLatch
in interface AnalysisEngineController
public long getCpuTime()
getCpuTime
in interface AnalysisEngineController
public ErrorHandlerChain getErrorHandlerChain()
getErrorHandlerChain
in interface AnalysisEngineController
public EventSubscriber getEventListener()
getEventListener
in interface AnalysisEngineController
public long getIdleTime()
getIdleTime
in interface AnalysisEngineController
public long getIdleTimeBetweenProcessCalls(int msgType)
getIdleTimeBetweenProcessCalls
in interface AnalysisEngineController
public InProcessCache getInProcessCache()
getInProcessCache
in interface AnalysisEngineController
public int getIndex()
getIndex
in interface AnalysisEngineController
public InputChannel getInputChannel()
getInputChannel
in interface AnalysisEngineController
public InputChannel getInputChannel(java.lang.String queueName)
getInputChannel
in interface AnalysisEngineController
public java.lang.String getJMXDomain()
getJMXDomain
in interface AnalysisEngineController
public java.lang.String getJmxContext()
getJmxContext
in interface AnalysisEngineController
public LocalCache getLocalCache()
getLocalCache
in interface AnalysisEngineController
public JmxManagement getManagementInterface()
getManagementInterface
in interface AnalysisEngineController
public Monitor getMonitor()
getMonitor
in interface AnalysisEngineController
public java.lang.String getName()
getName
in interface AnalysisEngineController
public OutputChannel getOutputChannel()
getOutputChannel
in interface AnalysisEngineController
public AnalysisEngineController getParentController()
getParentController
in interface AnalysisEngineController
public InputChannel getReplyInputChannel(java.lang.String delegateKey)
getReplyInputChannel
in interface AnalysisEngineController
public long getReplyTime()
getReplyTime
in interface AnalysisEngineController
public java.lang.String getServiceEndpointName()
getServiceEndpointName
in interface AnalysisEngineController
public ServiceErrors getServiceErrors()
getServiceErrors
in interface AnalysisEngineController
public ServiceInfo getServiceInfo()
getServiceInfo
in interface AnalysisEngineController
public ServicePerformance getServicePerformance()
getServicePerformance
in interface AnalysisEngineController
public java.util.Map getStats()
getStats
in interface AnalysisEngineController
public long getTime(java.lang.String casReferenceId, java.lang.String anEndpointName)
getTime
in interface AnalysisEngineController
public long getTimeSnapshot(java.lang.String key)
public UimaTransport getTransport(UimaAsContext context, java.lang.String key) throws java.lang.Exception
getTransport
in interface AnalysisEngineController
java.lang.Exception
public UimaTransport getTransport(java.lang.String key) throws java.lang.Exception
getTransport
in interface AnalysisEngineController
java.lang.Exception
public UimaEEAdminContext getUimaEEAdminContext()
getUimaEEAdminContext
in interface AnalysisEngineController
public UimaMessageListener getUimaMessageListener(java.lang.String delegateKey)
getUimaMessageListener
in interface AnalysisEngineController
public void handleDelegateLifeCycleEvent(java.lang.String anEndpoint, int delegateCount)
handleDelegateLifeCycleEvent
in interface AnalysisEngineController
public void incrementDeserializationTime(long cpuTime)
incrementDeserializationTime
in interface AnalysisEngineController
public void incrementSerializationTime(long cpuTime)
incrementSerializationTime
in interface AnalysisEngineController
public void initialize() throws AsynchAEException
initialize
in interface AnalysisEngineController
AsynchAEException
public void initializeVMTransport(int parentControllerReplyConsumerCount) throws java.lang.Exception
initializeVMTransport
in interface AnalysisEngineController
java.lang.Exception
public boolean isAwaitingCacheCallbackNotification()
isAwaitingCacheCallbackNotification
in interface AnalysisEngineController
public boolean isCasMultiplier()
isCasMultiplier
in interface AnalysisEngineController
public boolean isPrimitive()
isPrimitive
in interface AnalysisEngineController
public boolean isStopped()
AnalysisEngineController
isStopped
in interface AnalysisEngineController
public boolean isTopLevelComponent()
isTopLevelComponent
in interface AnalysisEngineController
public void notifyListenersWithInitializationStatus(java.lang.Exception e)
notifyListenersWithInitializationStatus
in interface AnalysisEngineController
public void onInitialize()
onInitialize
in interface AnalysisEngineController
public void process(org.apache.uima.cas.CAS cas, java.lang.String casId)
process
in interface AnalysisEngineController
public void process(org.apache.uima.cas.CAS acas, java.lang.String anInputCasReferenceId, java.lang.String newCasReferenceId, java.lang.String newCASProducedBy)
process
in interface AnalysisEngineController
public void process(org.apache.uima.cas.CAS acas, java.lang.String casReferenceId, Endpoint anEndpoint)
process
in interface AnalysisEngineController
public abstract void quiesceAndStop()
quiesceAndStop
in interface AnalysisEngineController
public void registerVmQueueWithJMX(java.lang.Object o, java.lang.String name) throws java.lang.Exception
registerVmQueueWithJMX
in interface AnalysisEngineController
java.lang.Exception
public void releaseNextCas(java.lang.String casReferenceId)
releaseNextCas
in interface AnalysisEngineController
public void saveReplyTime(long snapshot, java.lang.String key)
saveReplyTime
in interface AnalysisEngineController
public void saveTime(long anArrivalTime, java.lang.String casReferenceId, java.lang.String anEndpointName)
saveTime
in interface AnalysisEngineController
public void sendMetadata(Endpoint anEndpoint) throws AsynchAEException
sendMetadata
in interface AnalysisEngineController
AsynchAEException
public void setCasManager(AsynchAECasManager casManager)
setCasManager
in interface AnalysisEngineController
public void setDeployDescriptor(java.lang.String deployDescriptor)
setDeployDescriptor
in interface AnalysisEngineController
public void setInputChannel(InputChannel anInputChannel) throws java.lang.Exception
setInputChannel
in interface AnalysisEngineController
java.lang.Exception
public void setOutputChannel(OutputChannel anOutputChannel) throws java.lang.Exception
setOutputChannel
in interface AnalysisEngineController
java.lang.Exception
public void setStopped()
AnalysisEngineController
setStopped
in interface AnalysisEngineController
public void setUimaEEAdminContext(UimaEEAdminContext anAdminContext)
setUimaEEAdminContext
in interface AnalysisEngineController
public void stop()
stop
in interface AnalysisEngineController
public void takeAction(java.lang.String anAction, java.lang.String anEndpointName, ErrorContext anErrorContext)
takeAction
in interface AnalysisEngineController
public void addControllerCallbackListener(ControllerCallbackListener listener)
ControllerLifecycle
addControllerCallbackListener
in interface ControllerLifecycle
listener
- - application listener object to registerpublic void removeControllerCallbackListener(ControllerCallbackListener listener)
ControllerLifecycle
removeControllerCallbackListener
in interface ControllerLifecycle
listener
- - application listener to removepublic void terminate()
ControllerLifecycle
terminate
in interface ControllerLifecycle
public void addEndpointToDoNotProcessList(java.lang.String anEndpointName)
public boolean isEndpointOnDontProcessList(java.lang.String anEndpointName)
public void evictExpiredEntries()
public void changeState(BaseAnalysisEngineController.ServiceState state)
changeState
in interface AnalysisEngineController
public BaseAnalysisEngineController.ServiceState getState()
getState
in interface AnalysisEngineController
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |