com.centurylink.mdw.workflow.adapter

Class TextAdapterActivity

java.lang.Object

com.centurylink.mdw.services.process.BaseActivity

com.centurylink.mdw.workflow.activity.DefaultActivityImpl

com.centurylink.mdw.workflow.adapter.TextAdapterActivity

All Implemented Interfaces:

ActivityCategory, AdapterActivity, GeneralActivity, AdapterInvocationError, TextAdapter, Category

Direct Known Subclasses:

HttpServiceAdapter, KafkaAdapter, PoolableAdapterBase, SocketAdapter

@Tracked(value=TRACE)
public abstract class TextAdapterActivity
extends DefaultActivityImpl
implements AdapterActivity, AdapterInvocationError, TextAdapter

Adapter activity for services with text-based request/response content.

Field Summary

Fields inherited from class com.centurylink.mdw.services.process.BaseActivity

DISABLED, GROOVY, JAVA_EL, JAVASCRIPT, logger, OUTPUTDOCS

Fields inherited from interface com.centurylink.mdw.activity.types.AdapterActivity

COMPCODE_AUTO_RETRY, DEFAULT_STUBBER_PORT, DEFAULT_STUBBER_TIMEOUT, DO_LOGGING, MAKE_ACTUAL_CALL, PROP_MAX_TRIES, PROP_RETRY_INTERVAL, PROP_SYNCHRONOUS_RESPONSE, PROP_TIMEOUT, REQUEST_VARIABLE, REQUEST_XSD, RESPONSE_VARIABLE, RESPONSE_XSD

Constructor Summary

Constructors

Constructor and Description
TextAdapterActivity()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	canBeAsynchronous()
protected abstract boolean	canBeSynchronous()
Response	directInvoke(java.lang.String request, int timeout, java.util.Map<java.lang.String,java.lang.String> meta_data) This method is used for directly invoke the adapter activity from code, rather than as part of process execution flow.
Response	doInvoke(java.lang.Object connection, Request request, int timeout, java.util.Map<java.lang.String,java.lang.String> headers) This method performs the real invocation of external system service.
protected boolean	doLogging() Determines if external requests/responses should be logged into adapter instance table.
void	execute() Subclasses do not normally override this method.
protected void	executePostScript() Executes a script, after completing the invocation of the system.
protected java.lang.Object	executePreScript(java.lang.Object requestData) Executes a script, before invoking the system.
protected java.lang.String	filterStubResponse(java.lang.String unfiltered, java.lang.Object request) TODO implements this for simulation response
java.lang.String	getAdapterInvocationErrorMessage() This method allows the concrete adapters to define whatever they need for a decent error message.
protected java.lang.String	getAttribute(java.lang.String name, java.lang.String defval, boolean isSmart) Returns the value of attribute.
protected int	getErrorCode(java.lang.Throwable ex)
protected int	getMaxTries() Retrieves the maximum retries allowed for the activity This is only used by activities, not connection pools
protected java.lang.String	getRequestData() The method overrides the one from the super class and perform the followings: It gets the value of the variable with the name specified in the attribute REQUEST_VARIABLE.
protected java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders() Override to return protocol-specific headers to be included on the request.
protected org.json.JSONObject	getRequestMeta()
protected Response	getResponse(java.lang.Object connection, java.lang.String responseString) Override to set protocol response status/message.
protected java.util.Map<java.lang.String,java.lang.String>	getResponseHeaders() Protocol adapter must call setResponseHeaders() with appropriate values extracted from the response.
protected org.json.JSONObject	getResponseMeta()
protected int	getRetryInterval() Retrieves the interval between activity retries This is only used by activities, not connection pools
protected Response	getStubbedResponse(java.lang.String requestData)
protected AdapterStubRequest	getStubRequest(java.lang.String requestContent)
protected java.lang.String	getStubResponse(java.lang.String requestData) Deprecated. Use getStubbedResponse
protected int	getTimeoutForResponse() Timeout value for waiting for responses.
protected void	handleConnectionException(int errorCode, java.lang.Throwable originalCause) Typically you should not override this method.
protected void	handleException(java.lang.Throwable errorCause) The method is used to handle the exception thrown from the execute method.
protected void	handleRetry(int errorCode, java.lang.Throwable originalCause) Added so retry in executed for certain exceptions.
protected boolean	hasPostScript() Checks if the adapter is configured with a post script.
protected boolean	hasPreScript() Checks if the adapter is configured with a pre script.
boolean	isRetryable(java.lang.Throwable ex) Default behavior returns true if Throwable is included in RETRY_EXCEPTIONS attribute (if declared).
protected boolean	isStubMode()
boolean	isSynchronous() The method is used to determine if the current usage is synchronous (waiting for response) or not.
protected java.lang.Long	logRequest(Request request)
protected java.lang.Long	logRequest(java.lang.String message) Deprecated.
protected java.lang.Long	logResponse(Response response) Populates response into document and document_content table
protected java.lang.Long	logResponse(java.lang.String message) Deprecated.
java.lang.String	onFailure(java.lang.Throwable errorCause) The method is invoked on the failure of each try.
void	onSuccess(java.lang.String response) The method is invoked when the external system interaction is a success.
void	populateResponseVariable(java.lang.String response)
protected void	setResponseHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Methods inherited from class com.centurylink.mdw.workflow.activity.DefaultActivityImpl

