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

Constructor

Description

AnalysisEngineControllerAdapter()
Method Summary

Modifier and Type

Method

Description

void

addAbortedCasReferenceId(String casReferenceId)

void

addControllerCallbackListener(ControllerCallbackListener listener)

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

changeState(BaseAnalysisEngineController.ServiceState state)

void

collectionProcessComplete(Endpoint anEndpoint)

void

dropCAS(String casReferenceId, boolean dropCacheEntry)

void

dropCAS(org.apache.uima.cas.CAS acas)

void

dropStats(String casReferenceId, String anEndpointName)

void

endProcess(int msgType)

void

evictExpiredEntries()

void

forceTimeoutOnPendingCases(String key)

long

getAnalysisTime()

AsynchAECasManager

getCasManagerWrapper()

ServicePerformance

getCasStatistics(String casReferenceId)

org.apache.uima.UimaContext

getChildUimaContext(String delegateEndpointName)

Endpoint

getClientEndpoint()

String

getComponentName()

ControllerLatch

getControllerLatch()

long

getCpuTime()

Map<String,String>

getDeadClientMap()

ErrorHandlerChain

getErrorHandlerChain()

EventSubscriber

getEventListener()

long

getIdleTime()

long

getIdleTimeBetweenProcessCalls(int msgType)

int

getIndex()

InProcessCache

getInProcessCache()

InputChannel

getInputChannel()

InputChannel

getInputChannel(String queueName)

String

getJmxContext()

String

getJMXDomain()

LocalCache

getLocalCache()

JmxManagement

getManagementInterface()

Monitor

getMonitor()

String

getName()

OutputChannel

getOutputChannel()

AnalysisEngineController

getParentController()

InputChannel

getReplyInputChannel(String delegateKey)

long

getReplyTime()

String

getServiceEndpointName()

ServiceErrors

getServiceErrors()

ServiceInfo

getServiceInfo()

ServicePerformance

getServicePerformance()

BaseAnalysisEngineController.ServiceState

getState()

Map

getStats()

long

getTime(String casReferenceId, String anEndpointName)

long

getTimeSnapshot(String key)

UimaTransport

getTransport(String key)

UimaTransport

getTransport(UimaAsContext context, String key)

UimaEEAdminContext

getUimaEEAdminContext()

UimaMessageListener

getUimaMessageListener(String delegateKey)

void

handleDelegateLifeCycleEvent(String anEndpoint, int delegateCount)

void

incrementDeserializationTime(long cpuTime)

void

incrementSerializationTime(long cpuTime)

void

initialize()

void

initializeVMTransport(int parentControllerReplyConsumerCount)

boolean

isAwaitingCacheCallbackNotification()

boolean

isCasMultiplier()

boolean

isEndpointOnDontProcessList(String anEndpointName)

boolean

isPrimitive()

boolean

isStopped()

Returns true if the AnalysisEngineController has been (or is in the process of) shutdown.

boolean

isTopLevelComponent()

void

notifyListenersWithInitializationStatus(Exception e)

void

onInitialize()

void

process(org.apache.uima.cas.CAS cas, String casId)

void

process(org.apache.uima.cas.CAS acas, String anInputCasReferenceId, String newCasReferenceId, String newCASProducedBy)

void

process(org.apache.uima.cas.CAS acas, String casReferenceId, Endpoint anEndpoint)

abstract void

quiesceAndStop()

void

registerVmQueueWithJMX(Object o, String name)

void

releaseNextCas(String casReferenceId)

void

removeControllerCallbackListener(ControllerCallbackListener listener)

Removes named application listener.

void

saveReplyTime(long snapshot, String key)

void

saveTime(long anArrivalTime, String casReferenceId, String anEndpointName)

void

sendMetadata(Endpoint anEndpoint)

void

setCasManager(AsynchAECasManager casManager)

void

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

Class AnalysisEngineControllerAdapter

Field Summary

Fields inherited from interface org.apache.uima.aae.controller.AnalysisEngineController

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.uima.aae.controller.AnalysisEngineController

Constructor Details

AnalysisEngineControllerAdapter

Method Details

addAbortedCasReferenceId

addInputChannel

addServiceInfo

addTimeSnapshot

beginProcess

cacheClientEndpoint

collectionProcessComplete

dropCAS

dropCAS

dropStats

endProcess

forceTimeoutOnPendingCases

getAnalysisTime

getCasManagerWrapper

getCasStatistics

getChildUimaContext

getClientEndpoint

getComponentName

getDeadClientMap

getControllerLatch

getCpuTime

getErrorHandlerChain

getEventListener

getIdleTime

getIdleTimeBetweenProcessCalls

getInProcessCache

getIndex

getInputChannel

getInputChannel

getJMXDomain

getJmxContext

getLocalCache

getManagementInterface

getMonitor

getName

getOutputChannel

getParentController

getReplyInputChannel

getReplyTime

getServiceEndpointName

getServiceErrors

getServiceInfo

getServicePerformance

getStats

getTime

getTimeSnapshot

getTransport

getTransport

getUimaEEAdminContext

getUimaMessageListener

handleDelegateLifeCycleEvent

incrementDeserializationTime

incrementSerializationTime

initialize

initializeVMTransport

isAwaitingCacheCallbackNotification

isCasMultiplier

isPrimitive

isStopped

isTopLevelComponent

notifyListenersWithInitializationStatus

onInitialize

process

process

process

quiesceAndStop

registerVmQueueWithJMX

releaseNextCas

saveReplyTime

saveTime