BaseUIMAAsynchronousEngine_impl (UIMA-AS: uima-as 2.3.1 API)

java.lang.Object
- org.apache.uima.adapter.jms.client.BaseUIMAAsynchronousEngineCommon_impl
- - org.apache.uima.adapter.jms.client.BaseUIMAAsynchronousEngine_impl

All Implemented Interfaces:: javax.jms.MessageListener, UimaAsynchronousEngine, ControllerCallbackListener

public class BaseUIMAAsynchronousEngine_impl
extends BaseUIMAAsynchronousEngineCommon_impl
implements UimaAsynchronousEngine, javax.jms.MessageListener, ControllerCallbackListener

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.uima.adapter.jms.client.BaseUIMAAsynchronousEngineCommon_impl
  BaseUIMAAsynchronousEngineCommon_impl.ClientRequest, BaseUIMAAsynchronousEngineCommon_impl.ClientState, BaseUIMAAsynchronousEngineCommon_impl.SharedConnection, BaseUIMAAsynchronousEngineCommon_impl.ThreadMonitor, BaseUIMAAsynchronousEngineCommon_impl.UimaASShutdownHook

Field Summary

Fields
Modifier and Type Field and Description

protected InitialContext jndiContext

protected static Semaphore sharedConnectionSemaphore
- Fields inherited from class org.apache.uima.adapter.jms.client.BaseUIMAAsynchronousEngineCommon_impl
  abort, asynchManager, clientCache, clientSideJmxStats, collectionReader, consumer, cpcReadySemaphore, cpcReplySemaphore, cpcSemaphore, cpcTimeout, CpCTimeout, exc, getMetaSemaphore, idGenerator, initialized, listeners, metadataTimeout, MetadataTimeout, outstandingCasRequests, pendingMessageQueue, PingTimeout, processTimeout, ProcessTimeout, producerInitialized, producerSemaphore, remoteService, resourceMetadata, running, sendAndReceiveCAS, serializationStrategy, serviceDelegate, SHADOW_CAS_POOL, sharedConnection, shutdownHookThread, springContainerRegistry, state, threadMonitorMap, totalCasRequestsSentBetweenCpCs, uniqueIdentifier
- Fields inherited from interface org.apache.uima.aae.client.UimaAsynchronousEngine
  ApplicationContext, ApplicationName, CasPoolSize, CpcTimeout, DD2SpringXsltFilePath, Endpoint, GetMetaTimeout, ReplyWindow, SaxonClasspath, SerializationStrategy, ServerUri, ShadowCasPoolSize, SharedConnection, Timeout, UimaEeDebug

Fields
Modifier and Type	Field and Description
`protected InitialContext`	`jndiContext`
`protected static Semaphore`	`sharedConnectionSemaphore`

Constructor Summary

Constructors
Constructor and Description

BaseUIMAAsynchronousEngine_impl()

