com.centurylink.mdw.workflow.adapter.rest

Class RestServiceAdapter

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MicroserviceRestAdapter, MultiRestServiceAdapter, ServiceNowAdapter

@Tracked(value=TRACE)
 @Activity(value="REST Service Adapter",
          category=AdapterActivity.class,
          icon="com.centurylink.mdw.base/adapter.png",
          pagelet="com.centurylink.mdw.base/restService.pagelet")
public class RestServiceAdapter
extends HttpServiceAdapter
implements HeaderAwareAdapter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTH_APP_ID
static java.lang.String	AUTH_PASSWORD
static java.lang.String	AUTH_PROVIDER
static java.lang.String	AUTH_USER
static java.lang.String	ENDPOINT_URI
static java.lang.String	HEADERS_VARIABLE
static java.lang.String	HTTP_METHOD
static java.lang.String	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
RestServiceAdapter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdapterInvocationErrorMessage() Specific stacktrace error message for RestServiceAdapter to include the endpoint
java.lang.Object	getAuthProvider()
protected java.lang.String	getEndpointUri() Returns the endpoint URL for the RESTful service.
HttpHelper	getHttpHelper(java.lang.Object connection) Allows the overriding of this method without overriding invoke()
protected java.lang.String	getHttpMethod()
protected java.lang.String	getRequestData() The method overrides the one from the super class and does the following: For HTTP GET and DELETE requests, it returns an empty string Otherwise it gets the value of the variable with the name specified in the attribute REQUEST_VARIABLE.
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders() Override to specify HTTP request headers.
protected org.json.JSONObject	getRequestMeta()
protected java.util.Map<java.lang.String,java.lang.String>	getRequestParameters() Override to specify URL request parameters.
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 AdapterStubRequest	getStubRequest(java.lang.String requestContent)
protected java.lang.String	getUrlEncoding()
java.lang.Object	invoke(java.lang.Object pConnection, java.lang.Object requestData, java.util.Map<java.lang.String,java.lang.String> requestHeaders)
java.lang.String	invoke(java.lang.Object inConn, java.lang.String request, int timeout, java.util.Map<java.lang.String,java.lang.String> headers) Invokes the RESTful service by submitting an HTTP request against the configured endpoint URI.
protected java.lang.Long	logRequest(Request request)
java.lang.Object	openConnection() Open connection
java.lang.Object	openConnection(java.lang.String proxyHost, int proxyPort)
java.lang.Object	openConnection(java.lang.String proxyHost, int proxyPort, java.net.Proxy.Type proxyType) Returns an HttpConnection based on the configured endpoint, which includes the resource path.
protected java.lang.String	performHttpAction(HttpHelper httpHelper, java.lang.String request)
protected void	setResponseHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

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

Field Detail

HTTP_METHOD

public static final java.lang.String HTTP_METHOD

See Also:

Constant Field Values

ENDPOINT_URI

public static final java.lang.String ENDPOINT_URI

See Also:

Constant Field Values

HEADERS_VARIABLE

public static final java.lang.String HEADERS_VARIABLE

See Also:

Constant Field Values

AUTH_PROVIDER

public static final java.lang.String AUTH_PROVIDER

See Also:

Constant Field Values

AUTH_APP_ID

public static final java.lang.String AUTH_APP_ID

See Also:

Constant Field Values

AUTH_USER

public static final java.lang.String AUTH_USER

See Also:

Constant Field Values

AUTH_PASSWORD

public static final java.lang.String AUTH_PASSWORD

See Also:

Constant Field Values

REQUEST_VARIABLE

public static final java.lang.String REQUEST_VARIABLE

See Also:

Constant Field Values

Constructor Detail

RestServiceAdapter

public RestServiceAdapter()

Method Detail

openConnection

public java.lang.Object openConnection()
                                throws ConnectionException

Description copied from interface: TextAdapter

Open connection

Specified by:

openConnection in interface TextAdapter

Overrides:

openConnection in class HttpServiceAdapter

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

openConnection

public java.lang.Object openConnection(java.lang.String proxyHost,
                                       int proxyPort)
                                throws ConnectionException

Throws:

ConnectionException

openConnection

public java.lang.Object openConnection(java.lang.String proxyHost,
                                       int proxyPort,
                                       java.net.Proxy.Type proxyType)
                                throws ConnectionException

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

Throws:

ConnectionException

getHttpHelper

public HttpHelper getHttpHelper(java.lang.Object connection)
                         throws ActivityException

Description copied from class: HttpServiceAdapter

Allows the overriding of this method without overriding invoke()

Overrides:

getHttpHelper in class HttpServiceAdapter

Returns:

an HttpHelper instance

Throws:

ActivityException

getAuthProvider

public java.lang.Object getAuthProvider()
                                 throws ActivityException

Throws:

ActivityException

getRequestParameters

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

Override to specify URL request parameters.

getUrlEncoding

protected java.lang.String getUrlEncoding()

getEndpointUri

protected java.lang.String getEndpointUri()
                                   throws PropertyException

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

Throws:

PropertyException

invoke

public java.lang.String invoke(java.lang.Object inConn,
                               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 request against the configured endpoint URI. Override getRequestData() to provide the requestData value (usually a String).

Specified by:

invoke in interface TextAdapter

Overrides:

invoke in class HttpServiceAdapter

Parameters:

inConn - 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)

performHttpAction

protected java.lang.String performHttpAction(HttpHelper httpHelper,
                                             java.lang.String request)
                                      throws ActivityException,
                                             java.io.IOException,
                                             AdapterException

Throws:

ActivityException

java.io.IOException

AdapterException

getRequestData

protected java.lang.String getRequestData()
                                   throws ActivityException

The method overrides the one from the super class and does the following:

• For HTTP GET and DELETE requests, it returns an empty string
• Otherwise 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 returns the string value.

For HTTP methods other than GET and DELETE this will throw an exception if the request data variable is not bound, or the value is not a DocumentReference or String.

Overrides:

getRequestData in class TextAdapterActivity

Throws:

ActivityException

getHttpMethod

protected java.lang.String getHttpMethod()
                                  throws ActivityException

Throws:

ActivityException

getRequestHeaders

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

Override to specify HTTP request headers.

Specified by:

getRequestHeaders in interface HeaderAwareAdapter

Overrides:

getRequestHeaders in class HttpServiceAdapter

getResponseHeaders

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

Description copied from class: TextAdapterActivity

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

Specified by:

getResponseHeaders in interface HeaderAwareAdapter

Overrides:

getResponseHeaders in class TextAdapterActivity

setResponseHeaders

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

Overrides:

setResponseHeaders in class TextAdapterActivity

getStubRequest

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

Overrides:

getStubRequest in class TextAdapterActivity

Throws:

AdapterException

invoke

public java.lang.Object invoke(java.lang.Object pConnection,
                               java.lang.Object requestData,
                               java.util.Map<java.lang.String,java.lang.String> requestHeaders)
                        throws AdapterException,
                               ConnectionException

Specified by:

invoke in interface HeaderAwareAdapter

Throws:

AdapterException

ConnectionException

getAdapterInvocationErrorMessage

public java.lang.String getAdapterInvocationErrorMessage()

Specific stacktrace error message for RestServiceAdapter to include the endpoint

Specified by:

getAdapterInvocationErrorMessage in interface AdapterInvocationError

Overrides:

getAdapterInvocationErrorMessage in class TextAdapterActivity

Returns:

a default error of "Adapter invocation exception"

getRequestMeta

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

Overrides:

getRequestMeta in class TextAdapterActivity

Throws:

java.lang.Exception

getResponseMeta

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

Overrides:

getResponseMeta in class TextAdapterActivity

Throws:

java.lang.Exception

logRequest

protected java.lang.Long logRequest(Request request)

Overrides:

logRequest in class TextAdapterActivity