execute

Methods inherited from class com.centurylink.mdw.services.process.BaseActivity

createDocument, createDocument, createDocument, createDocument, evaluateExpression, executeScript, getActivityId, getActivityInstance, getActivityInstanceId, getActivityName, getAttribute, getAttribute, getAttribute, getAttribute, getAttributes, getAttributeValue, getAttributeValueSmart, getDocument, getDocumentContent, getDocumentForUpdate, getDocumentType, getEngine, getExternalEventInstanceDetails, getLogger, getMainProcessDefinition, getMasterRequestId, getOutputDocuments, getPackage, getParameterId, getParameters, getParameterStringValue, getParameterType, getParameterValue, getPerformanceLevel, getProcessDefinition, getProcessId, getProcessInstance, getProcessInstanceId, getProcessInstanceOwner, getProcessInstanceOwnerId, getProperty, getRequiredAttribute, getRequiredVariableValue, getReturnCode, getReturnMessage, getRuntimeContext, getScriptEvaluator, getScriptExecClassName, getScriptExecutor, getValue, getValues, getValueSmart, getVariableInstance, getVariableValue, getVariableValueSmart, getWorkTransitionInstanceId, initialize, isDisabled, isLogDebugEnabled, isLogInfoEnabled, isOutputDocument, lockActivityInstance, lockProcessInstance, logdebug, logDebug, logError, logError, logexception, loginfo, logInfo, logsevere, logwarn, logWarn, prepare, setOutputDocuments, setParameterValue, setParameterValueAsDocument, setParameterValues, setProcessInstanceCompletionCode, setReturnCode, setReturnMessage, setValue, setVariableValue, setVariableValue, startTransaction, stopTransaction, translatePlaceHolder, updateDocumentContent, updateDocumentInfo, updateDocumentInfo, valueIsJavaExpression, valueIsVariable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.centurylink.mdw.activity.types.GeneralActivity

execute

Methods inherited from interface com.centurylink.mdw.adapter.TextAdapter

closeConnection, init, invoke, openConnection

Constructor Detail

TextAdapterActivity

public TextAdapterActivity()

Method Detail

getTimeoutForResponse

protected int getTimeoutForResponse()

Timeout value for waiting for responses. Used for synchronous mode only. The default method reads from the attribute "timeout", and return -1 seconds if the attribute is not defined, and the default value to be used is

Returns:

timeout value in seconds

canBeSynchronous

protected abstract boolean canBeSynchronous()

canBeAsynchronous

protected abstract boolean canBeAsynchronous()

getRequestData

protected java.lang.String getRequestData()
                                   throws ActivityException

The method overrides the one from the super class and perform the followings:

• It gets the value of the variable with the name specified in the attribute REQUEST_VARIABLE. The value is typically an XML document or a string
• It invokes the variable translator to convert the value into a string and then return the string value.

The method will through exception if the variable is not bound, or the value is not bound to a DocumentReference or String.

Throws:

ActivityException

isSynchronous

public boolean isSynchronous()

The method is used to determine if the current usage is synchronous (waiting for response) or not. The method is used only when both canBeSynchronous() and canBeAsynchronous() are true

Specified by:

isSynchronous in interface AdapterActivity

Returns:

true if it needs to wait for responses

onSuccess

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

The method is invoked when the external system interaction is a success. (i.e. the external system responded something, even an error code). The method may convert external-system-detected errors into failure by throwing an exception here. Throwing an exception here also triggers the method onFailure to be called. This method is also the place to translate external responses into internal format and persist them somewhere, if these are needed. For asynchronous and certified messages, you should not attempt to override this method. The default method does nothing if the response is null or empty, or set the response to the variable specified in RESPONSE_VARIABLE attribute.

