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, BookException, eDirAccessServiceException, PageException

public class PluginException

extends java.lang.Exception

Exception generated by a plug-in.

See Also:

Serialized Form

Constructor Summary

PluginException(java.lang.Exception e)
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, int errorCode)
An exception for authentication errors - with an error code.

PluginException(java.lang.String header, java.lang.String body, java.lang.String boldText)
An exception for authentication errors.

Method Summary

java.lang.String	getBody() Returns the body String.
java.lang.String	getBoldText() Returns the bolded String.
int	getErrorCode() Returns the error code.
java.lang.Exception	getException() Returns the root cause of the exception.
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.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getStackTrace, 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.Exception e)

Constructs an exception with a root cause.

Parameters:

e - - 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)

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,
                       int errorCode)

An exception for authentication errors - with an error code. 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,
                       java.lang.String boldText)

An exception for authentication errors. This exception is useful when you have messages like "Al.novell is not a valid user." Parameters in the error text can be bolded, 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"

boldText - The text to be bolded; for example: "Al.novell"

Method Detail

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;

getErrorCode

public int getErrorCode()

Returns the error code.

Returns:

int containing the error number to return

getException

public java.lang.Exception getException()

Returns the root cause of the exception. This will return null if this was not created from another exception.

Returns:

Exception that caused this to be thrown; Example SPI Exception

getHeader

public java.lang.String getHeader()

Returns the header String.

Returns:

String containing the header message

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Returns the localized message of the exception.

Returns:

String containing the localized message of the exception

getMessage

public java.lang.String getMessage()

Returns the message of the exception.

Returns:

String containing the message of the exception