com.sun.identity.policy

Class InvalidFormatException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.policy.PolicyException

com.sun.identity.policy.InvalidFormatException

All Implemented Interfaces:

L10NMessage, Serializable

public class InvalidFormatException
extends PolicyException

Exception thrown if a name of an object such as policy, rule or referral has invalid format

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sun.identity.policy.PolicyException

CONDITION_COLLECTION, ORGANIZATION, POLICY, REFERRAL_COLLECTION, REFERRAL_TYPE, RESPONSE_PROVIDER_COLLECTION, RULE, SERVICE, SUBJECT_TYPE, USER_COLLECTION

Constructor Summary

Constructors

Constructor and Description
InvalidFormatException(String msg, String name, int type) Constructs a InvalidFormatException instance.
InvalidFormatException(String rbName, String errCode, Object[] args, String name, int type) Constructs a InvalidFormatException instance.
InvalidFormatException(String rbName, String errCode, Object[] args, Throwable t, String name, int type) Constructs a InvalidFormatException instance.
InvalidFormatException(Throwable t, String name, int type) Constructs a InvalidFormatException instance.

Method Summary

Modifier and Type	Method and Description
String	getCompleteL10NMessage(Locale locale)
String	getErrorCode() Use this method to chain this exception with another to get localized error messge use getL10NMessage method
String	getL10NMessage(Locale locale) Use this method to get localized error message directly.
String	getMessage() Gets messages of the exceptions including the chained exceptions
Object[]	getMessageArgs() Use this method to chain this exception with another to get localized error messge use getL10NMessage method
String	getName() Gets the name of the object that encountered an invalid format.
Throwable	getNestedException()
int	getObjectType() Gets the type of object which encountered the invalid name.
String	getResourceBundleName() Use this method to chain this exception with another to get localized error messge use getL10NMessage method
void	printStackTrace() Prints the stack trace of the root exception to standard error stream.
void	printStackTrace(PrintStream ps) Prints the stack trace of the root exception to a PrintStream Also prints the messages of all the exceptions starting from top exception to the root exception, at the top of stack trace
void	printStackTrace(PrintWriter pw) Prints the stack trace of the root exception to a PrintWriter Also prints the messages of all the exceptions starting from top exception to the root exception, at the top of stack trace

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidFormatException

public InvalidFormatException(String msg,
                              String name,
                              int type)

Constructs a InvalidFormatException instance.

Parameters:

msg - exception message

name - name that was in invalid format

type - type of object that had invalid name format

InvalidFormatException

public InvalidFormatException(Throwable t,
                              String name,
                              int type)

Constructs a InvalidFormatException instance.

Parameters:

t - nested root cause exception

name - name that was in invalid format

type - type of object that had invalid name format

InvalidFormatException

public InvalidFormatException(String rbName,
                              String errCode,
                              Object[] args,
                              Throwable t,
                              String name,
                              int type)

Constructs a InvalidFormatException instance.

Parameters:

rbName - Resource bundle name of exception message

errCode - id used with resource bundle to get error message

args - any arguments for message formatting. null if no additional arguments are necessary

t - nested root cause exception

name - name that was in invalid format

type - type of object that had invalid name format

InvalidFormatException

public InvalidFormatException(String rbName,
                              String errCode,
                              Object[] args,
                              String name,
                              int type)

Constructs a InvalidFormatException instance.

Parameters:

rbName - Resource bundle name of exception message

errCode - id used with resource bundle to get error message

args - any arguments for message formatting. null if no additional arguments are necessary

name - name that was in invalid format

type - type of object that had invalid name format

Method Detail

getName

public String getName()

Gets the name of the object that encountered an invalid format.

Returns:

name that was in invalid format

getObjectType

public int getObjectType()

Gets the type of object which encountered the invalid name. The defined objects are POLICY, RULE, ORGANIZATION, USER_COLLECTION RESPONSE_PROVIDER_COLLECTION CONDITION_COLLECTION REFERRAL_COLLECTION REFERRAL_TYPE SUBJECT_TYPE and SERVICE

Returns:

type of object that had invalid name format

getL10NMessage

public String getL10NMessage(Locale locale)

Description copied from interface: L10NMessage

Use this method to get localized error message directly.

Specified by:

getL10NMessage in interface L10NMessage

Parameters:

locale - Locale to be used.

Returns:

String localized error message.

See Also:

ChainedException(String, String, Object[], Throwable)

getCompleteL10NMessage

public String getCompleteL10NMessage(Locale locale)

Parameters:

locale - Locale to be used.

Returns:

String localized error message.

See Also:

ChainedException(String, String, Object[], Throwable)

getResourceBundleName

public String getResourceBundleName()

Description copied from interface: L10NMessage

Use this method to chain this exception with another to get localized error messge use getL10NMessage method

Specified by:

getResourceBundleName in interface L10NMessage

Returns:

ResourceBundle Name associated with this error message.

See Also:

ChainedException(String, String, Object[], Throwable), - to get localized error message.

getErrorCode

public String getErrorCode()

Description copied from interface: L10NMessage

Use this method to chain this exception with another to get localized error messge use getL10NMessage method

Specified by:

getErrorCode in interface L10NMessage

Returns:

Error code associated with this error message.

See Also:

ChainedException(String, String, Object[], Throwable), - to get localized error message.

getMessageArgs

public Object[] getMessageArgs()

Description copied from interface: L10NMessage

Use this method to chain this exception with another to get localized error messge use getL10NMessage method

Specified by:

getMessageArgs in interface L10NMessage

Returns:

arguments for formatting this error message. You need to use MessageFormat class to format the message It can be null.

See Also:

ChainedException(String, String, Object[], Throwable), - to get localized error message.

getMessage

public String getMessage()

Gets messages of the exceptions including the chained exceptions

Specified by:

getMessage in interface L10NMessage

Overrides:

getMessage in class Throwable

Returns:

messages of the exceptions including chained exceptions. The returned string is formed by concatenating messages of all the exceptions, with a new line separator, starting from this exception, all the way to the root exception, by following the chained exceptions.

printStackTrace

public void printStackTrace()

Prints the stack trace of the root exception to standard error stream. Also prints the messages of all the exceptions starting from top exception to the root exception, at the top of stack trace

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintWriter pw)

Prints the stack trace of the root exception to a PrintWriter Also prints the messages of all the exceptions starting from top exception to the root exception, at the top of stack trace

Overrides:

printStackTrace in class Throwable

Parameters:

pw - PrintWriter to which to print the stack trace

printStackTrace

public void printStackTrace(PrintStream ps)

Prints the stack trace of the root exception to a PrintStream Also prints the messages of all the exceptions starting from top exception to the root exception, at the top of stack trace

Overrides:

printStackTrace in class Throwable

Parameters:

ps - PrintStream to which to print the stack trace

getNestedException

public Throwable getNestedException()