Class BaseAnalysisEngineController

Method Details

• dumpState

  public abstract void dumpState(StringBuffer buffer, String lbl1)

  Specified by:

  dumpState in interface AnalysisEngineController

• getParentController

  public AnalysisEngineController getParentController()

  Specified by:

  getParentController in interface AnalysisEngineController

• getTransport

  public UimaTransport getTransport(String aKey) throws Exception

  Specified by:

  getTransport in interface AnalysisEngineController

  Throws:

  Exception

• getTransport

  public UimaTransport getTransport(UimaAsContext asContext) throws Exception

  Throws:

  Exception

• getTransport

  public UimaTransport getTransport(UimaAsContext asContext, String aKey) throws Exception

  Specified by:

  getTransport in interface AnalysisEngineController

  Throws:

  Exception

• initializeVMTransport

  public void initializeVMTransport(int parentControllerReplyConsumerCount) throws Exception

  Initializes transport used for internal messaging between collocated Uima AS services.

  Specified by:

  initializeVMTransport in interface AnalysisEngineController

  Throws:

  Exception

• getUimaMessageListener

  public UimaMessageListener getUimaMessageListener(String aDelegateKey)

  Specified by:

  getUimaMessageListener in interface AnalysisEngineController

• getJMXDomain

  public String getJMXDomain()

  Get the domain for Uima JMX. The domain includes a fixed string plus the name of the top level component. All uima ee objects are rooted at this domain.

  Specified by:

  getJMXDomain in interface AnalysisEngineController

• getManagementInterface

  public JmxManagement getManagementInterface()

  Specified by:

  getManagementInterface in interface AnalysisEngineController

• getIndex

  public int getIndex()

  Returns a unique id for each component in the service hierarchy. The top level component's id is always = 0

  Specified by:

  getIndex in interface AnalysisEngineController

• getJmxContext

  public String getJmxContext()

  This is called once during initialization to compute the position of the component in the JMX hierarchy and create a context path that will be used to register the component in the JMX registry.

  Specified by:

  getJmxContext in interface AnalysisEngineController

• registerWithAgent

  protected void registerWithAgent(Object o, String aName)

  Register a component with a given name with JMX MBeanServer

  Parameters:

  o - - component to register with JMX

  aName - - full jmx context name for the component

• registerVmQueueWithJMX

  public void registerVmQueueWithJMX(Object o, String aName) throws Exception

  Specified by:

  registerVmQueueWithJMX in interface AnalysisEngineController

  Throws:

  Exception

• registerServiceWithJMX

  protected void registerServiceWithJMX(String key_value_list, boolean remote)

• cleanUp

  protected void cleanUp() throws Exception

  Throws:

  Exception

• setJmxManagement

  public void setJmxManagement(JmxManagement aJmxManagement)

  Override the default JmxManager

• isTopLevelComponent

  public boolean isTopLevelComponent()

  Specified by:

  isTopLevelComponent in interface AnalysisEngineController

• getComponentName

  public String getComponentName()

  Returns the name of the component. The name comes from the analysis engine descriptor

  Specified by:

  getComponentName in interface AnalysisEngineController

• toString

  public String toString()

  Print the component name rather than the class name

  Overrides:

  toString in class Object

• addServiceInfo

  public void addServiceInfo(ServiceInfo aServiceInfo)

  Specified by:

  addServiceInfo in interface AnalysisEngineController

• getServicePerformance

  public ServicePerformance getServicePerformance()

  Specified by:

  getServicePerformance in interface AnalysisEngineController

• getServiceErrors

  public ServiceErrors getServiceErrors()

  Specified by:

  getServiceErrors in interface AnalysisEngineController

• getChildUimaContext

  public org.apache.uima.UimaContext getChildUimaContext(String aDelegateEndpointName) throws Exception

  Specified by:

  getChildUimaContext in interface AnalysisEngineController

  Throws:

  Exception

• setInputChannel

  public void setInputChannel(InputChannel anInputChannel) throws Exception

  Specified by:

  setInputChannel in interface AnalysisEngineController

  Throws:

  Exception

• addInputChannel

  public void addInputChannel(InputChannel anInputChannel)

  Specified by:

  addInputChannel in interface AnalysisEngineController

• getInputChannel

  public InputChannel getInputChannel()

  Specified by:

  getInputChannel in interface AnalysisEngineController