Constructors
Constructor and Description
`BaseUIMAAsynchronousEngine_impl()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`cleanup()` Called at the end of collectionProcessingComplete - WAS closes receiving thread here
`protected javax.jms.BytesMessage`	`createBytesMessage()`
`protected void`	`createSharedConnection(String aBrokerURI)`
`protected javax.jms.TextMessage`	`createTextMessage()`
`String`	`deploy(String[] aDeploymentDescriptorList, Map anApplicationContext)` Deploys a single UIMA AS container and all services defined in provided deployment descriptors.
`String`	`deploy(String aDeploymentDescriptor, Map anApplicationContext)` First generates a Spring context from a given deploy descriptor and than deploys the context into a Spring Container.
`protected void`	`deployEmbeddedBroker()`
`protected String`	`deploySpringContainer(String[] springContextFiles)` Deploys provided context files ( and beans) in a new Spring container.
`protected MessageSender`	`getDispatcher()`
`String`	`getEndPointName()` Return a name of the queue to which the JMS Producer is connected to.
`protected javax.jms.MessageProducer`	`getMessageProducer(javax.jms.Destination destination)`
`protected javax.jms.Session`	`getSession(javax.jms.Connection aConnection)`
`protected javax.jms.Session`	`getSession(String aBrokerURI)`
`void`	`initialize(Map anApplicationContext)` Initialize the uima ee client.
`protected void`	`initializeConsumer(String aBrokerURI)` Create a JMS Consumer on a temporary queue.
`protected void`	`initializeConsumer(String aBrokerURI, javax.jms.Connection connection)`
`protected void`	`initializeProducer(String aBrokerURI, String aQueueName)`
`protected void`	`initializeProducer(String aBrokerURI, String aQueueName, javax.jms.Connection aConnection)`
`protected javax.jms.MessageProducer`	`lookupProducerForEndpoint(Endpoint anEndpoint)`
`static void`	`main(String[] args)`
`void`	`notifyOnInitializationFailure(AnalysisEngineController aController, Exception e)`
`void`	`notifyOnInitializationFailure(Exception e)`
`void`	`notifyOnInitializationSuccess()`
`void`	`notifyOnInitializationSuccess(AnalysisEngineController aController)`
`void`	`notifyOnReconnecting(String aMessage)`
`void`	`notifyOnReconnectionSuccess()`
`void`	`notifyOnTermination(String aServiceName)`
`void`	`notifyOnTermination(String aServiceName, String aCasReferenceId, Exception cause)`
`protected void`	`setCASMessage(String aCasReferenceId, byte[] aSerializedCAS, javax.jms.Message msg)`
`protected void`	`setCASMessage(String aCasReferenceId, org.apache.uima.cas.CAS aCAS, javax.jms.Message msg)` Initialize JMS Message with properties relevant to Process CAS request.
`protected void`	`setCASMessage(String aCasReferenceId, String aSerializedCAS, javax.jms.Message msg)`
`protected void`	`setCommonProperties(String aCasReferenceId, javax.jms.Message msg, String aSerializationStrategy)`
`void`	`setCPCMessage(javax.jms.Message msg)`
`protected void`	`setMetaRequestMessage(javax.jms.Message msg)`
`void`	`setReleaseCASMessage(javax.jms.TextMessage msg, String aCasReferenceId)`
`void`	`stop()` Stops the asynchronous client.
`void`	`stopProducingCases()` Request Uima AS client to initiate sending Stop requests to a service for all outstanding CASes awaiting reply.
`void`	`stopProducingCases(String aCasReferenceId)` Request Uima AS client to initiate sending Stop request to a service for a given CAS id If the service is a Cas Multiplier, it will stop producing new CASes, will wait until all child CASes finish and finally returns the input CAS.
`void`	`undeploy()`
`void`	`undeploy(String aSpringContainerId)` Undeploys specified UIMA AS container and all services running within it.
`void`	`undeploy(String aSpringContainerId, int stop_level)` Undeploys Spring container with a given container Id.
`protected void`	`waitForServiceNotification()`

Methods inherited from class org.apache.uima.adapter.jms.client.BaseUIMAAsynchronousEngineCommon_impl
acquireCpcReadySemaphore, addStatusCallbackListener, cancelTimer, collectionProcessingComplete, connectionOpen, decrementOutstandingCasCounter, delayCasIfDelegateInTimedOutState, deserialize, deserialize, deserialize, deserializeCAS, deserializeCAS, deserializeCAS, deserializeCAS, deserializeCAS, deserializeCAS, doStop, getCache, getCAS, getMetaData, getPerformanceReport, getSerializationStrategy, handleCollectionProcessCompleteReply, handleException, handleException, handleException, handleMetadataReply, handleNonProcessException, handleProcessReply, handleServiceInfo, notifyListeners, notifyOnTimout, onBeforeMessageSend, onException, onMessage, onProducerInitialized, process, recoverSharedConnectionIfClosed, removeFromCache, removeStatusCallbackListener, reset, sendAndReceiveCAS, sendAndReceiveCAS, sendCAS, sendMetaRequest, serializeCAS, serializeCAS, setCollectionReader, setSerializationStrategy, waitForCpcReply, waitForMetadataReply, wakeUpSendThread

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.client.UimaAsynchronousEngine
addStatusCallbackListener, collectionProcessingComplete, getCAS, getMetaData, getPerformanceReport, getSerializationStrategy, process, removeStatusCallbackListener, sendAndReceiveCAS, sendCAS, setCollectionReader

Methods inherited from interface javax.jms.MessageListener
onMessage

- Field Detail
  - sharedConnectionSemaphore
```
protected static Semaphore sharedConnectionSemaphore
```
  - jndiContext
```
protected InitialContext jndiContext
```
- Constructor Detail
  - BaseUIMAAsynchronousEngine_impl
```
public BaseUIMAAsynchronousEngine_impl()
```
- Method Detail
  - createTextMessage
```
protected javax.jms.TextMessage createTextMessage()
                                           throws org.apache.uima.resource.ResourceInitializationException
