ErrorList

public class ErrorList extends HeaderElement

An ebXML ErrorList in the SOAP Header of a HeaderContainer

Author:cyng

Fields

ATTRIBUTE_CODE_CONTEXT

static final String ATTRIBUTE_CODE_CONTEXT

Name of the codeContext attribute [ebMSS 4.2.3.2.2].

ATTRIBUTE_ERROR_CODE

static final String ATTRIBUTE_ERROR_CODE

Name of the errorCode attribute [ebMSS 4.2.3.2.3].

ATTRIBUTE_HIGHEST_SEVERITY

static final String ATTRIBUTE_HIGHEST_SEVERITY

Name of highestSeverity attribute [ebMSS 4.2.3.1].

ATTRIBUTE_LOCATION

static final String ATTRIBUTE_LOCATION

Name of the location attribute [ebMSS 4.2.3.2.5].

ATTRIBUTE_SEVERITY

static final String ATTRIBUTE_SEVERITY

Name of the severity attribute [ebMSS 4.2.3.2.4].

CODE_DELIVERY_FAILURE

public static final String CODE_DELIVERY_FAILURE

Non-XML document error: message delivery failure [4.2.3.4.2].

CODE_INCONSISTENT

public static final String CODE_INCONSISTENT

Document error: element content or attribute value inconsistent with other elements or attributes [4.2.3.4.1].

CODE_MIME_PROBLEM

public static final String CODE_MIME_PROBLEM

Non-XML document error: URI resolve error.

CODE_NOT_SUPPORTED

public static final String CODE_NOT_SUPPORTED

Document error: element or attribute not supported [4.2.3.4.1].

CODE_OTHER_XML

public static final String CODE_OTHER_XML

Document error: other error in an element content or attribute value [4.2.3.4.1].

CODE_SECURITY_FAILURE

public static final String CODE_SECURITY_FAILURE

Non-XML document error: message security check failed [4.2.3.4.2].

CODE_TIME_TO_LIVE_EXPIRED

public static final String CODE_TIME_TO_LIVE_EXPIRED

Non-XML document error: message time to live expired [4.2.3.4.2].

CODE_UNKNOWN

public static final String CODE_UNKNOWN

Non-XML document error: Unknown error.

CODE_VALUE_NOT_RECOGNIZED

public static final String CODE_VALUE_NOT_RECOGNIZED

Document error: element content or attribute value not recognized [4.2.3.4.1].

ELEMENT_ERROR

static final String ELEMENT_ERROR

Error element name in ErrorList [ebMSS 4.2.3.2].

ERROR_LIST

static final String ERROR_LIST

ErrorList element name

SEVERITY_ERROR

public static final String SEVERITY_ERROR

Text for “Error” severity level.

SEVERITY_WARNING

public static final String SEVERITY_WARNING

Text for “Warning” severity level.

Constructors

ErrorList

ErrorList(SOAPEnvelope soapEnvelope, String errorCode, String severity, String description)

Constructs an ErrorList with the given mandatory fields.

Parameters:
  • soapEnvelopeSOAPEnvelope, the header of which the ErrorList is added.
  • errorCode – Error code value of the error.
  • severity – Severity of the error.
  • description – Description of the error.
Throws:
  • SOAPException

ErrorList

ErrorList(SOAPEnvelope soapEnvelope, String errorCode, String severity, String description, String lang)

Constructs an ErrorList with the given mandatory fields.

Parameters:
  • soapEnvelopeSOAPEnvelope, the header of which the ErrorList is added.
  • errorCode – Error code value of the error.
  • severity – Severity of the error.
  • description – Description of the error.
  • lang – Language of the description specified in ` RFC 1766 <http://www.ietf.org/rfc/rfc1766.txt>`_ and ISO639.
Throws:
  • SOAPException

ErrorList

ErrorList(SOAPEnvelope soapEnvelope, String errorCode, String severity, String description, String lang, String location)

Constructs an ErrorList with the given mandatory fields.

Parameters:
  • soapEnvelopeSOAPEnvelope, the header of which the ErrorList is added.
  • errorCode – Error code value of the error.
  • severity – Severity of the error.
  • description – Description of the error.
  • lang – Language of the description specified in ` RFC 1766 <http://www.ietf.org/rfc/rfc1766.txt>`_ and ISO639.
Throws:
  • SOAPException

ErrorList

ErrorList(SOAPEnvelope soapEnvelope, SOAPElement soapElement)

Constructs an ErrorList object by parsing the given SOAPElement object.

Parameters:
  • soapEnvelopeSOAPEnvelope, the header of which the ErrorList is added.
  • soapElementSOAPElement object to be read into the ErrorList object.
Throws:
  • SOAPException

Methods

addError

public void addError(String errorCode, String severity, String description)

Add an element to the error list.

Parameters:
  • errorCode – Error code value.
  • severity – Severity of the error.
  • description – Description of the error.
Throws:
  • SOAPException

addError

public void addError(String errorCode, String severity, String description, String lang)

Add an element to the error list.

Parameters:
  • errorCode – Error code value.
  • severity – Severity of the error.
  • description – Description of the error.
  • lang – Language of the description specified in ` RFC 1766 <http://www.ietf.org/rfc/rfc1766.txt>`_ and ISO639.
Throws:
  • SOAPException

addError

public void addError(String errorCode, String severity, String description, String lang, String location)

Add an element to the error list.

Parameters:
  • errorCode – Error code value.
  • severity – Severity of the error.
  • description – Description of the error.
  • lang – Language of the description specified in ` RFC 1766 <http://www.ietf.org/rfc/rfc1766.txt>`_ and ISO639.
  • location – Location of the message containing error.
Throws:
  • SOAPException

getErrors

public Iterator getErrors()

Gets all ErrorList.Errors in this ErrorList

getHighestSeverity

public String getHighestSeverity()

Get the highest severity of all the ErrorList.Error objects in the ErrorList.

Returns:Highest severity of the errors.