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

Interface SocketTransport

All Known Implementing Classes:

OFSocketTransportImpl

public 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
ProcessingResourceMetaData	getProcessingResourceMetaData(Socket aSocket) Returns metadata associated with the fenced CasProcessor
CAS	process(Socket aSocket, 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

CAS process(Socket aSocket,
            CAS aCas)
     throws SocketTimeoutException,
            SocketException,
            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 - - Socket timesout before receiving response from the fenced CasProcessor

SocketException - - connection broken

AnalysisEngineProcessException

getProcessingResourceMetaData

ProcessingResourceMetaData getProcessingResourceMetaData(Socket aSocket)
                                                  throws SocketException,
                                                         AnalysisEngineProcessException

Returns metadata associated with the fenced CasProcessor

Parameters:

aSocket - - socket to the fenced CasProcessor

Returns:

- metadata

Throws:

SocketException - passthru

AnalysisEngineProcessException - passthru