```
    Specified by:
    
    createTextMessage in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - createBytesMessage
```
protected javax.jms.BytesMessage createBytesMessage()
                                             throws org.apache.uima.resource.ResourceInitializationException
```
    Specified by:
    
    createBytesMessage in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - cleanup
```
protected void cleanup()
                throws Exception
```
    Called at the end of collectionProcessingComplete - WAS closes receiving thread here
    
    Specified by:
    
    cleanup in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    Exception
  - getEndPointName
```
public String getEndPointName()
                       throws org.apache.uima.resource.ResourceProcessException
```
    Return a name of the queue to which the JMS Producer is connected to.
    
    Specified by:
    
    getEndPointName in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    org.apache.uima.resource.ResourceProcessException
  - setMetaRequestMessage
```
protected void setMetaRequestMessage(javax.jms.Message msg)
                              throws Exception
```
    Specified by:
    
    setMetaRequestMessage in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    Exception
  - setCASMessage
```
protected void setCASMessage(String aCasReferenceId,
                 org.apache.uima.cas.CAS aCAS,
                 javax.jms.Message msg)
                      throws org.apache.uima.resource.ResourceProcessException
```
    Initialize JMS Message with properties relevant to Process CAS request.
    
    Specified by:
    
    setCASMessage in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    org.apache.uima.resource.ResourceProcessException
  - setCASMessage
```
protected void setCASMessage(String aCasReferenceId,
                 String aSerializedCAS,
                 javax.jms.Message msg)
                      throws org.apache.uima.resource.ResourceProcessException
```
    Specified by:
    
    setCASMessage in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    org.apache.uima.resource.ResourceProcessException
  - setCASMessage
```
protected void setCASMessage(String aCasReferenceId,
                 byte[] aSerializedCAS,
                 javax.jms.Message msg)
                      throws org.apache.uima.resource.ResourceProcessException
```
    Specified by:
    
    setCASMessage in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    org.apache.uima.resource.ResourceProcessException
  - setCommonProperties
```
protected void setCommonProperties(String aCasReferenceId,
                       javax.jms.Message msg,
                       String aSerializationStrategy)
                            throws org.apache.uima.resource.ResourceProcessException
```
    Throws:
    
    org.apache.uima.resource.ResourceProcessException
  - stop
```
public void stop()
```
    Description copied from interface: UimaAsynchronousEngine
    
    Stops the asynchronous client. Cleans up resources, drops connection to UIMA AS service queue and stops listening on a response queue.
    
    Specified by:
    
    stop in interface UimaAsynchronousEngine
  - setCPCMessage
```
public void setCPCMessage(javax.jms.Message msg)
                   throws Exception
```
    Specified by:
    
    setCPCMessage in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    Exception
  - createSharedConnection
```
protected void createSharedConnection(String aBrokerURI)
                               throws Exception
```
    Throws:
    
    Exception
  - getSession
```
protected javax.jms.Session getSession(String aBrokerURI)
                                throws Exception
```
    Throws:
    
    Exception
  - getSession
```
protected javax.jms.Session getSession(javax.jms.Connection aConnection)
                                throws Exception
```
    Throws:
    
    Exception
  - lookupProducerForEndpoint
```
protected javax.jms.MessageProducer lookupProducerForEndpoint(Endpoint anEndpoint)
                                                       throws Exception
```
    Throws:
    
    Exception
  - initializeProducer
```
protected void initializeProducer(String aBrokerURI,
                      String aQueueName)
                           throws Exception
```
    Throws:
    
    Exception
  - initializeProducer
```
protected void initializeProducer(String aBrokerURI,
                      String aQueueName,
                      javax.jms.Connection aConnection)
                           throws Exception
```
    Throws:
    
    Exception
  - initializeConsumer
```
protected void initializeConsumer(String aBrokerURI)
                           throws Exception
