org.dataone.service.exceptions

Class BaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.dataone.service.exceptions.BaseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthenticationTimeout, IdentifierNotUnique, InsufficientResources, InvalidCredentials, InvalidRequest, InvalidSystemMetadata, InvalidToken, NotAuthorized, NotFound, NotImplemented, ServiceFailure, SynchronizationFailed, UnsupportedMetadataType, UnsupportedType, VersionMismatch

public class BaseException
extends Exception

A BaseException is the root of all DataONE service class exception messages. Each exception contains a code, which typically corresponds to a high-level HTTP error code, a detail_code, which classifies the exception to a more constrained subtype of error, and a description of the error. It can also contain additional trace information used to debug the problem, which is stored as a set of name-value pairs.

Author:

Matthew Jones

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	FMT_HTML
static int	FMT_JSON
static int	FMT_XML

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseException(int code, String detail_code, String description) Construct a BaseException with the given code, detail code, and description.
protected	BaseException(int code, String detail_code, String pidString, String nodeIdString, String description, TreeMap<String,String> trace_information) Construct a BaseException with the given code, detail code, pid, nodeId, description, and trace_information.
protected	BaseException(int code, String detail_code, String pidString, String description, TreeMap<String,String> trace_information) Construct a BaseException with the given code, detail code, description, and trace_information.
protected	BaseException(int code, String detail_code, String description, TreeMap<String,String> trace_information) Construct a BaseException with the given code, detail code, description, and trace_information.

Method Summary

Modifier and Type	Method and Description
void	addTraceDetail(String key, String value) Add new detailed trace information, storing it the value under a known key.
int	getCode()
String	getDescription()
String	getDetail_code()
String	getIdentifier()
String	getNodeId() Get the node Id string
String	getPid() Deprecated. As of release 2.4, replaced by getIdentifier()
String	getTraceDetail(String key) Get the value of one of the trace detail parametersm retrieved by its key value.
Set<String>	getTraceKeySet() Return a Set representation of all of the keys for the trace values in this exception.
String	serialize(int format) Serialize the format in XML, JSON, or HTML format.
protected void	setCode(int code)
void	setDetail_code(String detail_code)
void	setIdentifier(String p)
void	setNodeId(String nodeIdString) Set the node Id string
void	setPid(String p) Deprecated. As of release 2.4, replaced by #setIdentifier()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

FMT_XML

public static final int FMT_XML

See Also:

Constant Field Values

FMT_JSON

public static final int FMT_JSON

See Also:

Constant Field Values

FMT_HTML

public static final int FMT_HTML

See Also:

Constant Field Values

Constructor Detail

BaseException

protected BaseException(int code,
                        String detail_code,
                        String description)

Construct a BaseException with the given code, detail code, and description.

Parameters:

code - the code used to classify the exception

detail_code - the detailed code for this exception

description - the description of this exception

BaseException

protected BaseException(int code,
                        String detail_code,
                        String pidString,
                        String nodeIdString,
                        String description,
                        TreeMap<String,String> trace_information)

Construct a BaseException with the given code, detail code, pid, nodeId, description, and trace_information.

Parameters:

code - the code used to classify the exception

detail_code - the detailed code for this exception

pidString: - the identifier associated with the exception, and usually with the request

nodeIdString - the node identifier associated with the exception

description - the description of this exception

trace_information - containing a Map of key/value pairs

BaseException

protected BaseException(int code,
                        String detail_code,
                        String pidString,
                        String description,
                        TreeMap<String,String> trace_information)

Construct a BaseException with the given code, detail code, description, and trace_information.

Parameters:

code - the code used to classify the exception

detail_code - the detailed code for this exception

pidString: - the identifier associated with the exception, and usually with the request

description - the description of this exception

trace_information - containing a Map of key/value pairs

BaseException

protected BaseException(int code,
                        String detail_code,
                        String description,
                        TreeMap<String,String> trace_information)

Construct a BaseException with the given code, detail code, description, and trace_information.

Parameters:

code - the code used to classify the exception

detail_code - the detailed code for this exception

description - the description of this exception

trace_information - containing a Map of key/value pairs

Method Detail

setCode

protected void setCode(int code)

Parameters:

code - the code to set

getCode

public int getCode()

Returns:

the code

setDetail_code

public void setDetail_code(String detail_code)

Parameters:

detail_code - the detail_code to set

getDetail_code

public String getDetail_code()

Returns:

the detail_code

getPid

@Deprecated
public String getPid()

Deprecated. As of release 2.4, replaced by getIdentifier()

Since:

2017-01-13

setPid

@Deprecated
public void setPid(String p)

Deprecated. As of release 2.4, replaced by #setIdentifier()

Since:

2017-01-13

getIdentifier

public String getIdentifier()

setIdentifier

public void setIdentifier(String p)

setNodeId

public void setNodeId(String nodeIdString)

Set the node Id string

Parameters:

nodeIdString -

getNodeId

public String getNodeId()

Get the node Id string

Returns:

nodeIdString - the identifier of the node that raised the exception

getDescription

public String getDescription()

Returns:

the description

addTraceDetail

public void addTraceDetail(String key,
                           String value)

Add new detailed trace information, storing it the value under a known key.

Parameters:

key - the key to index the trace value

value - that trace value to be stored

getTraceDetail

public String getTraceDetail(String key)

Get the value of one of the trace detail parametersm retrieved by its key value.

Parameters:

key - the key of the trace information to be retrieved

Returns:

the String key value associated with the key

getTraceKeySet

public Set<String> getTraceKeySet()

Return a Set representation of all of the keys for the trace values in this exception.

Returns:

Set representation of all of the keys for the trace values

serialize

public String serialize(int format)

Serialize the format in XML, JSON, or HTML format. If format is unknown, then return in XML format.

Parameters:

format - an integer code indicating the format