Specified by:

onSuccess in interface TextAdapter

Parameters:

response - response message from the external system

Throws:

ConnectionException - this exception indicates a system connection failure (most likely between the direct interfacing system to down stream systems, as direct connection failure will not some to this method). The exception is auto-retriable.

AdapterException - thrown when the external system responded but the response needs to be handled as a non-auto-retriable error.

ActivityException - thrown when the post processing logic hits an exception that needs to fail the activity. This error is not auto-retriable, either.

populateResponseVariable

public void populateResponseVariable(java.lang.String response)
                              throws ActivityException

Throws:

ActivityException

onFailure

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

The method is invoked on the failure of each try. The outcome of the method must be one of the following: a) throw ConnectionException. The engine will put the activity in error status, and schedule automatically retry of the activity b) throw AdapterException. The engine will put the activity in error status, and transition based on ERROR event (typically lead to exception handler) c) return a completion code w/o throwing exception. The engine will complete the activity and transition accordingly The default implementation does the the following - if errorCause is an AdapterException, throws it. - if errorCause is a ConnectionException, throws it. - in any other case, throw an AdapterException wrapping the original exception If you override this method, you typically should re-throw ConnectionException, so that the internal retry mechanism will not be impacted. More specifically, the following are some special scenarios that you may need to know: - If the maximum number of retries has been reached, errorCause is an AdapterException with error code AdapterException.EXCEED_MAXTRIES. Original ConnectionException is its cause. If you do not want to put the activity in error status and invoke exception handler, rather would like to handle the logic within process definition, then return a completion code without re-throwing the exception. - If the activity is a ConnectionPoolAdapter and all connections are used in a connection pool, errorCause is a ConnectionException with error code ConnectionException.POOL_EXHAUSTED. You typically should just re-throw this exception so the engine will put activity in waiting status and will resume after a connection becomes available. - If the activity is a ConnectionPoolAdapter and the connection pool is disabled (manually or automatically shut down), errorCause is a ConnectionException with error code ConnectionException.POOL_DISABLED. You typically should just re-throw this exception so the engine will put activity in waiting status, and will resume after the pool is enabled.

Specified by:

onFailure in interface TextAdapter

Parameters:

errorCause - the exception received

Returns:

the completion code for the activity, if no exception is thrown

Throws:

AdapterException - when no retry is expected

ConnectionException - when retry is expected

getMaxTries

protected int getMaxTries()
                   throws ActivityException

Retrieves the maximum retries allowed for the activity This is only used by activities, not connection pools

Returns:

Throws:

ActivityException

getRetryInterval

protected int getRetryInterval()
                        throws ActivityException

Retrieves the interval between activity retries This is only used by activities, not connection pools

Returns:

Throws:

ActivityException

execute

public void execute()
             throws ActivityException

Subclasses do not normally override this method. If you do override this method, you have to include call to this super method. The method (directly or indirectly) invokes other abstract or overridable methods to perform the execution of the activity. The primary method to implement are openConnection(), invoke() and closeConnection() Notes: pollable adapter assumes request data is always string

Specified by:

execute in interface GeneralActivity

Overrides:

execute in class DefaultActivityImpl

Throws:

ActivityException

getStubRequest

protected AdapterStubRequest getStubRequest(java.lang.String requestContent)
                                     throws AdapterException

Throws:

AdapterException

getErrorCode

protected int getErrorCode(java.lang.Throwable ex)

handleRetry

protected void handleRetry(int errorCode,
                           java.lang.Throwable originalCause)
                    throws ActivityException

Added so retry in executed for certain exceptions.

Parameters:

errorCode -

Throws:

ActivityException

handleConnectionException

protected void handleConnectionException(int errorCode,
                                         java.lang.Throwable originalCause)
                                  throws ActivityException

Typically you should not override this method. ConnectionPoolAdapter does override this with internal MDW logic.

Parameters:

errorCode -

Throws:

ActivityException

handleException

protected void handleException(java.lang.Throwable errorCause)
                        throws ActivityException

The method is used to handle the exception thrown from the execute method. Converts ConnectionException to AdapterException or throw AdapterException when retry enabled and when exceeding max number of retries. Otherwise handles retry.

Parameters:

errorCause - the exception captured

Throws:

ActivityException

isRetryable

public boolean isRetryable(java.lang.Throwable ex)

