atg.core.exception

Class ContainerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

atg.core.exception.ContainerException

All Implemented Interfaces:

ContainableException, java.io.Serializable

Direct Known Subclasses:

ActorException, atg.adc.ADCException, AddException, AgentAuditLoggingException, AgentException, C2CSessionException, CommandInvocationException, CommerceException, DetailedRemoveException, DirectoryModificationException, EvaluationException, FilterException, GetException, IdGeneratorException, InvoiceException, LockManagerException, MappingException, MarkerException, MatchException, MaxNumberItemsException, PipelineManagerException, ProcessException, RemoveException, RepositoryException, SecurityException, TemplateEmailException, TransactionDemarcationException, UpdateException, WebAppRegistryException, WorkflowException

public class ContainerException
extends java.lang.Exception
implements ContainableException

An exception which contains a source exception. The printStackTrace and toString methods are overridden to display this exception's information and the original source exception. This exception functionality is useful in case you need to "transform" the source exception into a new type. Without this typically developers would use the toString value of the source exception to form the message of the new exception. This process would loose the original stack trace. This allows the original exception's stack trace to be preserved. Now also supports additional optional fields for: error code - more granular error code attributes - map of key-value extra information

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected ContainerException	mNestedContainerException Set if this exception has a nested container exception

Constructor Summary

Constructors

Constructor and Description
ContainerException() Constructs a new ContainerException.
ContainerException(java.lang.String pStr) Constructs a new ContainerException with the given explanation.
ContainerException(java.lang.String pStr, java.lang.String pErrorCode) Create an exception with a message and error code
ContainerException(java.lang.String pStr, java.lang.String pErrorCode, java.lang.Object... pAttributes) Create an exception with a message, error code, dev message and more info
ContainerException(java.lang.String pStr, java.lang.String pErrorCode, java.lang.Throwable pSourceException) Create an exception with a message and error code
ContainerException(java.lang.String pStr, java.lang.Throwable pSourceException) Constructs a new ContainerException with the given explanation.
ContainerException(java.lang.String pStr, java.lang.Throwable pSourceException, java.lang.String pErrorCode, java.lang.Object... pAttributes) Create an exception with a message, source exception, error code, dev message and more info.
ContainerException(java.lang.Throwable pSourceException) Constructs a new ContainerException.
ContainerException(java.lang.Throwable pSourceException, java.lang.String pErrorCode) Throwable exception including an error code.

Method Summary

Modifier and Type	Method and Description
protected void	appendExtraInfo(java.lang.StringBuilder pSb) Builds up a string for any extra information available, i.e.
boolean	containsInheritableInfo() Whether or not this exception includes inheritable data, i.e.
java.util.Map<java.lang.Object,java.lang.Object>	getAttributes() Getter for attributes to associate with the error Note, if no inheritable fields are set on this exception then any nested container exception will be used instead.
java.lang.String	getErrorCode() Getter for an error code to associate with this error.
java.lang.Object[]	getMessageArguments() Return property MessageArguments
protected ContainerException	getNestedContainerException()
java.lang.Throwable	getSourceException() Returns property SourceException
void	printStackTrace(boolean pDisplaySource) Print our stack trace and optionally that of the source exception if there is one.
void	printStackTrace(java.io.PrintStream pStream, boolean pDisplaySource) Print our stack trace and optionally that of the source exception if there is one.
void	printStackTrace(java.io.PrintWriter pWriter) Print our stack trace and that of the source exception if there is one.
void	printStackTrace(java.io.PrintWriter pWriter, boolean pDisplaySource) Print our stack trace and optionally that of the source exception if there is one.
void	setAttributes(java.lang.Object... pAttributes)
void	setErrorCode(java.lang.String pErrorCode) Setter for an error code to associate with this error.
void	setMessageArguments(java.lang.Object[] pMessageArguments) Sets the message arguments
protected void	setNestedContainerException(ContainerException pNestedContainerException)
void	setSourceException(java.lang.Throwable pSourceException) Sets property SourceException
java.lang.String	toString() Display information about this exception and that of the source exception if there is one.
java.lang.String	toString(boolean pDisplaySource) Display information about this exception and optionally that of the source exception if there is one.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mNestedContainerException

protected ContainerException mNestedContainerException

Set if this exception has a nested container exception

Constructor Detail

ContainerException

public ContainerException()

Constructs a new ContainerException.

ContainerException

public ContainerException(java.lang.String pStr)

Constructs a new ContainerException with the given explanation.

ContainerException

public ContainerException(java.lang.Throwable pSourceException)

Constructs a new ContainerException.

Parameters:

pSourceException - the initial exception which was the root cause of the problem

ContainerException

public ContainerException(java.lang.String pStr,
                          java.lang.Throwable pSourceException)

Constructs a new ContainerException with the given explanation.

