Package com.adaptris.rest

Class WorkflowServicesConsumer

java.lang.Object

com.adaptris.rest.WorkflowServicesConsumer

All Implemented Interfaces:

ComponentLifecycle, ComponentLifecycleExtension

Direct Known Subclasses:

HttpRestWorkflowServicesConsumer

public abstract class WorkflowServicesConsumer
extends java.lang.Object
implements ComponentLifecycle, ComponentLifecycleExtension

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONTENT_TYPE_DEFAULT
static java.lang.String	CONTENT_TYPE_JSON
static int	ERROR_BAD_REQUEST
static int	ERROR_DEFAULT
static int	ERROR_NOT_READY
static int	OK_200

Constructor Summary

Constructors

Constructor	Description
WorkflowServicesConsumer()

Method Summary

Modifier and Type	Method	Description
void	close()
protected abstract StandaloneConsumer	configureConsumer(AdaptrisMessageListener messageListener, java.lang.String consumedUrlPath, java.lang.String acceptedHttpMethods)
protected abstract void	doErrorResponse(AdaptrisMessage message, java.lang.Exception e, int httpStatus)
protected void	doResponse(AdaptrisMessage original, AdaptrisMessage processed)
protected void	doResponse(AdaptrisMessage orig, AdaptrisMessage proc, java.lang.String contentType)
protected abstract void	doResponse(AdaptrisMessage orig, AdaptrisMessage proc, java.lang.String contentType, int httpResponse)
java.lang.String	getAcceptedHttpMethods()	A comma separated list of accepted http request methods; GET, POST, PATCH etc etc And example might be "GET,POST".
java.lang.String	getConsumedUrlPath()	This is the url that this consumer will listen for requests.
AdaptrisMessageListener	getMessageListener()
StandaloneConsumer	getStandaloneConsumer()
void	init()
void	prepare()
void	setAcceptedHttpMethods(java.lang.String acceptedHttpMethods)	A comma separated list of accepted http request methods; GET, POST, PATCH etc etc And example might be "GET,POST".
void	setConsumedUrlPath(java.lang.String consumedUrlPath)	This is the url that this consumer will listen for requests.
void	setMessageListener(AdaptrisMessageListener messageListener)
void	setStandaloneConsumer(StandaloneConsumer standaloneConsumer)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

OK_200

public static final int OK_200

See Also:

Constant Field Values

ERROR_BAD_REQUEST

public static final int ERROR_BAD_REQUEST

See Also:

Constant Field Values

ERROR_DEFAULT

public static final int ERROR_DEFAULT

See Also:

Constant Field Values

ERROR_NOT_READY

public static final int ERROR_NOT_READY

See Also:

Constant Field Values

CONTENT_TYPE_DEFAULT

public static final java.lang.String CONTENT_TYPE_DEFAULT

See Also:

Constant Field Values

CONTENT_TYPE_JSON

public static final java.lang.String CONTENT_TYPE_JSON

See Also:

Constant Field Values

Constructor Detail

WorkflowServicesConsumer

public WorkflowServicesConsumer()

Method Detail

configureConsumer

protected abstract StandaloneConsumer configureConsumer(AdaptrisMessageListener messageListener,
                                                        java.lang.String consumedUrlPath,
                                                        java.lang.String acceptedHttpMethods)

doResponse

protected void doResponse(AdaptrisMessage original,
                          AdaptrisMessage processed)
                   throws ServiceException

Throws:

ServiceException

doResponse

protected void doResponse(AdaptrisMessage orig,
                          AdaptrisMessage proc,
                          java.lang.String contentType)
                   throws ServiceException

Throws:

ServiceException

doResponse

protected abstract void doResponse(AdaptrisMessage orig,
                                   AdaptrisMessage proc,
                                   java.lang.String contentType,
                                   int httpResponse)

doErrorResponse

protected abstract void doErrorResponse(AdaptrisMessage message,
                                        java.lang.Exception e,
                                        int httpStatus)

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

init

public void init()
          throws CoreException

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

close

public void close()

Specified by:

close in interface ComponentLifecycle

getStandaloneConsumer

public StandaloneConsumer getStandaloneConsumer()

setStandaloneConsumer

public void setStandaloneConsumer(StandaloneConsumer standaloneConsumer)

getMessageListener

public AdaptrisMessageListener getMessageListener()

setMessageListener

public void setMessageListener(AdaptrisMessageListener messageListener)

getConsumedUrlPath

public java.lang.String getConsumedUrlPath()

This is the url that this consumer will listen for requests. For example "/workflow-services/*"; will trigger this consumer for any requests on "http://host:port/workflow-services/...".

setConsumedUrlPath

public void setConsumedUrlPath(java.lang.String consumedUrlPath)

This is the url that this consumer will listen for requests. For example "/workflow-services/*"; will trigger this consumer for any requests on "http://host:port/workflow-services/...".

getAcceptedHttpMethods

public java.lang.String getAcceptedHttpMethods()

A comma separated list of accepted http request methods; GET, POST, PATCH etc etc And example might be "GET,POST".

setAcceptedHttpMethods

public void setAcceptedHttpMethods(java.lang.String acceptedHttpMethods)

A comma separated list of accepted http request methods; GET, POST, PATCH etc etc And example might be "GET,POST".