org.apache.uima.collection.impl.cpm.container.deployer.socket

Interface SocketTransport

All Known Implementing Classes:

OFSocketTransportImpl

public interface SocketTransport

The Interface SocketTransport.

Method Summary

Modifier and Type	Method and Description
Socket	connect(URL aURI, long aTimeout) Creates a socket connection to a given endpoint.
String	getName() Returns transport identifier.
org.apache.uima.resource.metadata.ProcessingResourceMetaData	getProcessingResourceMetaData(Socket aSocket) Returns metadata associated with the fenced CasProcessor.
org.apache.uima.cas.CAS	process(Socket aSocket, org.apache.uima.cas.CAS aCas) Invokes fenced CasProcessor.

Method Detail

getName

String getName()

Returns transport identifier.

Returns:

- String uniquely identifying the transport.

connect

Socket connect(URL aURI,
               long aTimeout)
        throws SocketException

Creates a socket connection to a given endpoint. This method blocks until all Connections are resolved or an error occurs.

Parameters:

aURI - URI containing service endpoint info: host & port

aTimeout - max time in millis to wait for response

Returns:

Socket bound to a given endpoint

Throws:

SocketException - Failed to connect

process

org.apache.uima.cas.CAS process(Socket aSocket,
                                org.apache.uima.cas.CAS aCas)
                         throws SocketTimeoutException,
                                SocketException,
                                org.apache.uima.analysis_engine.AnalysisEngineProcessException

Invokes fenced CasProcessor.

Parameters:

aSocket - - Socket bound to fenced CasProcessor

aCas - - CAS to be sent to the CasProcessor for analysis

Returns:

- CAS - CAS returned from the fenced CasProcessor

Throws:

SocketTimeoutException - the socket timeout exception

SocketException - the socket exception

org.apache.uima.analysis_engine.AnalysisEngineProcessException - the analysis engine process exception

getProcessingResourceMetaData

org.apache.uima.resource.metadata.ProcessingResourceMetaData getProcessingResourceMetaData(Socket aSocket)
                                                                                    throws SocketException,
                                                                                           org.apache.uima.analysis_engine.AnalysisEngineProcessException

Returns metadata associated with the fenced CasProcessor.

Parameters:

aSocket - - socket to the fenced CasProcessor

Returns:

- metadata

Throws:

SocketException - passthru

org.apache.uima.analysis_engine.AnalysisEngineProcessException - passthru