Package org.apache.uima.aae.controller

Interface AggregateAnalysisEngineController

All Superinterfaces:

AnalysisEngineController, ControllerLifecycle

All Known Implementing Classes:

AggregateAnalysisEngineController_impl

public interface AggregateAnalysisEngineController
extends AnalysisEngineController

Field Summary

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

AEInstanceCount, CasPoolSize

Method Summary

Modifier and Type	Method	Description
void	addMessageOrigin(java.lang.String aCasReferenceId, Endpoint anEndpoint)
void	changeCollocatedDelegateState(java.lang.String delegateKey, BaseAnalysisEngineController.ServiceState state)
boolean	continueOnError(java.lang.String aCasReferenceId, java.lang.String aDelegateKey, java.lang.Exception anException)
boolean	delayCasIfDelegateInTimedOutState(java.lang.String aCasReferenceId, java.lang.String aDelegateKey)
void	disableDelegates(java.util.List aDelegateList)
void	dispatchMetadataRequest(Endpoint anEndpoint)
void	dropFlow(java.lang.String aCasReferenceId, boolean dropFlow)
void	enableDelegates(java.util.List aDelegateList)
void	finalStep(org.apache.uima.flow.FinalStep aStep, java.lang.String aCasReferenceId)
java.util.List	getChildControllerList()
org.apache.uima.UimaContext	getChildUimaContext(java.lang.String aDelegateEndpointName)
ServiceErrors	getDelegateServiceErrors(java.lang.String aDelegateKey)
PrimitiveServiceInfo	getDelegateServiceInfo(java.lang.String aDelegateKey)
ServicePerformance	getDelegateServicePerformance(java.lang.String aDelegateKey)
java.util.Map	getDelegateStats()
java.util.Map	getDestinations()
java.lang.String	getLastDelegateKeyFromFlow(java.lang.String anInputCasReferenceId)
Endpoint	getMessageOrigin(java.lang.String aCasReferenceId)
AggregateServiceInfo	getServiceInfo()
ServicePerformance	getServicePerformance(java.lang.String aDelegateKey)
boolean	isDelegateDisabled(java.lang.String aDelegateKey)
boolean	isDelegateKeyValid(java.lang.String anEndpointName)
Delegate	lookupDelegate(java.lang.String aDelegateKey)
java.lang.String	lookUpDelegateKey(java.lang.String aDelegateEndpointName)
java.lang.String	lookUpDelegateKey(java.lang.String aDelegateEndpointName, java.lang.String server)
Endpoint	lookUpEndpoint(java.lang.String anAnalysisEngineKey, boolean clone)
void	mapEndpointsToKeys(java.util.concurrent.ConcurrentHashMap aDestinationMap)
void	mergeTypeSystem(java.lang.String aTypeSystem, java.lang.String fromDestination)
void	mergeTypeSystem(java.lang.String aTypeSystem, java.lang.String fromDestination, java.lang.String fromServer)
void	processCollectionCompleteReplyFromDelegate(java.lang.String aDelegateKey, boolean sendReply)
void	registerChildController(AnalysisEngineController aChildController, java.lang.String aDelegateKey)
void	removeMessageOrigin(java.lang.String aCasReferenceId)
boolean	requestForMetaSentToRemotes()
void	retryLastCommand(int aCommand, Endpoint anEndpoint, java.lang.String aCasReferenceId)
void	retryMetadataRequest(Endpoint anEndpoint)
void	retryProcessCASRequest(java.lang.String aCasReferenceId, Endpoint anEndpoint, boolean addEndpointToCache)
void	saveStatsFromService(java.lang.String aServiceEndpointName, java.util.Map aServiceStats)
void	sendRequestForMetadataToRemoteDelegates()
void	setCasLoggingDirectory(java.lang.String key, java.lang.String directoryName)
void	setRequestForMetaSentToRemotes()
void	stopCasMultiplier(Delegate casMultiplier, java.lang.String aCasReferenceId)
void	stopTimers()

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

addAbortedCasReferenceId, addInputChannel, addServiceInfo, beginProcess, cacheClientEndpoint, changeState, collectionProcessComplete, dropCAS, dropCAS, dropStats, dumpState, endProcess, forceTimeoutOnPendingCases, getAnalysisTime, getCasManagerWrapper, getCasStatistics, getClientEndpoint, getComponentName, getControllerLatch, getCpuTime, getDeadClientMap, getErrorHandlerChain, getEventListener, getIdleTime, getIdleTimeBetweenProcessCalls, getIndex, getInProcessCache, getInputChannel, getInputChannel, getJmxContext, getJMXDomain, getKey, getLocalCache, getManagementInterface, getMonitor, getName, getOutputChannel, getParentController, getReplyInputChannel, getReplyTime, getServiceEndpointName, getServiceErrors, getServicePerformance, getState, getStats, getTime, getTransport, getTransport, getUimaEEAdminContext, getUimaMessageListener, handleDelegateLifeCycleEvent, incrementDeserializationTime, incrementSerializationTime, initialize, initializeVMTransport, isAwaitingCacheCallbackNotification, isCasMultiplier, isPrimitive, isStopped, isTopLevelComponent, notifyListenersWithInitializationStatus, onInitialize, process, process, process, quiesceAndStop, registerVmQueueWithJMX, releaseNextCas, saveReplyTime, saveTime, sendMetadata, setCasManager, setDeployDescriptor, setInputChannel, setOutputChannel, setStopped, setUimaEEAdminContext, stop, takeAction

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

addControllerCallbackListener, removeControllerCallbackListener, terminate

Method Detail

mergeTypeSystem

