com.novell.emframe.dev
Class AuthBrokerException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.novell.emframe.dev.PluginException
              com.novell.emframe.dev.AuthBrokerException

All Implemented Interfaces:

java.io.Serializable

public final class AuthBrokerException

extends PluginException

Exception generated by the AuthenticationBroker.

See Also:

Serialized Form

Constructor Summary

AuthBrokerException(java.lang.Exception e)
Constructs an exception with a root cause.

AuthBrokerException(java.lang.String message)
Provide a new constructor that will only take 1 String parameter and call the superclass with the appropriate arguments.

AuthBrokerException(java.lang.String header, java.lang.String body)
Constructs an exception with only a header and body.

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

Methods inherited from class com.novell.emframe.dev.PluginException

getBody, getBoldText, getErrorCode, getException, getHeader, getLocalizedMessage, getMessage

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

AuthBrokerException

public AuthBrokerException(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)

AuthBrokerException

public AuthBrokerException(java.lang.String message)

Provide a new constructor that will only take 1 String parameter and call the superclass with the appropriate arguments.

Parameters:

message - Example: "Unable to authenticate"

AuthBrokerException

public AuthBrokerException(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"

AuthBrokerException

public AuthBrokerException(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"