```
    Create a JMS Consumer on a temporary queue. Service replies will be handled by this consumer.
    
    Parameters:
    aBrokerURI -
    
    Throws:
    
    Exception
  - initializeConsumer
```
protected void initializeConsumer(String aBrokerURI,
                      javax.jms.Connection connection)
                           throws Exception
```
    Specified by:
    
    initializeConsumer in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    Exception
  - initialize
```
public void initialize(Map anApplicationContext)
                throws org.apache.uima.resource.ResourceInitializationException
```
    Initialize the uima ee client. Takes initialization parameters from the anApplicationContext map.
    
    Specified by:
    
    initialize in interface UimaAsynchronousEngine
    
    Specified by:
    
    initialize in class BaseUIMAAsynchronousEngineCommon_impl
    
    Parameters:
    anApplicationContext - - configuration containing UIMA EE Service Broker URI, service queue name, timeout value, reply window size, and CAS Pool size.
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - deploy
```
public String deploy(String aDeploymentDescriptor,
            Map anApplicationContext)
              throws Exception
```
    First generates a Spring context from a given deploy descriptor and than deploys the context into a Spring Container.
    
    Specified by:
    
    deploy in interface UimaAsynchronousEngine
    
    Parameters:
    aDeploymentDescriptor - - deployment descriptor to generate Spring Context from
    anApplicationContext - - a Map containing properties required by dd2spring
    
    Returns:
    - a unique spring container id
    
    Throws:
    
    Exception - - if there was a problem deploying the container or UIMA AS services.
  - deploy
```
public String deploy(String[] aDeploymentDescriptorList,
            Map anApplicationContext)
              throws Exception
```
    Description copied from interface: UimaAsynchronousEngine
    
    Deploys a single UIMA AS container and all services defined in provided deployment descriptors. Each deployment descriptor contains an assembly of related UIMA AS services. This method is synchronous and will block until all UIMA AS services are completely deployed and initialized. If there is a problem deploying any of the UIMA AS services the container is destroyed and exception thrown.
    
    Specified by:
    
    deploy in interface UimaAsynchronousEngine
    
    Specified by:
    
    deploy in class BaseUIMAAsynchronousEngineCommon_impl
    
    Parameters:
    aDeploymentDescriptorList - - a list of deployment descriptors to deploy in a container.
    anApplicationContext - - initialization parameters needed to configure the client and services
    
    Returns:
    - the id of the container in which the UIMA AS services were deployed
    
    Throws:
    
    Exception - - if there was a problem deploying the container or UIMA AS services.
  - undeploy
```
public void undeploy()
              throws Exception
```
    Throws:
    
    Exception
  - undeploy
```
public void undeploy(String aSpringContainerId)
              throws Exception
```
    Description copied from interface: UimaAsynchronousEngine
    
    Undeploys specified UIMA AS container and all services running within it. Each UIMA AS container has a unique id assigned to it during the deploy phase. This method is synchronous and will block until the container (and all services contained within it) is destroyed.
    
    Specified by:
    
    undeploy in interface UimaAsynchronousEngine
    
    Parameters:
    aSpringContainerId - - an id of the container to be destroyed.
    
    Throws:
    
    Exception
  - undeploy
```
public void undeploy(String aSpringContainerId,
            int stop_level)
              throws Exception
```
    Undeploys Spring container with a given container Id. All deployed Spring containers are registered in the local registry under a unique id.
    
    Specified by:
    
    undeploy in interface UimaAsynchronousEngine
    
    Parameters:
    aSpringContainerId - - an id of the container to be destroyed.
    
    Throws:
    
    Exception
  - deploySpringContainer
```
protected String deploySpringContainer(String[] springContextFiles)
                                throws org.apache.uima.resource.ResourceInitializationException
```
    Deploys provided context files ( and beans) in a new Spring container.
    
    Specified by:
    
    deploySpringContainer in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - waitForServiceNotification
```
protected void waitForServiceNotification()
                                   throws Exception
```
    Throws:
    
    Exception
  - deployEmbeddedBroker
```
protected void deployEmbeddedBroker()
                             throws Exception
```
    Throws:
    
    Exception
  - main
```
public static void main(String[] args)
```
  - setReleaseCASMessage
```
public void setReleaseCASMessage(javax.jms.TextMessage msg,
                        String aCasReferenceId)
                          throws Exception
