issrg.pba.rbac
Class PkiException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by issrg.utils.EmbeddedException
              extended by issrg.pba.PbaException
                  extended by issrg.pba.rbac.PkiException
All Implemented Interfaces:
java.io.Serializable

public class PkiException
extends PbaException

This class represents a PKI exception condition. It is thrown by the PKI routines when they are used by the PBA API, and are simply propagated to the caller.

Example:
try{
...
}catch(PbaException pe){
...
}

in this example the caller does not care if it was an error caused by the PKI or not. It just performs some simple routine error-handling.

Example:
try{
...
}catch(PkiException pe){
... // PKI-specific error-handling here
}catch(PbaException pe){
...
}

however, in this example the caller distinguishes between PKI errors and the other kinds of errors. It now can handle the PKI errors in a different way.

Version:
0.2
Author:
A Otenko, E Ball, D W Chadwick
See Also:
Serialized Form

Constructor Summary
PkiException()
          The default constructor builds an exception with no explanation message and no embedded exception.
PkiException(java.lang.String msg)
          This constructor builds an exception with a message but no embedded exception.
PkiException(java.lang.String msg, java.lang.Throwable th)
          This constructor builds an exception with a message and an embedded exception to be returned by getEmbedded method.
 
Method Summary
 
Methods inherited from class issrg.utils.EmbeddedException
getEmbedded, printStackTrace, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PkiException

public PkiException()
The default constructor builds an exception with no explanation message and no embedded exception.


PkiException

public PkiException(java.lang.String msg)
This constructor builds an exception with a message but no embedded exception.

Parameters:
msg - is the String message explaining the error; can be null

PkiException

public PkiException(java.lang.String msg,
                    java.lang.Throwable th)
This constructor builds an exception with a message and an embedded exception to be returned by getEmbedded method.

Parameters:
msg - is the String explanation of the error; can be null
th - is the Throwable object to be believed the cause of the error; can be null, if there is no embedded exception
See Also:
EmbeddedException.getEmbedded()