com.mentata.sg8
Class SG8Exception

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended bycom.mentata.l3d.L3DException
              extended bycom.mentata.sg8.SG8Exception
All Implemented Interfaces:
Serializable

public class SG8Exception
extends L3DException

An exception thrown within the SG8 gateway. This class extends the standard Java Exception class and is used to define and manage unexpected behaviors or invalid cases in SG8 servlet or JSP execution. It wraps JLDAP and L3D exceptions, provides additional localized descriptions of the problem, and is expressed through the error JSP.

Since:
0.7
Author:
Jon Roberts
See Also:
Serialized Form

Constructor Summary
SG8Exception(int code)
          Constructs an exception using properties defined for the given code.
SG8Exception(int code, String hint)
          Constructs an exception using properties defined for the given code.
SG8Exception(int code, String hint, Throwable cause)
          Constructs an exception using properties defined for the given code and cause.
SG8Exception(String hint)
          Constructs an exception with undefined code and given hint.
 
Method Summary
 int getSG8Code()
          Returns the code assigned to a causing exception.
 String getSG8Message()
          Returns the message assigned to this exception.
 
Methods inherited from class com.mentata.l3d.L3DException
getHint, getL3DCode, getL3DMessage, getLDAPCode, getLDAPMessage, getLocale, setLocale
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

SG8Exception

public SG8Exception(String hint)
Constructs an exception with undefined code and given hint.

Parameters:
hint - a key piece of information about the error

SG8Exception

public SG8Exception(int code)
Constructs an exception using properties defined for the given code.

Parameters:
code - the new error's identifier

SG8Exception

public SG8Exception(int code,
                    String hint)
Constructs an exception using properties defined for the given code.

Parameters:
code - the new error's identifier
hint - a key piece of information about the error

SG8Exception

public SG8Exception(int code,
                    String hint,
                    Throwable cause)
Constructs an exception using properties defined for the given code and cause.

Parameters:
code - the code for the error
hint - a key piece of information about the error
cause - the exception that provoked this L3D exception
Method Detail

getSG8Code

public int getSG8Code()
Returns the code assigned to a causing exception.

Returns:
the code number

getSG8Message

public String getSG8Message()
Returns the message assigned to this exception.

Returns:
the message