Default behavior returns true if Throwable is included in RETRY_EXCEPTIONS attribute (if declared). If this attribute is not declared, any IOExceptions are considered retryable.

doLogging

protected boolean doLogging()

Determines if external requests/responses should be logged into adapter instance table. The default method reads the attribute value DO_LOGGING. If the attribute is missing, the default is on for logging. You may need to override externalRequestToString and externalResponseToString in order to log the information properly.

Returns:

whether logging is on or off

logRequest

protected java.lang.Long logRequest(Request request)

logRequest

@Deprecated
protected java.lang.Long logRequest(java.lang.String message)

Deprecated.

logResponse

protected java.lang.Long logResponse(Response response)

Populates response into document and document_content table

Returns:

documentId

logResponse

@Deprecated
protected java.lang.Long logResponse(java.lang.String message)

Deprecated.

getRequestMeta

protected org.json.JSONObject getRequestMeta()
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getResponseMeta

protected org.json.JSONObject getResponseMeta()
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isStubMode

protected boolean isStubMode()

filterStubResponse

protected java.lang.String filterStubResponse(java.lang.String unfiltered,
                                              java.lang.Object request)

TODO implements this for simulation response

Parameters:

unfiltered -

request -

Returns:

getStubbedResponse

protected Response getStubbedResponse(java.lang.String requestData)

getStubResponse

@Deprecated
protected java.lang.String getStubResponse(java.lang.String requestData)

Deprecated. Use getStubbedResponse

directInvoke

public Response directInvoke(java.lang.String request,
                             int timeout,
                             java.util.Map<java.lang.String,java.lang.String> meta_data)
                      throws AdapterException,
                             ConnectionException

This method is used for directly invoke the adapter activity from code, rather than as part of process execution flow. If logging is desired, extenders should override logMessage().

Parameters:

request - request message

timeout - value for waiting for responses.

meta_data -

Returns:

response message

Throws:

AdapterException

ConnectionException

getAttribute

protected java.lang.String getAttribute(java.lang.String name,
                                        java.lang.String defval,
                                        boolean isSmart)
                                 throws AdapterException

Returns the value of attribute.

Returns:

the value of the attribute, or null if the attribute does not exist

Throws:

AdapterException

hasPreScript

protected boolean hasPreScript()

Checks if the adapter is configured with a pre script.

Returns:

true if adapter has a pre script, (false otherwise).

executePreScript

protected java.lang.Object executePreScript(java.lang.Object requestData)
                                     throws ActivityException

Executes a script, before invoking the system.

Parameters:

requestData - incoming request data.

Returns:

retObj if script returns a value, (requestData otherwise).

Throws:

ActivityException

hasPostScript

protected boolean hasPostScript()

Checks if the adapter is configured with a post script.

Returns:

true if adapter has a post script, (false otherwise).

executePostScript

protected void executePostScript()
                          throws ActivityException

Executes a script, after completing the invocation of the system. If script returns a value, return code will be set (null otherwise).

Throws:

ActivityException

doInvoke

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

This method performs the real invocation of external system service.

Specified by:

doInvoke in interface TextAdapter

Parameters:

connection -

request -

headers -

Returns:

response if the adapter is synchronous, or the underlying protocol is synchronous. Return null if the adapter is asynchronous and the underlying protocol is asynchronous

Throws:

AdapterException - Adapter exception may or may not be retriable, which you can set in the exception itself. Default is not retriable.

ConnectionException - certain protocol may also throw ConnectionException here. ConnectionException can be retried.

getResponse

protected Response getResponse(java.lang.Object connection,
                               java.lang.String responseString)
                        throws java.io.IOException

Override to set protocol response status/message.

Throws:

java.io.IOException

getRequestHeaders

protected java.util.Map<java.lang.String,java.lang.String> getRequestHeaders()

Override to return protocol-specific headers to be included on the request. Protocol adapter must have logic to make use of these values.

getResponseHeaders

protected java.util.Map<java.lang.String,java.lang.String> getResponseHeaders()

Protocol adapter must call setResponseHeaders() with appropriate values extracted from the response.

setResponseHeaders

protected void setResponseHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

getAdapterInvocationErrorMessage

public java.lang.String getAdapterInvocationErrorMessage()

This method allows the concrete adapters to define whatever they need for a decent error message. For instance they can include endpoint urls etc

Specified by:

getAdapterInvocationErrorMessage in interface AdapterInvocationError

Returns:

a default error of "Adapter invocation exception"