Package org.dogtagpki.legacy.policy
Class EPolicyException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- com.netscape.certsrv.base.EBaseException
-
- org.dogtagpki.legacy.policy.EPolicyException
-
- All Implemented Interfaces:
java.io.Serializable
public class EPolicyException extends EBaseException
This class represents Exceptions used by the policy package. The policies themselves do not raise exceptions but use them to format error messages. Adapted from EBasExceptionNOTE: The Policy Framework has been replaced by the Profile Framework.
- Version:
- $Revision$, $Date$
- See Also:
MessageFormat
, Serialized Form
-
-
Field Summary
-
Fields inherited from class com.netscape.certsrv.base.EBaseException
mParams
-
-
Constructor Summary
Constructors Constructor Description EPolicyException(java.lang.String msgFormat)
Constructs a base exception.EPolicyException(java.lang.String msgFormat, java.lang.Exception param)
Constructs a base exception.EPolicyException(java.lang.String msgFormat, java.lang.Object[] params)
Constructs a base exception with a list of parameters that will be substituted into the message format.EPolicyException(java.lang.String msgFormat, java.lang.String param)
Constructs a base exception with a parameter.EPolicyException(java.lang.String msgFormat, java.lang.String param1, java.lang.String param2)
Constructs a base exception with two String parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.String
getBundleName()
Returns the given resource bundle name.java.lang.Object[]
getParameters()
Returns a list of parameters.java.lang.String
toString()
Returns localized exception string.java.lang.String
toString(java.util.Locale locale)
Returns the string based on the given locale.
-
-
-
Constructor Detail
-
EPolicyException
public EPolicyException(java.lang.String msgFormat)
Constructs a base exception.- Parameters:
msgFormat
- exception details
-
EPolicyException
public EPolicyException(java.lang.String msgFormat, java.lang.String param)
Constructs a base exception with a parameter. For example,new EPolicyException("failed to load {0}", fileName);
- Parameters:
msgFormat
- exception details in message string formatparam
- message string parameter
-
EPolicyException
public EPolicyException(java.lang.String msgFormat, java.lang.String param1, java.lang.String param2)
Constructs a base exception with two String parameters. For example,- Parameters:
msgFormat
- exception details in message string formatparam1
- message string parameterparam2
- message string parameter
-
EPolicyException
public EPolicyException(java.lang.String msgFormat, java.lang.Exception param)
Constructs a base exception. It can be used to carry a system exception that may contain information about the context. For example,try { ... } catch (IOExeption e) { throw new EPolicyException("Encountered System Error {0}", e); }
- Parameters:
msgFormat
- exception details in message string formatparam
- system exception
-
EPolicyException
public EPolicyException(java.lang.String msgFormat, java.lang.Object[] params)
Constructs a base exception with a list of parameters that will be substituted into the message format.- Parameters:
msgFormat
- exception details in message string formatparams
- list of message format parameters
-
-
Method Detail
-
getParameters
public java.lang.Object[] getParameters()
Returns a list of parameters.- Overrides:
getParameters
in classEBaseException
- Returns:
- list of message format parameters
-
toString
public java.lang.String toString()
Returns localized exception string. This method should only be called if a localized string is necessary.- Overrides:
toString
in classEBaseException
- Returns:
- details message
-
toString
public java.lang.String toString(java.util.Locale locale)
Returns the string based on the given locale.- Overrides:
toString
in classEBaseException
- Parameters:
locale
- locale- Returns:
- details message
-
getBundleName
protected java.lang.String getBundleName()
Description copied from class:EBaseException
Returns the given resource bundle name.- Overrides:
getBundleName
in classEBaseException
- Returns:
- the name of the resource bundle for this class.
-
-