com.adaptris.core.http.server

Class MetadataStatusProvider

java.lang.Object

com.adaptris.core.http.server.MetadataStatusProvider

All Implemented Interfaces:

HttpStatusProvider

public class MetadataStatusProvider
extends java.lang.Object
implements HttpStatusProvider

Implementation of HttpStatusProvider that can derive the status and text from AdaptrisMessage metadata.

If the configured metadata key does not exist / non-numeric, then getDefaultStatus() is used to provide the Status.

In the adapter configuration file this class is aliased as http-metadata-status which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from interface com.adaptris.core.http.server.HttpStatusProvider

HttpStatusProvider.HttpStatus, HttpStatusProvider.Status

Constructor Summary

Constructors

Constructor and Description
MetadataStatusProvider()
MetadataStatusProvider(java.lang.String codeKey)
MetadataStatusProvider(java.lang.String codeKey, java.lang.String textKey)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCodeKey()
HttpStatusProvider.HttpStatus	getDefaultStatus()
HttpStatusProvider.Status	getStatus(AdaptrisMessage msg) Get the method that should be used with the HTTP request.
java.lang.String	getTextKey()
void	setCodeKey(java.lang.String key) Set the metadata where the status code will be taken.
void	setDefaultStatus(HttpStatusProvider.HttpStatus status) Set the default status in the event that it cannot be derived from metadata.
void	setTextKey(java.lang.String k) Set the metadata where the status text will be taken.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataStatusProvider

public MetadataStatusProvider()

MetadataStatusProvider

public MetadataStatusProvider(java.lang.String codeKey)

MetadataStatusProvider

public MetadataStatusProvider(java.lang.String codeKey,
                              java.lang.String textKey)

Method Detail

getStatus

public HttpStatusProvider.Status getStatus(AdaptrisMessage msg)

Description copied from interface: HttpStatusProvider

Get the method that should be used with the HTTP request.

Specified by:

getStatus in interface HttpStatusProvider

Parameters:

msg - the AdaptrisMessage if required to derive the method.

Returns:

the HttpStatusProvider.Status.

getCodeKey

public java.lang.String getCodeKey()

setCodeKey

public void setCodeKey(java.lang.String key)

Set the metadata where the status code will be taken.

Parameters:

key - the metadata key.

getTextKey

public java.lang.String getTextKey()

setTextKey

public void setTextKey(java.lang.String k)

Set the metadata where the status text will be taken.

Note that for StandardResponseProducer any values associated with the key will be ignored as that will use HttpServletResponse.setStatus(int) method only. This is only included for completeness.

Parameters:

k - the optional key for the status text

getDefaultStatus

public HttpStatusProvider.HttpStatus getDefaultStatus()

setDefaultStatus

public void setDefaultStatus(HttpStatusProvider.HttpStatus status)

Set the default status in the event that it cannot be derived from metadata.

Parameters:

status - the default status, which defaults to HttpStatusProvider.HttpStatus.INTERNAL_ERROR_500.