com.lf.commons.web.msg

Class ErrorMessage

java.lang.Object

com.lf.commons.web.msg.XMLMessage

com.lf.commons.web.msg.ErrorMessage

All Implemented Interfaces:

AbstractMessage

public class ErrorMessage
extends XMLMessage

Represents an error message in XML format based on 'error_message.dtd'.

This class can be used to create fallback messages when an error occurs while processing an incoming XML request of any kind.

Since:

1.6

Version:

$Revision: 1.10 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ERROR_MESSAGE_DOCNAME The name of the root element.
static java.lang.String	ERROR_MESSAGE_DTD The underlying DTD.
static int	STATUS_CONFIG_ERROR Error status code.
static int	STATUS_DATA_ERROR Error status code.
static int	STATUS_GET_NOT_SUPPORTED Error status code.
static int	STATUS_INTERNAL_ERROR Error status code.
static int	STATUS_INVALID_GET_PARAMETERS Error status code.
static int	STATUS_INVALID_GET_REQUEST Error status code.
static int	STATUS_INVALID_POST_PARAMETERS Error status code.
static int	STATUS_INVALID_POST_REQUEST Error status code.
static int	STATUS_MAINTENANCE Error status code.
static int	STATUS_NOT_AVAILABLE Error status code.
static int	STATUS_UNKNOWN_ERROR Error status code.

Fields inherited from class com.lf.commons.web.msg.XMLMessage

docname, document, dtd, encoding, format

Constructor Summary

Constructors

Constructor and Description
ErrorMessage() Constructs an instance based on a given DTD.
ErrorMessage(java.lang.String version, int code, java.lang.String[] text, Locale locale) Constructs a message instance.
ErrorMessage(java.lang.String version, int code, java.lang.String text, Locale locale) Constructs a message instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getErrorStatus() Provides the reason for the error.
static void	report(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String version, int code, java.lang.String text, Locale locale) Generates a configurable error response.

Methods inherited from class com.lf.commons.web.msg.XMLMessage

canProcess, getAttribute, getAttributeValue, getContents, getDocument, getDTD, getElement, getElements, getElementValue, getEncoding, getIntFunctionResult, isArmed, isValid, printDocument, read, read, setEncoding, setFormat, write, write

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_MESSAGE_DTD

public static final java.lang.String ERROR_MESSAGE_DTD

The underlying DTD.

See Also:

Constant Field Values

ERROR_MESSAGE_DOCNAME

public static final java.lang.String ERROR_MESSAGE_DOCNAME

The name of the root element.

See Also:

Constant Field Values

STATUS_UNKNOWN_ERROR

public static int STATUS_UNKNOWN_ERROR

Error status code.

STATUS_INTERNAL_ERROR

public static int STATUS_INTERNAL_ERROR

Error status code.

STATUS_NOT_AVAILABLE

public static int STATUS_NOT_AVAILABLE

Error status code.

STATUS_MAINTENANCE

public static int STATUS_MAINTENANCE

Error status code.

STATUS_INVALID_GET_REQUEST

public static int STATUS_INVALID_GET_REQUEST

Error status code.

STATUS_INVALID_POST_REQUEST

public static int STATUS_INVALID_POST_REQUEST

Error status code.

STATUS_CONFIG_ERROR

public static int STATUS_CONFIG_ERROR

Error status code.

STATUS_GET_NOT_SUPPORTED

public static int STATUS_GET_NOT_SUPPORTED

Error status code.

STATUS_INVALID_GET_PARAMETERS

public static int STATUS_INVALID_GET_PARAMETERS

Error status code.

STATUS_INVALID_POST_PARAMETERS

public static int STATUS_INVALID_POST_PARAMETERS

Error status code.

STATUS_DATA_ERROR

public static int STATUS_DATA_ERROR

Error status code.

Constructor Detail

ErrorMessage

public ErrorMessage()

Constructs an instance based on a given DTD.

ErrorMessage

public ErrorMessage(java.lang.String version,
            int code,
            java.lang.String text,
            Locale locale)

Constructs a message instance.

This convenience constructor gets the parameters from the servlet context and embeds them into an XML file based on 'parameter_message.dtd'.

Parameters:

version - Currently only "1.0", required

code - Status code, required

text - Status description, optional

locale - The locale for message text

ErrorMessage

public ErrorMessage(java.lang.String version,
            int code,
            java.lang.String[] text,
            Locale locale)

Constructs a message instance.

This convenience constructor gets the parameters from the servlet context and embeds them into an XML file based on 'parameter_message.dtd'. This variant creates multiple description tags one for each text line in the parameter array.

Parameters:

version - Currently only "1.0", required

code - Status code, required

text - Status description as separate lines, optional

locale - The locale for message text

Method Detail

getErrorStatus

public java.lang.String getErrorStatus()

Provides the reason for the error.

Returns:

Error reason, may be null

report

public static void report(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response,
          java.lang.String version,
          int code,
          java.lang.String text,
          Locale locale)
                   throws java.io.IOException

Generates a configurable error response.

Remember that the given text is passed to the user so do not pass any irrelevant information like "The database cannot be reached". This should be printed into the service log file for internal debugging. Detailed text should only be returned if the user can do something about to avoid the error like "Illegal request parameter id=blabla".

Parameters:

request - HTTP request

response - HTTP response

version - Currently only "1.0", required

code - Error code, required

text - Error text, optional

locale - The locale for message text

Throws:

java.io.IOException - Error indication