```
    Overrides:
    
    setReleaseCASMessage in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    Exception
  - notifyOnInitializationFailure
```
public void notifyOnInitializationFailure(Exception e)
```
    Specified by:
    
    notifyOnInitializationFailure in interface ControllerCallbackListener
  - notifyOnInitializationSuccess
```
public void notifyOnInitializationSuccess()
```
    Specified by:
    
    notifyOnInitializationSuccess in interface ControllerCallbackListener
  - notifyOnInitializationFailure
```
public void notifyOnInitializationFailure(AnalysisEngineController aController,
                                 Exception e)
```
    Specified by:
    
    notifyOnInitializationFailure in interface ControllerCallbackListener
  - notifyOnInitializationSuccess
```
public void notifyOnInitializationSuccess(AnalysisEngineController aController)
```
    Specified by:
    
    notifyOnInitializationSuccess in interface ControllerCallbackListener
  - notifyOnTermination
```
public void notifyOnTermination(String aServiceName)
```
    Specified by:
    
    notifyOnTermination in interface ControllerCallbackListener
  - notifyOnTermination
```
public void notifyOnTermination(String aServiceName,
                       String aCasReferenceId,
                       Exception cause)
```
  - getMessageProducer
```
protected javax.jms.MessageProducer getMessageProducer(javax.jms.Destination destination)
                                                throws Exception
```
    Overrides:
    
    getMessageProducer in class BaseUIMAAsynchronousEngineCommon_impl
    
    Throws:
    
    Exception
  - stopProducingCases
```
public void stopProducingCases()
```
    Request Uima AS client to initiate sending Stop requests to a service for all outstanding CASes awaiting reply.
    
    Specified by:
    
    stopProducingCases in interface UimaAsynchronousEngine
  - stopProducingCases
```
public void stopProducingCases(String aCasReferenceId)
```
    Request Uima AS client to initiate sending Stop request to a service for a given CAS id If the service is a Cas Multiplier, it will stop producing new CASes, will wait until all child CASes finish and finally returns the input CAS.
    
    Specified by:
    
    stopProducingCases in interface UimaAsynchronousEngine
  - getDispatcher
```
protected MessageSender getDispatcher()
```
    Specified by:
    
    getDispatcher in class BaseUIMAAsynchronousEngineCommon_impl
  - notifyOnReconnecting
```
public void notifyOnReconnecting(String aMessage)
```
    Specified by:
    
    notifyOnReconnecting in interface ControllerCallbackListener
  - notifyOnReconnectionSuccess
```
public void notifyOnReconnectionSuccess()
```
    Specified by:
    
    notifyOnReconnectionSuccess in interface ControllerCallbackListener

Class BaseUIMAAsynchronousEngine_impl

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.uima.adapter.jms.client.BaseUIMAAsynchronousEngineCommon_impl

Field Summary

Fields inherited from class org.apache.uima.adapter.jms.client.BaseUIMAAsynchronousEngineCommon_impl

Fields inherited from interface org.apache.uima.aae.client.UimaAsynchronousEngine

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.adapter.jms.client.BaseUIMAAsynchronousEngineCommon_impl

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.uima.aae.client.UimaAsynchronousEngine

Methods inherited from interface javax.jms.MessageListener

Field Detail

sharedConnectionSemaphore

jndiContext

Constructor Detail

BaseUIMAAsynchronousEngine_impl

Method Detail

createTextMessage

createBytesMessage

cleanup

getEndPointName

setMetaRequestMessage

setCASMessage

setCASMessage

setCASMessage

setCommonProperties

stop

setCPCMessage

createSharedConnection

getSession

getSession

lookupProducerForEndpoint

initializeProducer

initializeProducer

initializeConsumer

initializeConsumer

initialize

deploy

deploy

undeploy

undeploy

undeploy

deploySpringContainer

waitForServiceNotification

deployEmbeddedBroker

main

setReleaseCASMessage

notifyOnInitializationFailure

notifyOnInitializationSuccess

notifyOnInitializationFailure

notifyOnInitializationSuccess

notifyOnTermination

notifyOnTermination

getMessageProducer

stopProducingCases

stopProducingCases

getDispatcher

notifyOnReconnecting

notifyOnReconnectionSuccess