• dropCAS

  public void dropCAS(org.apache.uima.cas.CAS aCAS)

  Specified by:

  dropCAS in interface AnalysisEngineController

• saveReplyTime

  public void saveReplyTime(long snapshot, String aKey)

  Specified by:

  saveReplyTime in interface AnalysisEngineController

• getReplyTime

  public long getReplyTime()

  Specified by:

  getReplyTime in interface AnalysisEngineController

• handleAction

  protected void handleAction(String anAction, String anEndpoint, ErrorContext anErrorContext) throws Exception

  Throws:

  Exception

• forceTimeoutOnPendingCases

  public void forceTimeoutOnPendingCases(String key)

  Specified by:

  forceTimeoutOnPendingCases in interface AnalysisEngineController

• plugInDefaultErrorHandlerChain

  protected void plugInDefaultErrorHandlerChain()

• setErrorHandlerChain

  public void setErrorHandlerChain(ErrorHandlerChain errorHandlerChain)

• getErrorHandlerChain

  public ErrorHandlerChain getErrorHandlerChain()

  Specified by:

  getErrorHandlerChain in interface AnalysisEngineController

• handleError

  public void handleError(HashMap aMap, Throwable e)

• dropCAS

  public void dropCAS(String aCasReferenceId, boolean deleteCacheEntry)

  Specified by:

  dropCAS in interface AnalysisEngineController

• saveTime

  public void saveTime(long aTime, String aCasReferenceId, String anEndpointName)

  Specified by:

  saveTime in interface AnalysisEngineController

• getTime

  public long getTime(String aCasReferenceId, String anEndpointName)

  Specified by:

  getTime in interface AnalysisEngineController

• resetErrorCounter

  protected void resetErrorCounter()

• incrementErrorCounter

  protected void incrementErrorCounter()

• exceedsThresholdWithinWindow

  protected boolean exceedsThresholdWithinWindow(int threshold, long docCount, int windowSize)

• getOutputChannel

  public OutputChannel getOutputChannel()

  Specified by:

  getOutputChannel in interface AnalysisEngineController

• setOutputChannel

  public void setOutputChannel(OutputChannel outputChannel) throws Exception

  Specified by:

  setOutputChannel in interface AnalysisEngineController

  Throws:

  Exception

• getCasManagerWrapper

  public AsynchAECasManager getCasManagerWrapper()

  Specified by:

  getCasManagerWrapper in interface AnalysisEngineController

• setCasManager

  public void setCasManager(AsynchAECasManager casManager)

  Specified by:

  setCasManager in interface AnalysisEngineController

• getInProcessCache

  public InProcessCache getInProcessCache()

  Specified by:

  getInProcessCache in interface AnalysisEngineController

• getResourceSpecifier

  protected org.apache.uima.resource.ResourceSpecifier getResourceSpecifier()

• getName

  public String getName()

  Specified by:

  getName in interface AnalysisEngineController

• getKey

  public String getKey()

  Specified by:

  getKey in interface AnalysisEngineController

• process

  public void process(org.apache.uima.cas.CAS aCas, String aCasId)

  Specified by:

  process in interface AnalysisEngineController

• process

  public void process(org.apache.uima.cas.CAS aCAS, String anInputCasReferenceId, String aNewCasReferenceId, String newCASProducedBy)

  Specified by:

  process in interface AnalysisEngineController

• process

  public void process(org.apache.uima.cas.CAS aCAS, String aCasReferenceId, Endpoint anEndpoint)

  Specified by:

  process in interface AnalysisEngineController

• setUimaEEAdminContext

  public void setUimaEEAdminContext(UimaEEAdminContext anAdminContext)

  Specified by:

  setUimaEEAdminContext in interface AnalysisEngineController

• getUimaEEAdminContext

  public UimaEEAdminContext getUimaEEAdminContext()

  Specified by:

  getUimaEEAdminContext in interface AnalysisEngineController

• dropStats

  public void dropStats(String aCasReferenceId, String anEndpointName)

  Removes statistics from the global Map

  Specified by:

  dropStats in interface AnalysisEngineController

• logStats

  protected void logStats()

• getCasStatistics

  public ServicePerformance getCasStatistics(String aCasReferenceId)

  Returns stats associated with a given CAS. A service uses a global map to store CAS level statistics. A key to the map is the CAS id. This method creates a new instance of ServicePerformance object if one doesnt exist in the map for a given CAS id.

  Specified by:

  getCasStatistics in interface AnalysisEngineController

