com.indexdata.mkjsf.pazpar2.data

Class CommandError

java.lang.Object

com.indexdata.mkjsf.pazpar2.data.ResponseDataObject

com.indexdata.mkjsf.pazpar2.data.CommandError

All Implemented Interfaces:

ErrorInterface, java.io.Serializable

public class CommandError
extends ResponseDataObject
implements ErrorInterface

Holds an error encountered during the execution of a command. An error can be received by a command thread as an exception message or as an error XML. In both cases the error (string or xml) will be embedded in a new 'applicationerror' element which in turn will be embedded in a command XML (i.e. a 'search' or a 'show' response XML) The command response XML is subsequently parsed by ResponseParser, which will then create the CommandError object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandError()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	createErrorXml(java.lang.String commandName, java.lang.String statusCode, java.lang.String exception, java.lang.String errorMessage, java.lang.String response) Creates an XML string error message, embedded in an XML string document named by the command This is the XML that ResponseParser will turn into a CommandError object.
ErrorHelper.ErrorCode	getApplicationErrorCode()
java.lang.String	getException()
java.lang.String	getLabel()
java.lang.String	getMessage()
ServiceError	getServiceError()
java.util.List<java.lang.String>	getSuggestions()
static java.lang.String	insertErrorXml(java.lang.String commandName, java.lang.String statusCode, java.lang.String exception, java.lang.String pazpar2ErrorXml) Embeds a Pazpar2 (or Pazpar2 client) error response document as a child element of a command response document (like 'search' or 'show').
boolean	isPazpar2Error()
boolean	isServiceError()
boolean	isServiceProxyError()
void	setApplicationErrorCode(ErrorHelper.ErrorCode code)
void	setErrorHelper(ErrorHelper errorHelper) Sets the object that should be used to analyze the error

Methods inherited from class com.indexdata.mkjsf.pazpar2.data.ResponseDataObject

addElement, appendContent, getApplicationError, getAttribute, getBinary, getElements, getHasResults, getIntValue, getIsBinary, getOneElement, getOneValue, getProperty, getType, getValue, getValueArray, getXml, hasApplicationError, hasServiceError, setAttribute, setBinary, setType, setXml

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandError

public CommandError()

Method Detail

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface ErrorInterface

getMessage

public java.lang.String getMessage()

Specified by:

getMessage in interface ErrorInterface

getException

public java.lang.String getException()

Specified by:

getException in interface ErrorInterface

getSuggestions

public java.util.List<java.lang.String> getSuggestions()

Specified by:

getSuggestions in interface ErrorInterface

createErrorXml

public static java.lang.String createErrorXml(java.lang.String commandName,
                              java.lang.String statusCode,
                              java.lang.String exception,
                              java.lang.String errorMessage,
                              java.lang.String response)

Creates an XML string error message, embedded in an XML string document named by the command This is the XML that ResponseParser will turn into a CommandError object.

Parameters:

commandName -

exception -

errorMessage -

Returns:

insertErrorXml

public static java.lang.String insertErrorXml(java.lang.String commandName,
                              java.lang.String statusCode,
                              java.lang.String exception,
                              java.lang.String pazpar2ErrorXml)

Embeds a Pazpar2 (or Pazpar2 client) error response document as a child element of a command response document (like 'search' or 'show'). This is the XML that ResponseParser will turn into a CommandError object.

Parameters:

commandName - The name of the command during which's execution the error was encountered

exception - The (possibly loosely defined) name of the exception that was thrown

pazpar2ErrorXml - The error document as created by Pazpar2, or the Service Proxy or by the Pazpar2 client itself.

Returns:

setErrorHelper

public void setErrorHelper(ErrorHelper errorHelper)

Sets the object that should be used to analyze the error

Specified by:

setErrorHelper in interface ErrorInterface

setApplicationErrorCode

public void setApplicationErrorCode(ErrorHelper.ErrorCode code)

Specified by:

setApplicationErrorCode in interface ErrorInterface

getApplicationErrorCode

public ErrorHelper.ErrorCode getApplicationErrorCode()

Specified by:

getApplicationErrorCode in interface ErrorInterface

isServiceError

public boolean isServiceError()

Specified by:

isServiceError in interface ErrorInterface

getServiceError

public ServiceError getServiceError()

Specified by:

getServiceError in interface ErrorInterface

Overrides:

getServiceError in class ResponseDataObject

isServiceProxyError

public boolean isServiceProxyError()

isPazpar2Error

public boolean isPazpar2Error()