Class VinciTAP
java.lang.Object
org.apache.uima.collection.impl.cpm.container.deployer.VinciTAP
Vinci Proxy to remote Cas Processor vinci service. This component is used for both local(
managed) and remote ( unmanaged) Cas Processors. Its main purpose is to invoke remote APIs on Cas
Processors running as vinci services. It serializes data contained in the Cas into XCAS and sends
it to the service. It desiralizes data from XCAS returned from the service back into the Cas.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate BaseClient
The conn.private String
The content tag.private String
The fenced process PID.private String[]
The keys 2 drop.private String
The service host.private String
The service name.private String
The service port.private int
The timeout.private long
The total annotation time.private long
The total cas to frame time.private long
The total de serialize time.private long
The total frame to cas time.private long
The total round trip time.private long
The total serialize time.private UimaTimer
The uima timer.private VinciCasDataConverter
The vinci cas data converter.private String
The vns host.private String
The vns port. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic CasData
addKeysToDataCas
(CasData dataCas, AFrame aFrame) Appends keys (types) from XCAS to provided CasData instance doing conversions of ':' in WF keys to '_colon_' and '-' to '_dash_' to enforce UIMA compliance.CasData[]
analyze
(CasData[] aCasList, ProcessTrace aPT, String aResourceName) Main routine that sends requests to remote vinci services.analyze
(CasData aCas, ProcessTrace aPT, String aResourceName) Performs Analysis of the CAS by the remote vinci service Cas Processor.void
Let the remote service now that end of batch marker has been reached, the notification is one-way meaning the CPE does not expect anything back from the service.void
Notify the remote service that the CPE reached end of processing.void
Connects to external service using service name as a way to locate it.void
Connects the proxy to Cas Processor running as a vinci service on a given host and port number.private void
dropNamedTypes
(AFrame aKeyFrame, String[] aDropKeyList) Drop named types.private static void
dumpFeatures
(CasData aCAS) Prints to stdout contents of a given CasData instance.Returns Cas Processor metadata as it is returned from the remote Cas Processor running as vinci service.private FeatureStructure
getDocTextFeatureStructure
(CasData aCasData) Gets the CasData FeatureStructure representing the document text, if any.Returns host where the service is running.int
Returns port of the service this proxy is connected to.Returns VNS Host.Returns VNS Port.boolean
Returns status of the vinci connection.private static boolean
Returns true if a given feature represents any of the content (SoFa) types.private void
produceXCASRequestFrame
(CasData aCasData, AFrame dataFrame, String[] aDropKeyList) Produces XCas from a given Cas.sendAndReceive
(AFrame aFrame) Send a given Vinci Frame to the remote vinci service and return result.void
setContentTag
(String aContentTag) Defines subject of analysis.void
setKeys2Drop
(String[] aKeys2Drop) Defines types as array that will not be sent to the Cas Processor service.void
setTimeout
(int aTimeout) Define the max time in millis the proxy will wait for response from remote service.void
Defines a custom timer to use for stats.void
setVNSHost
(String aVNSHost) Sets the VNS host this proxy will use to locate service.void
setVNSPort
(String aVNSPort) Sets the VNS port this proxy will use to locate service.boolean
shutdown
(boolean shutdownService, boolean aDoSendNotification) Conditionally sends the shutdown request to managed (local) vinci service.private void
Test and reconnect.private void
Waits for local/managed service to shutdown.
-
Field Details
-
serviceHost
The service host. -
servicePort
The service port. -
fencedProcessPID
The fenced process PID. -
vnsHost
The vns host. -
vnsPort
The vns port. -
serviceName
The service name. -
conn
The conn. -
timeout
private int timeoutThe timeout. -
totalCasToFrameTime
private long totalCasToFrameTimeThe total cas to frame time. -
totalAnnotationTime
private long totalAnnotationTimeThe total annotation time. -
totalFrameToCasTime
private long totalFrameToCasTimeThe total frame to cas time. -
totalSerializeTime
private long totalSerializeTimeThe total serialize time. -
totalDeSerializeTime
private long totalDeSerializeTimeThe total de serialize time. -
totalRoundTripTime
private long totalRoundTripTimeThe total round trip time. -
uimaTimer
The uima timer. -
contentTag
The content tag. -
keys2Drop
The keys 2 drop. -
vinciCasDataConverter
The vinci cas data converter.
-
-
Constructor Details
-
VinciTAP
public VinciTAP()Instantiates a new vinci TAP.
-
-
Method Details
-
setContentTag
Defines subject of analysis.- Parameters:
aContentTag
- - subject of analysis
-
setTimer
Defines a custom timer to use for stats.- Parameters:
aTimer
- - custom timer
-
setKeys2Drop
Defines types as array that will not be sent to the Cas Processor service.- Parameters:
aKeys2Drop
- - array of types excluded from the request
-
connect
Connects the proxy to Cas Processor running as a vinci service on a given host and port number.- Parameters:
aHost
- - name of the host where the service is runningaPort
- - port number where the service listens for requests- Throws:
ConnectException
- wraps Exception or unable to connect
-
setTimeout
public void setTimeout(int aTimeout) Define the max time in millis the proxy will wait for response from remote service.- Parameters:
aTimeout
- - number of millis to wait
-
connect
Connects to external service using service name as a way to locate it.- Parameters:
aServiceName
- - name of the service- Throws:
ServiceConnectionException
- the service connection exception
-
testAndReconnect
Test and reconnect.- Throws:
ServiceException
- the service exceptionServiceConnectionException
- the service connection exception
-
sendAndReceive
Send a given Vinci Frame to the remote vinci service and return result.- Parameters:
aFrame
- - Vinci Frame containing request- Returns:
- AFrame - Frame containing result
- Throws:
ServiceException
- the service exceptionServiceConnectionException
- the service connection exception
-
addKeysToDataCas
Appends keys (types) from XCAS to provided CasData instance doing conversions of ':' in WF keys to '_colon_' and '-' to '_dash_' to enforce UIMA compliance.- Parameters:
dataCas
- - instance of CasData where the keys will be appendedaFrame
- - source of keys (data)- Returns:
- - modified CasData
- Throws:
Exception
- passthru
-
dumpFeatures
Prints to stdout contents of a given CasData instance.- Parameters:
aCAS
- the a CAS
-
produceXCASRequestFrame
private void produceXCASRequestFrame(CasData aCasData, AFrame dataFrame, String[] aDropKeyList) throws Exception Produces XCas from a given Cas. It selectively copies features from the Cas excluding those types that are defined in a given dropKeyList.- Parameters:
aCasData
- - Cas for which XCAS is builtdataFrame
- - XCas frame for dataaDropKeyList
- - list of types to exclude from XCas- Throws:
Exception
- passthru
-
isText
Returns true if a given feature represents any of the content (SoFa) types.- Parameters:
feature
- - type to check- Returns:
- - true if SoFa, false otherwise
-
analyze
public CasData analyze(CasData aCas, ProcessTrace aPT, String aResourceName) throws ServiceException, ServiceConnectionException Performs Analysis of the CAS by the remote vinci service Cas Processor.- Parameters:
aCas
- - Cas to analayzeaPT
- - performance trace object for stats and totalsaResourceName
- - name of the Cas Processor- Returns:
- - CAS containing results of analysis
- Throws:
ServiceException
- - passthru, wraps ExceptionServiceConnectionException
- passthru
-
dropNamedTypes
Drop named types.- Parameters:
aKeyFrame
- the a key frameaDropKeyList
- the a drop key list
-
analyze
public CasData[] analyze(CasData[] aCasList, ProcessTrace aPT, String aResourceName) throws ServiceException, ServiceConnectionException Main routine that sends requests to remote vinci services. Each Cas in the list is placed in the request frame in its own DATA frame. For each Cas, this routine create a seperate DATA frame. The DATA frame contains types and data that are required by the annotator. For efficiency, the dropKeyList array can be defined with types that will be omitted from the DATA frame. These keys are not required by the annotator thus it is waste of bandwidth to include them in the request.- Parameters:
aCasList
- - a list of Cas to send to service for analysisaPT
- - Process Trace object to aggrate time and statsaResourceName
- - name of the Cas Processor- Returns:
- - List of Cas instances containing results of analysis
- Throws:
ServiceException
- - passthru, wraps ExceptionServiceConnectionException
- passthru
-
getAnalysisEngineMetaData
Returns Cas Processor metadata as it is returned from the remote Cas Processor running as vinci service.- Returns:
- the analysis engine meta data
- Throws:
ResourceServiceException
- the resource service exception
-
batchProcessComplete
Let the remote service now that end of batch marker has been reached, the notification is one-way meaning the CPE does not expect anything back from the service.- Throws:
ResourceServiceException
- the resource service exception
-
collectionProcessComplete
Notify the remote service that the CPE reached end of processing. Wait for response from the service before returning. This ensures that the request is accepted and the desired logic handling end of processing has completed.- Throws:
ResourceServiceException
- wraps Exception
-
shutdown
public boolean shutdown(boolean shutdownService, boolean aDoSendNotification) Conditionally sends the shutdown request to managed (local) vinci service. This routine should not terminate services deployed as remote (unmanaged). This routine does not verify that the service shut itself down. It does not even wait for response. It is up to the service to clean itself up and terminate.- Parameters:
shutdownService
- - flag indicating if a shutdown command should be sent to the serviceaDoSendNotification
- - indicates whether or not to sent CollectionProcessComplete frame to service- Returns:
- - true if shutdown message has been sent without error, false otherwise
-
waitForServiceShutdown
private void waitForServiceShutdown()Waits for local/managed service to shutdown. If we dont allow the service time to cleanly terminate, sometimes it just lingers. Since the shutdown command sent in shuthdown() method is one-way call, it was immediately followed by the connection close. That caused an exception on the service side, preventing it from clean exit. So here we just wait until the connection no longer exists and then close it on this side. -
isConnected
public boolean isConnected()Returns status of the vinci connection.- Returns:
- - true if connection is valid, false otherwise
-
setVNSPort
Sets the VNS port this proxy will use to locate service.- Parameters:
aVNSPort
- - vns port to use
-
setVNSHost
Sets the VNS host this proxy will use to locate service.- Parameters:
aVNSHost
- - name of the VNS host
-
getServicePort
public int getServicePort()Returns port of the service this proxy is connected to.- Returns:
- - service port
-
getServiceHost
Returns host where the service is running.- Returns:
- host name of the machine where the service is running
-
getVNSPort
Returns VNS Port.- Returns:
- VNS port
-
getVNSHost
Returns VNS Host.- Returns:
- VNS Host
-
getDocTextFeatureStructure
Gets the CasData FeatureStructure representing the document text, if any. Currently, this must be one of the first two FSs in the CasData.- Parameters:
aCasData
- CasData containing feature structures- Returns:
- FeatureStructure representing document text, null if none
-