• logStats

  protected void logStats(String aDelegateKey, ServicePerformance aServicePerformance)

  Logs statistics

  Parameters:

  aDelegateKey -

  aDelegateServicePerformance -

• clearStats

  protected void clearStats()

  Clears controller statistics.

• getStats

  public Map getStats()

  Returns a copy of the controller statistics.

  Specified by:

  getStats in interface AnalysisEngineController

• setDeployDescriptor

  public void setDeployDescriptor(String aDeployDescriptor)

  Specified by:

  setDeployDescriptor in interface AnalysisEngineController

• getServiceName

  public String getServiceName()

• getDeploymentDescriptor

  public String getDeploymentDescriptor()

• getDeploymentMode

  public String getDeploymentMode()

• getBrokerURL

  public String getBrokerURL()

• getInputQueue

  public String getInputQueue()

• getTotalTimeSpentSerializingCAS

  public long getTotalTimeSpentSerializingCAS()

• getTotalTimeSpendDeSerializingCAS

  public long getTotalTimeSpendDeSerializingCAS()

• getTotalTimeSpentWaitingForFreeCASInstance

  public long getTotalTimeSpentWaitingForFreeCASInstance()

• getTotalNumberOfCASesReceived

  public long getTotalNumberOfCASesReceived()

• getTotalNumberOfCASesProcessed

  public long getTotalNumberOfCASesProcessed()

• getTotalNumberOfCASesDropped

  public long getTotalNumberOfCASesDropped()

• getTotalNumberOfErrors

  public long getTotalNumberOfErrors()

• getClientEndpoint

  public Endpoint getClientEndpoint()

  Specified by:

  getClientEndpoint in interface AnalysisEngineController

• cacheClientEndpoint

  public void cacheClientEndpoint(Endpoint anEndpoint)

  Specified by:

  cacheClientEndpoint in interface AnalysisEngineController

  Parameters:

  anEndpoint -

• isStopped

  public boolean isStopped()

  Return true if this service is in the shutdown state

  Specified by:

  isStopped in interface AnalysisEngineController

  Returns:

  - true if stopped

• 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

• stopTransportLayer

  protected void stopTransportLayer()

• stop

  public void stop()

  Stops input channel(s) and initiates a shutdown of all delegates ( if this is an aggregate ). At the end sends an Exception to the client and closes an output channel.

  Specified by:

  stop in interface AnalysisEngineController

• stop

  public void stop(Throwable cause, String aCasReferenceId)

• quiesceAndStop

  public void quiesceAndStop()

  Stops input channel(s) and waits for CASes still in play to complete processing. When the InProcessCache becomes empty, initiate the service shutdown.

  Specified by:

  quiesceAndStop in interface AnalysisEngineController

• stopDelegateTimers

  protected void stopDelegateTimers()

• terminate

  public void terminate()

  Using a reference to its parent, propagates the terminate event to the top level controller. Typically invoked, when the error handling detects excessive errors and action=terminate. The top level controller, stops its input channel and instructs a colocated Cas Multiplier (it it has one) to stop generating new CASes. It then registers self as a listener with the InProcessCache. The callback will be called when the InProcessCache becomes empty. Only then, the top level controller will call stop() on each of a delegates (if the top level is an aggregate).

  Specified by:

  terminate in interface ControllerLifecycle

• terminate

  public void terminate(Throwable cause, String aCasReferenceId)

• stopCasMultipliers

  public void stopCasMultipliers()

• stopCasMultiplier

  public void stopCasMultiplier(Delegate casMultiplier, String aCasReferenceId)

• stopInputChannel

  protected void stopInputChannel()

  Stops a listener on the main input channel

• stopInputChannels

  protected void stopInputChannels(int channelsToStop)

• getCasMultiplierController

  public AnalysisEngineController getCasMultiplierController(String cmKey)

  Aggregates have more than one Listener channel. This method stops all configured input channels this service is configured with.

• getInputChannel

  public InputChannel getInputChannel(String anEndpointName)

  Specified by:

  getInputChannel in interface AnalysisEngineController

• getReplyInputChannel

  public InputChannel getReplyInputChannel(String aDelegateKey)

  Specified by:

  getReplyInputChannel in interface AnalysisEngineController

• onCacheEmpty

  public void onCacheEmpty()

  Callback method called the InProcessCache becomes empty meaning ALL CASes are processed. The callback is only active when the the top level component is in the process of shutting down.

  Specified by:

  onCacheEmpty in interface EventSubscriber