void mergeTypeSystem(java.lang.String aTypeSystem,
                     java.lang.String fromDestination)
              throws AsynchAEException

Throws:

AsynchAEException

mergeTypeSystem

void mergeTypeSystem(java.lang.String aTypeSystem,
                     java.lang.String fromDestination,
                     java.lang.String fromServer)
              throws AsynchAEException

Throws:

AsynchAEException

sendRequestForMetadataToRemoteDelegates

void sendRequestForMetadataToRemoteDelegates()
                                      throws AsynchAEException

Throws:

AsynchAEException

addMessageOrigin

void addMessageOrigin(java.lang.String aCasReferenceId,
                      Endpoint anEndpoint)

getMessageOrigin

Endpoint getMessageOrigin(java.lang.String aCasReferenceId)

removeMessageOrigin

void removeMessageOrigin(java.lang.String aCasReferenceId)

processCollectionCompleteReplyFromDelegate

void processCollectionCompleteReplyFromDelegate(java.lang.String aDelegateKey,
                                                boolean sendReply)
                                         throws AsynchAEException

Throws:

AsynchAEException

isDelegateKeyValid

boolean isDelegateKeyValid(java.lang.String anEndpointName)

mapEndpointsToKeys

void mapEndpointsToKeys(java.util.concurrent.ConcurrentHashMap aDestinationMap)

lookUpEndpoint

Endpoint lookUpEndpoint(java.lang.String anAnalysisEngineKey,
                        boolean clone)
                 throws AsynchAEException

Throws:

AsynchAEException

dispatchMetadataRequest

void dispatchMetadataRequest(Endpoint anEndpoint)
                      throws AsynchAEException

Throws:

AsynchAEException

retryLastCommand

void retryLastCommand(int aCommand,
                      Endpoint anEndpoint,
                      java.lang.String aCasReferenceId)

retryMetadataRequest

void retryMetadataRequest(Endpoint anEndpoint)
                   throws AsynchAEException

Throws:

AsynchAEException

lookUpDelegateKey

java.lang.String lookUpDelegateKey(java.lang.String aDelegateEndpointName)

lookUpDelegateKey

java.lang.String lookUpDelegateKey(java.lang.String aDelegateEndpointName,
                                   java.lang.String server)

getChildUimaContext

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

Specified by:

getChildUimaContext in interface AnalysisEngineController

Throws:

java.lang.Exception

retryProcessCASRequest

void retryProcessCASRequest(java.lang.String aCasReferenceId,
                            Endpoint anEndpoint,
                            boolean addEndpointToCache)
                     throws AsynchAEException

Throws:

AsynchAEException

enableDelegates

void enableDelegates(java.util.List aDelegateList)
              throws AsynchAEException

Throws:

AsynchAEException

disableDelegates

void disableDelegates(java.util.List aDelegateList)
               throws AsynchAEException

Throws:

AsynchAEException

continueOnError

boolean continueOnError(java.lang.String aCasReferenceId,
                        java.lang.String aDelegateKey,
                        java.lang.Exception anException)
                 throws AsynchAEException

Throws:

AsynchAEException

dropFlow

void dropFlow(java.lang.String aCasReferenceId,
              boolean dropFlow)

isDelegateDisabled

boolean isDelegateDisabled(java.lang.String aDelegateKey)

getLastDelegateKeyFromFlow

java.lang.String getLastDelegateKeyFromFlow(java.lang.String anInputCasReferenceId)

registerChildController

void registerChildController(AnalysisEngineController aChildController,
                             java.lang.String aDelegateKey)
                      throws java.lang.Exception

Throws:

java.lang.Exception

saveStatsFromService

void saveStatsFromService(java.lang.String aServiceEndpointName,
                          java.util.Map aServiceStats)

getDelegateStats

java.util.Map getDelegateStats()

getServiceInfo

AggregateServiceInfo getServiceInfo()

Specified by:

getServiceInfo in interface AnalysisEngineController

getDelegateServicePerformance

ServicePerformance getDelegateServicePerformance(java.lang.String aDelegateKey)

getDelegateServiceInfo

PrimitiveServiceInfo getDelegateServiceInfo(java.lang.String aDelegateKey)

getDelegateServiceErrors

ServiceErrors getDelegateServiceErrors(java.lang.String aDelegateKey)

stopTimers

void stopTimers()

requestForMetaSentToRemotes

boolean requestForMetaSentToRemotes()

setRequestForMetaSentToRemotes

void setRequestForMetaSentToRemotes()

getDestinations

java.util.Map getDestinations()

getServicePerformance

ServicePerformance getServicePerformance(java.lang.String aDelegateKey)

finalStep

void finalStep(org.apache.uima.flow.FinalStep aStep,
               java.lang.String aCasReferenceId)

lookupDelegate

Delegate lookupDelegate(java.lang.String aDelegateKey)

delayCasIfDelegateInTimedOutState

boolean delayCasIfDelegateInTimedOutState(java.lang.String aCasReferenceId,
                                          java.lang.String aDelegateKey)
                                   throws AsynchAEException

Throws:

AsynchAEException

getChildControllerList

java.util.List getChildControllerList()

stopCasMultiplier

void stopCasMultiplier(Delegate casMultiplier,
                       java.lang.String aCasReferenceId)

setCasLoggingDirectory

void setCasLoggingDirectory(java.lang.String key,
                            java.lang.String directoryName)

changeCollocatedDelegateState

void changeCollocatedDelegateState(java.lang.String delegateKey,
                                   BaseAnalysisEngineController.ServiceState state)
                            throws java.lang.Exception

Throws:

java.lang.Exception