com.centurylink.mdw.workflow.adapter.rest

Class MultiRestServiceAdapter

java.lang.Object

com.centurylink.mdw.services.process.BaseActivity

com.centurylink.mdw.workflow.activity.DefaultActivityImpl

com.centurylink.mdw.workflow.adapter.TextAdapterActivity

com.centurylink.mdw.workflow.adapter.http.HttpServiceAdapter

com.centurylink.mdw.workflow.adapter.rest.RestServiceAdapter

com.centurylink.mdw.workflow.adapter.rest.MultiRestServiceAdapter

All Implemented Interfaces:

ActivityCategory, AdapterActivity, GeneralActivity, AdapterInvocationError, HeaderAwareAdapter, TextAdapter, Category

Direct Known Subclasses:

PublishEventMessageRest

@Tracked(value=TRACE)
 @Activity(value="Multi-REST Service Adapter",
          category=AdapterActivity.class,
          icon="com.centurylink.mdw.base/adapter.png",
          pagelet="com.centurylink.mdw.base/multiRest.pagelet")
public class MultiRestServiceAdapter
extends RestServiceAdapter

Field Summary

Fields inherited from class com.centurylink.mdw.workflow.adapter.rest.RestServiceAdapter

AUTH_APP_ID, AUTH_PASSWORD, AUTH_PROVIDER, AUTH_USER, ENDPOINT_URI, HEADERS_VARIABLE, HTTP_METHOD, REQUEST_VARIABLE

Fields inherited from class com.centurylink.mdw.workflow.adapter.http.HttpServiceAdapter

CONNECT_TIMEOUT, DEFAULT_ERROR_HTTP_CODE, DEFAULT_RETRY_HTTP_CODE, ERROR_HTTP_CODES, PROP_PASS, PROP_USER, READ_TIMEOUT, RETRY_HTTP_CODES

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_XSD, RESPONSE_VARIABLE, RESPONSE_XSD

Constructor Summary

Constructors

Constructor and Description
MultiRestServiceAdapter()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.Object>	getConnectionObjs()
protected java.util.List<java.lang.String>	getEndpointUris() Returns the endpoint URLs for the RESTful service.
java.lang.String	invoke(java.lang.Object conn, java.lang.String request, int timeout, java.util.Map<java.lang.String,java.lang.String> headers) Invokes the RESTful service by submitting an HTTP requests against the configured endpoint URIs.
java.lang.Object	openConnection() Open connection
java.lang.Object	openConnection(java.lang.String endpointUri) Returns an HttpConnection based on the configured endpoint, which includes the resource path.

Methods inherited from class com.centurylink.mdw.workflow.adapter.rest.RestServiceAdapter

getAdapterInvocationErrorMessage, getAuthProvider, getEndpointUri, getHttpHelper, getHttpMethod, getRequestData, getRequestHeaders, getRequestMeta, getRequestParameters, getResponseHeaders, getResponseMeta, getStubRequest, getUrlEncoding, invoke, logRequest, openConnection, openConnection, performHttpAction, setResponseHeaders

Methods inherited from class com.centurylink.mdw.workflow.adapter.http.HttpServiceAdapter

canBeAsynchronous, canBeSynchronous, closeConnection, getConnectTimeout, getReadTimeout, getResponse, init, setRequestHeaders

Methods inherited from class com.centurylink.mdw.workflow.adapter.TextAdapterActivity

directInvoke, doInvoke, doLogging, execute, executePostScript, executePreScript, filterStubResponse, getAttribute, getErrorCode, getMaxTries, getRetryInterval, getStubbedResponse, getStubResponse, getTimeoutForResponse, handleConnectionException, handleException, handleRetry, hasPostScript, hasPreScript, isRetryable, isStubMode, isSynchronous, logRequest, logResponse, logResponse, onFailure, onSuccess, populateResponseVariable

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

Constructor Detail

MultiRestServiceAdapter

public MultiRestServiceAdapter()

Method Detail

openConnection

public java.lang.Object openConnection()

Description copied from interface: TextAdapter

Open connection

Specified by:

openConnection in interface TextAdapter

Overrides:

openConnection in class RestServiceAdapter

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().

openConnection

public java.lang.Object openConnection(java.lang.String endpointUri)
                                throws ConnectionException

Returns an HttpConnection based on the configured endpoint, which includes the resource path. Override for HTTPS or other connection type.

Throws:

ConnectionException

getConnectionObjs

protected java.util.List<java.lang.Object> getConnectionObjs()
                                                      throws ConnectionException,
                                                             AdapterException

Throws:

ConnectionException

AdapterException

getEndpointUris

protected java.util.List<java.lang.String> getEndpointUris()
                                                    throws AdapterException

Returns the endpoint URLs for the RESTful service. Supports property specifiers via the syntax for BaseActivity.getAttribute(String).

Throws:

ActivityException

AdapterException

invoke

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

Invokes the RESTful service by submitting an HTTP requests against the configured endpoint URIs. Override getRequestData() to provide the requestData value (usually a String). TODO: use JSON instead of XML aggregate.

Specified by:

invoke in interface TextAdapter

Overrides:

invoke in class RestServiceAdapter

Parameters:

conn - 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:

ConnectionException

AdapterException

See Also:

TextAdapter.invoke(java.lang.Object, java.lang.String, int, java.util.Map)