• getEventListener

  public EventSubscriber getEventListener()

  Returns interface via which this instance receives callbacks

  Specified by:

  getEventListener in interface AnalysisEngineController

• addControllerCallbackListener

  public void addControllerCallbackListener(ControllerCallbackListener aListener)

  Register one or more listeners through which the controller can send notification of events.

  Specified by:

  addControllerCallbackListener in interface ControllerLifecycle

  Parameters:

  aListener - - application listener object to register

• removeControllerCallbackListener

  public void removeControllerCallbackListener(ControllerCallbackListener aListener)

  Removes named application listener.

  Specified by:

  removeControllerCallbackListener in interface ControllerLifecycle

  Parameters:

  aListener - - application listener to remove

• notifyListenersWithInitializationStatus

  public void notifyListenersWithInitializationStatus(Exception e)

  Specified by:

  notifyListenersWithInitializationStatus in interface AnalysisEngineController

• dropCasStatistics

  protected void dropCasStatistics(String aCasReferenceId)

• isCasMultiplier

  public boolean isCasMultiplier()

  Specified by:

  isCasMultiplier in interface AnalysisEngineController

• releaseNextCas

  public void releaseNextCas(String casReferenceId)

  Specified by:

  releaseNextCas in interface AnalysisEngineController

• beginProcess

  public void beginProcess(int msgType)

  Specified by:

  beginProcess in interface AnalysisEngineController

• endProcess

  public void endProcess(int msgType)

  Specified by:

  endProcess in interface AnalysisEngineController

• getIdleTimeBetweenProcessCalls

  public long getIdleTimeBetweenProcessCalls(int msgType)

  Specified by:

  getIdleTimeBetweenProcessCalls in interface AnalysisEngineController

• getIdleTime

  public long getIdleTime()

  Specified by:

  getIdleTime in interface AnalysisEngineController

• getCpuTime

  public long getCpuTime()

  Returns CPU Time with nanosecond precision (not nanosecond accuracy). If the OS/JVM does not support reporting the CPU Time, returns the wall clock time.

  Specified by:

  getCpuTime in interface AnalysisEngineController

• getAnalysisTime

  public long getAnalysisTime()

  Returns the total CPU time all processing threads spent in analysis. This method subtracts the serialization and de-serialization time from the total. If this service is an aggregate, the return time is a sum of CPU utilization in each colocated delegate.

  Specified by:

  getAnalysisTime in interface AnalysisEngineController

• incrementSerializationTime

  public void incrementSerializationTime(long cpuTime)

  Increments the time this thread spent in serialization of a CAS

  Specified by:

  incrementSerializationTime in interface AnalysisEngineController

• incrementDeserializationTime

  public void incrementDeserializationTime(long cpuTime)

  Increments the time this thread spent in deserialization of a CAS

  Specified by:

  incrementDeserializationTime in interface AnalysisEngineController

• sendMetadata

  public void sendMetadata(Endpoint anEndpoint, org.apache.uima.analysis_engine.metadata.AnalysisEngineMetaData metadata)

• getLocalCache

  public LocalCache getLocalCache()

  Specified by:

  getLocalCache in interface AnalysisEngineController

• addAbortedCasReferenceId

  public void addAbortedCasReferenceId(String aCasReferenceId)

  Specified by:

  addAbortedCasReferenceId in interface AnalysisEngineController

• abortGeneratingCASes

  protected boolean abortGeneratingCASes(String aCasReferenceId)

  Returns true if a given CAS id is in the list of aborted CASes.

  Parameters:

  aCasReferenceId - - id of the current input CAS being processed

  Returns:

  - true if the CAS is in the list of aborted CASes, false otherwise

• isAwaitingCacheCallbackNotification

  public boolean isAwaitingCacheCallbackNotification()

  Specified by:

  isAwaitingCacheCallbackNotification in interface AnalysisEngineController

• changeState

  public void changeState(BaseAnalysisEngineController.ServiceState state)

  Specified by:

  changeState in interface AnalysisEngineController

• getState

  public BaseAnalysisEngineController.ServiceState getState()

  Specified by:

  getState in interface AnalysisEngineController

• getDeadClientMap

  public Map<String,String> getDeadClientMap()

  Specified by:

  getDeadClientMap in interface AnalysisEngineController