com.adaptris.core.http.server

Class ConfiguredStatusProvider

java.lang.Object

com.adaptris.core.http.server.ConfiguredStatusProvider

All Implemented Interfaces:

HttpStatusProvider

public class ConfiguredStatusProvider
extends java.lang.Object
implements HttpStatusProvider

Static implementation of HttpStatusProvider that uses HttpStatusProvider.HttpStatus to derive the correct code.

If you are configuring a static HTTP status, then you could use RawStatusProvider and the actual numeric code if that makes more sense to you. This class is provided so that a typesafe enum can be used to derive the correct status code.

In the adapter configuration file this class is aliased as http-configured-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
ConfiguredStatusProvider()
ConfiguredStatusProvider(HttpStatusProvider.HttpStatus status)

Method Summary

Modifier and Type	Method and Description
HttpStatusProvider.HttpStatus	getStatus()
HttpStatusProvider.Status	getStatus(AdaptrisMessage msg) Get the method that should be used with the HTTP request.
java.lang.String	getText()
void	setStatus(HttpStatusProvider.HttpStatus status) Set the HTTP Status to use.
void	setText(java.lang.String txt) Set the optional response text that will be sent with the response code.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfiguredStatusProvider

public ConfiguredStatusProvider()

ConfiguredStatusProvider

public ConfiguredStatusProvider(HttpStatusProvider.HttpStatus status)

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.

getStatus

public HttpStatusProvider.HttpStatus getStatus()

setStatus

public void setStatus(HttpStatusProvider.HttpStatus status)

Set the HTTP Status to use.

Parameters:

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

getText

public java.lang.String getText()

setText

public void setText(java.lang.String txt)

Set the optional response text that will be sent with the response code.

Note that for StandardResponseProducer any values configured here will be ignored as that will use HttpServletResponse.setStatus(int) method only. This field is included only for completeness, a sensible default will be made available based on the HttpStatusProvider.HttpStatus selected.

Parameters:

txt - the text to be sent (e.g. OK, if the status code is HttpStatusProvider.HttpStatus.OK_200).