com.centurylink.mdw.services.request

Class BaseHandler

java.lang.Object

com.centurylink.mdw.services.request.BaseHandler

All Implemented Interfaces:

RequestHandler

Direct Known Subclasses:

ExternalEventHandlerBase, ProcessNotifyHandler, ProcessRunHandler, TestHandler

public abstract class BaseHandler
extends java.lang.Object
implements RequestHandler

Convenient base class for RequestHandlers, with methods for starting and notifying workflow processes.

Nested Class Summary

Nested classes/interfaces inherited from interface com.centurylink.mdw.request.RequestHandler

RequestHandler.Routing

Field Summary

Fields

Modifier and Type	Field and Description
protected static StandardLogger	logger

Constructor Summary

Constructors

Constructor and Description
BaseHandler()

Method Summary

Modifier and Type	Method and Description
protected Response	getErrorResponse(Request request, java.lang.Object message, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.Exception cause) Default implementation returns a status response.
protected Response	getSuccessResponse(Request request, java.lang.Object message, java.util.Map<java.lang.String,java.lang.String> headers) Default implementation returns an acknowledgement response.
protected Response	invokeServiceProcess(java.lang.Long processId, java.lang.Long requestId, java.lang.String masterRequestId, java.lang.String masterRequest, java.util.Map<java.lang.String,java.lang.Object> inputValues, java.util.Map<java.lang.String,java.lang.String> headers) Invoke a service process synchronously.
protected java.lang.Long	launchProcess(java.lang.Long processId, java.lang.Long requestId, java.lang.String masterRequestId, java.util.Map<java.lang.String,java.lang.Object> inputValues, java.util.Map<java.lang.String,java.lang.String> headers) Start a workflow process.
protected java.lang.Integer	notifyProcesses(java.lang.String eventName, java.lang.Long requestId, java.lang.String message, int delay) Notify an in-flight process instance.
protected java.util.Map<java.lang.String,java.lang.String>	translateInputValues(java.lang.Long processId, java.util.Map<java.lang.String,java.lang.Object> values) Converts process input values to Map needed by the runtime engine.

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.request.RequestHandler

getRoles, handleRequest

Field Detail

logger

protected static StandardLogger logger

Constructor Detail

BaseHandler

public BaseHandler()

Method Detail

launchProcess

protected java.lang.Long launchProcess(java.lang.Long processId,
                                       java.lang.Long requestId,
                                       java.lang.String masterRequestId,
                                       java.util.Map<java.lang.String,java.lang.Object> inputValues,
                                       java.util.Map<java.lang.String,java.lang.String> headers)
                                throws ProcessException,
                                       DataAccessException

Start a workflow process.

Parameters:

processId - definition ID of the process

requestId - document ID of the triggering request

masterRequestId - master request ID to be assigned to the process instance

inputValues - input value bindings for the process instance to be created

headers - request headers

Throws:

ProcessException

DataAccessException

invokeServiceProcess

protected Response invokeServiceProcess(java.lang.Long processId,
                                        java.lang.Long requestId,
                                        java.lang.String masterRequestId,
                                        java.lang.String masterRequest,
                                        java.util.Map<java.lang.String,java.lang.Object> inputValues,
                                        java.util.Map<java.lang.String,java.lang.String> headers)
                                 throws ProcessException,
                                        DataAccessException

Invoke a service process synchronously.

Parameters:

processId - definition ID of the process

requestId - document ID of the triggering request

masterRequestId - Master request ID to be assigned to the process instance

inputValues - input value bindings for the process instance to be created

headers - request headers

Returns:

response message, populated with content from the response variable

Throws:

ProcessException

DataAccessException

notifyProcesses

protected java.lang.Integer notifyProcesses(java.lang.String eventName,
                                            java.lang.Long requestId,
                                            java.lang.String message,
                                            int delay)

Notify an in-flight process instance.

Parameters:

eventName - unique event name

requestId - document ID of the triggering request

delay - optional delay

Returns:

EventWaitInstance.RESUME_STATUS_SUCCESS, EventWaitInstance.RESUME_STATUS_PARTIAL_SUCCESS, EventWaitInstance.RESUME_STATUS_NO_WAITERS, or EventWaitInstance.RESUME_STATUS_FAILURE

translateInputValues

protected java.util.Map<java.lang.String,java.lang.String> translateInputValues(java.lang.Long processId,
                                                                                java.util.Map<java.lang.String,java.lang.Object> values)
                                                                         throws ProcessException

Converts process input values to Map needed by the runtime engine. Values in the values map must not be null.

Throws:

ProcessException

getSuccessResponse

protected Response getSuccessResponse(Request request,
                                      java.lang.Object message,
                                      java.util.Map<java.lang.String,java.lang.String> headers)

Default implementation returns an acknowledgement response.

getErrorResponse

protected Response getErrorResponse(Request request,
                                    java.lang.Object message,
                                    java.util.Map<java.lang.String,java.lang.String> headers,
                                    java.lang.Exception cause)

Default implementation returns a status response.