Parameters:

pSourceException - the initial exception which was the root cause of the problem

ContainerException

public ContainerException(java.lang.Throwable pSourceException,
                          java.lang.String pErrorCode)

Throwable exception including an error code.

Parameters:

pSourceException - Throwable of the source exception.

pErrorCode - String of the error code.

ContainerException

public ContainerException(java.lang.String pStr,
                          java.lang.String pErrorCode)

Create an exception with a message and error code

Parameters:

pStr - the error message

pErrorCode - the error code

ContainerException

public ContainerException(java.lang.String pStr,
                          java.lang.String pErrorCode,
                          java.lang.Throwable pSourceException)

Create an exception with a message and error code

Parameters:

pStr - the error message

pErrorCode - the error code

pSourceException - the source exception, if any.

ContainerException

public ContainerException(java.lang.String pStr,
                          java.lang.String pErrorCode,
                          java.lang.Object... pAttributes)

Create an exception with a message, error code, dev message and more info

Parameters:

pStr - the error message

pErrorCode - the error code

pAttributes - additional attributes to associate with the error

ContainerException

public ContainerException(java.lang.String pStr,
                          java.lang.Throwable pSourceException,
                          java.lang.String pErrorCode,
                          java.lang.Object... pAttributes)

Create an exception with a message, source exception, error code, dev message and more info.

Parameters:

pStr - the error message

pSourceException - the source exception

pErrorCode - the error code

pAttributes - additional attributes to associate with the error

Method Detail

getNestedContainerException

protected ContainerException getNestedContainerException()

setNestedContainerException

protected void setNestedContainerException(ContainerException pNestedContainerException)

containsInheritableInfo

public boolean containsInheritableInfo()

Whether or not this exception includes inheritable data, i.e. error code or attributes.

Returns:

true if any of the inheritable fields are populated.

setSourceException

public void setSourceException(java.lang.Throwable pSourceException)

Sets property SourceException

getSourceException

public java.lang.Throwable getSourceException()

Returns property SourceException

Specified by:

getSourceException in interface ContainableException

Returns:

the initial exception which was the root cause of the problem

setMessageArguments

public void setMessageArguments(java.lang.Object[] pMessageArguments)

Sets the message arguments

Parameters:

pMessageArguments - Message arguments to set

getMessageArguments

public java.lang.Object[] getMessageArguments()

Return property MessageArguments

Returns:

arguments that go along with the exception's message.

getErrorCode

public java.lang.String getErrorCode()

Getter for an error code to associate with this error. This allows for a handler to uniquely identify the error. This is an optional field and may be null. Note, if no inheritable fields are set on this exception then any nested container exception will be used instead.

Returns:

error code for this error.

setErrorCode

public void setErrorCode(java.lang.String pErrorCode)

Setter for an error code to associate with this error. This allows for a handler to uniquely identify the error. This is an optional field and may be null.

Parameters:

pErrorCode - error code for this error.

getAttributes

public java.util.Map<java.lang.Object,java.lang.Object> getAttributes()

Getter for attributes to associate with the error Note, if no inheritable fields are set on this exception then any nested container exception will be used instead.

Returns:

map of key-value attributes

setAttributes

public void setAttributes(java.lang.Object... pAttributes)

printStackTrace

public void printStackTrace(boolean pDisplaySource)

Print our stack trace and optionally that of the source exception if there is one. Print to the standard error stream.

Parameters:

pDisplaySource - if true display the source exception info too

printStackTrace

public void printStackTrace(java.io.PrintStream pStream,
                            boolean pDisplaySource)

Print our stack trace and optionally that of the source exception if there is one. Print to the supplied stream.

Parameters:

pStream - Stream to print to

pDisplaySource - if true display the source exception info too

printStackTrace

public void printStackTrace(java.io.PrintWriter pWriter)

Print our stack trace and that of the source exception if there is one. Print to the supplied writer.

Overrides:

printStackTrace in class java.lang.Throwable

Parameters:

pWriter - writer to print to

printStackTrace

public void printStackTrace(java.io.PrintWriter pWriter,
                            boolean pDisplaySource)

Print our stack trace and optionally that of the source exception if there is one. Print to the supplied writer

Parameters:

pWriter - Writer to print to

pDisplaySource - if true display the source exception info too

toString

public java.lang.String toString()

Display information about this exception and that of the source exception if there is one.

Overrides:

toString in class java.lang.Throwable

toString

public java.lang.String toString(boolean pDisplaySource)

Display information about this exception and optionally that of the source exception if there is one.

Parameters:

pDisplaySource - if true display the source exception info

appendExtraInfo

protected void appendExtraInfo(java.lang.StringBuilder pSb)

Builds up a string for any extra information available, i.e. status code, error code, dev message or more info.

Parameters:

pSb - StringBuilder to append to.