com.novell.emframe.dev

Class PluginException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.novell.emframe.dev.PluginException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AuthBrokerException, AuthNotAuthenticatedException, BookException, eDirAccessServiceException, InvalidAuthMethodException, PageException

public class PluginException
extends java.lang.Exception

Exception generated by a plug-in.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PluginException(java.lang.Exception rootExceptionCause) Constructs an exception with a root cause.
PluginException(java.lang.String header, java.lang.String body) Constructs an exception with only a header and body.
PluginException(java.lang.String header, java.lang.String body, boolean rewriteURLs) Constructs an exception with only a header and body.
PluginException(java.lang.String header, java.lang.String body, boolean rewriteURLs, java.lang.Throwable cause)
PluginException(java.lang.String header, java.lang.String body, int errorCode) An exception for plugin errors.
PluginException(java.lang.String header, java.lang.String body, int errorCode, java.lang.Throwable cause)
PluginException(java.lang.String header, java.lang.String body, java.lang.String subText) An exception for plugin errors.
PluginException(java.lang.String header, java.lang.String body, java.lang.String subText, java.lang.Throwable cause)
PluginException(java.lang.String header, java.lang.String body, java.lang.Throwable cause)
PluginException(java.lang.Throwable rootCause) Constructs an exception with a root cause.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBody() Returns the body String.
java.lang.String	getBoldText() Returns the bolded String.
int	getErrorCode() Returns the (optional) error code.
java.lang.Exception	getException() Returns the root cause of this PluginException.
java.lang.String	getHeader() Returns the header String.
java.lang.String	getLocalizedMessage() Returns the localized message of the exception.
java.lang.String	getMessage() Returns the message of the exception.
boolean	getRewriteURLs() Returns if URLs should be rewritten.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, 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

Constructor Detail

PluginException

public PluginException(java.lang.String header,
                       java.lang.String body,
                       java.lang.String subText)

An exception for plugin errors. This exception is useful when you have messages like "Al.novell is not a valid user." Parameters in the error text can be substituted, such as usernames and other erroneous data.

Parameters:

header - The error header; if this parameter is null, the header is "Error"

body - The body of the error; for example: "{0} is not a valid user"

subText - The text to be substitute; for example: "Al.novell" replaces "{0}"

PluginException

public PluginException(java.lang.String header,
                       java.lang.String body,
                       java.lang.String subText,
                       java.lang.Throwable cause)

PluginException

public PluginException(java.lang.String header,
                       java.lang.String body)

Constructs an exception with only a header and body.

Parameters:

header - The error header; if this parameter is null, the header is "Error"

body - The body of the error; for example: "{0} is not a valid user"

PluginException

public PluginException(java.lang.String header,
                       java.lang.String body,
                       java.lang.Throwable cause)

PluginException

public PluginException(java.lang.String header,
                       java.lang.String body,
                       boolean rewriteURLs)

Constructs an exception with only a header and body.

Parameters:

header - The error header; if this parameter is null, the header is "Error"

body - The body of the error; for example: "{0} is not a valid user"

rewriteURLs - boolean should URLs be rewritten as non link text

PluginException

public PluginException(java.lang.String header,
                       java.lang.String body,
                       boolean rewriteURLs,
                       java.lang.Throwable cause)

PluginException

public PluginException(java.lang.String header,
                       java.lang.String body,
                       int errorCode)

An exception for plugin errors. This exception is useful when you have messages like "Al.novell is not a valid user."

Parameters:

header - The error header; if this parameter is null, the header is "Error"

body - The body of the error; for example: "{0} is not a valid user"

errorCode - The error code; for example: "-601"

PluginException

public PluginException(java.lang.String header,
                       java.lang.String body,
                       int errorCode,
                       java.lang.Throwable cause)

PluginException

public PluginException(java.lang.Exception rootExceptionCause)

Constructs an exception with a root cause.

Parameters:

rootExceptionCause - - Allow default error handling to take place; SPI and Namespace exceptions will show nice error message; others will show a system error and a stack trace (in a details button) todo this method should be replaced with the PluginException(Throwable) method

PluginException

public PluginException(java.lang.Throwable rootCause)

Constructs an exception with a root cause.

Parameters:

rootCause - - Allow default error handling to take place; SPI and Namespace exceptions will show nice error message; others will show a system error and a stack trace (in a details button)

Method Detail

getHeader

public java.lang.String getHeader()

Returns the header String.

Returns:

String containing the header message

getRewriteURLs

public boolean getRewriteURLs()

Returns if URLs should be rewritten.

Returns:

boolean Should URLs be rewritten

getBody

public java.lang.String getBody()

Returns the body String.

Returns:

String containing the body message

getBoldText

public java.lang.String getBoldText()

Returns the bolded String.

Returns:

String containing the text that should be bolded;

getMessage

public java.lang.String getMessage()

Returns the message of the exception.

Overrides:

getMessage in class java.lang.Throwable

Returns:

String containing the message of the exception

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Returns the localized message of the exception.

Overrides:

getLocalizedMessage in class java.lang.Throwable

Returns:

String containing the localized message of the exception

getException

public java.lang.Exception getException()

Returns the root cause of this PluginException. This will return null if this was not created from another exception using the PluginException(Exception) constructor.

Returns:

Exception that caused this to be thrown else null; Example SPI Exception todo this should be changed to a getThrowable() method at that time do not create the new Exception either

getErrorCode

public int getErrorCode()

Returns the (optional) error code.

Returns:

int containing the error number to return or 0 if it was not set