com.adaptris.core.http

Class RequestParameterConverterService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.http.RequestParameterConverterService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, JndiBindable, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Turn HTTP Request parameters (from a HTTP POST) into metadata",
                  tag="service,metadata,http,https")
public class RequestParameterConverterService
extends ServiceImp

Implementation of Service which parses the incoming HTTP Request parameters and converts all request parameters into Metadata.

If the client is sending data to the adapter, it is possible that the client will send data as though it were a standard Html Form post. In situations like that, then the payload is a number of URLEncoded key value pairs. This service can be used to convert all the Request parameters into metadata.

If the parameterForPayload field is configured and present in the request parameters, then this will become the message payload, otherwise the payload remains unchanged.

In all cases, the metadata value associated with contentTypeKey will be matched against the configured contentTypeValue If the values match, then the payload is converted, otherwise no action is performed on the payload. If there is a charset parameter supplied with the content type metadata, then this charset will be used to decode the parameters, and used as the CharEncoding on the AdaptriMessage

In the adapter configuration file this class is aliased as http-request-parameter-converter-service which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONTENT_TYPE_KEY
static java.lang.String	DEFAULT_CONTENT_TYPE_VALUE

Fields inherited from class com.adaptris.core.ServiceImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
RequestParameterConverterService() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(AdaptrisMessage msg) *
java.lang.String	getContentTypeKey()
java.lang.String	getContentTypeValue()
java.lang.String	getParameterForPayload()
protected void	initService()
void	prepare() Prepare for initialisation.
void	setContentTypeKey(java.lang.String s) Set the metadata key for finding out the content-type.
void	setContentTypeValue(java.lang.String s) Set the value that the content-type must match.
void	setParameterForPayload(java.lang.String s) Set the request parameter the value of which will become the Payload of the Adaptris Message

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsConfirmation, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isConfirmation, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, rethrowServiceException, retrieveComponentState, setContinueOnFail, setIsConfirmation, setIsTrackingEndpoint, setLookupName, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_TYPE_KEY

public static final java.lang.String DEFAULT_CONTENT_TYPE_KEY

See Also:

Constant Field Values

DEFAULT_CONTENT_TYPE_VALUE

public static final java.lang.String DEFAULT_CONTENT_TYPE_VALUE

See Also:

Constant Field Values

Constructor Detail

RequestParameterConverterService

public RequestParameterConverterService()

Creates a new instance.

Method Detail

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

*

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

See Also:

(com.adaptris.core.AdaptrisMessage)

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

getParameterForPayload

public java.lang.String getParameterForPayload()

setParameterForPayload

public void setParameterForPayload(java.lang.String s)

Set the request parameter the value of which will become the Payload of the Adaptris Message

Parameters:

s -

getContentTypeKey

public java.lang.String getContentTypeKey()

setContentTypeKey

public void setContentTypeKey(java.lang.String s)

Set the metadata key for finding out the content-type.

Parameters:

s - the metadata key.

getContentTypeValue

public java.lang.String getContentTypeValue()

setContentTypeValue

public void setContentTypeValue(java.lang.String s)

Set the value that the content-type must match.

Parameters:

s - the value.