com.centurylink.mdw.adapter

Interface TextAdapter

All Known Implementing Classes:

DocumentWebServiceAdapter, HttpServiceAdapter, KafkaAdapter, MdwRpcWebServiceAdapter, MicroserviceRestAdapter, MultiRestServiceAdapter, PoolableAdapterBase, PublishEventMessageRest, RestServiceAdapter, ServiceNowAdapter, SoapWebServiceAdapter, SocketAdapter, TextAdapterActivity

public interface TextAdapter

Interface for text-based adapter activities.

Method Summary

Modifier and Type	Method and Description
void	closeConnection(java.lang.Object connection) Close a connection opened.
Response	doInvoke(java.lang.Object connection, Request request, int timeout, java.util.Map<java.lang.String,java.lang.String> headers)
void	init() Initialization.
java.lang.String	invoke(java.lang.Object connection, java.lang.String request, int timeout, java.util.Map<java.lang.String,java.lang.String> headers) send a message to external system, and if the underlying protocol is synchronous (WebService, EJB, etc), the response is returned.
java.lang.String	onFailure(java.lang.Throwable errorCause) Handle failure response.
void	onSuccess(java.lang.String response) Handle success response.
java.lang.Object	openConnection() Open connection

Method Detail

init

void init()
   throws ConnectionException,
          AdapterException

Initialization.

Throws:

ConnectionException

AdapterException

openConnection

java.lang.Object openConnection()
                         throws ConnectionException,
                                AdapterException

Open connection

Returns:

An object representing an open connection. It is typical to return the adapter activity instance itself, although any other object (but null) can be returned, which will be parsed in as a parameter to invoke() and closeConnection().

Throws:

ConnectionException - retriable connection failure

AdapterException - non-retriable connection failure

closeConnection

void closeConnection(java.lang.Object connection)

Close a connection opened.

Parameters:

connection - the object returned by openConnection() and is typically the adapter activity instance itself.

invoke

java.lang.String invoke(java.lang.Object connection,
                        java.lang.String request,
                        int timeout,
                        java.util.Map<java.lang.String,java.lang.String> headers)
                 throws AdapterException,
                        ConnectionException

send a message to external system, and if the underlying protocol is synchronous (WebService, EJB, etc), the response is returned. To support auto-retry (may or may not be certified message), the implementation should throws AdapterException when an error is detected and is non-retriable, and throws ConnectionException if hitting a retriable error. When it is used to support certified message, the method should throw exceptions unless a correct acknowledgment is received.

Parameters:

connection - the object returned by openConnection() and is typically the adapter activity instance itself.

request - request content

timeout - time out in seconds. Ignored if no response is expected.

headers - protocol request data, e.g. correlation ID

Returns:

response if the underlying protocol is synchronous or null otherwise

Throws:

AdapterException

ConnectionException

doInvoke

Response doInvoke(java.lang.Object connection,
                  Request request,
                  int timeout,
                  java.util.Map<java.lang.String,java.lang.String> headers)
           throws AdapterException,
                  ConnectionException

Throws:

AdapterException

ConnectionException

onSuccess

void onSuccess(java.lang.String response)
        throws ActivityException,
               ConnectionException,
               AdapterException

Handle success response.

Parameters:

response - response content

Throws:

ActivityException

ConnectionException

AdapterException

onFailure

java.lang.String onFailure(java.lang.Throwable errorCause)
                    throws AdapterException,
                           ConnectionException

Handle failure response.

Parameters:

errorCause - throwable that triggered failure

Returns:

completion code

Throws:

AdapterException

ConnectionException