com.pingidentity.pa.sdk.localization

Enum ErrorDescription

java.lang.Object

java.lang.Enum<ErrorDescription>

com.pingidentity.pa.sdk.localization.ErrorDescription

All Implemented Interfaces:

Serializable, Comparable<ErrorDescription>

public enum ErrorDescription
extends Enum<ErrorDescription>

Enum with descriptions for common errors

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS_DENIED
PAGE_NOT_FOUND_404
POLICY_ERROR

Method Summary

Modifier and Type	Method and Description
String	getDescription(String... substitutions) Gets a description that will not be localized.
String	getLocalizationKey() Gets the key used to resolve the localized error description.
static ErrorDescription	valueOf(String name) Returns the enum constant of this type with the specified name.
static ErrorDescription[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PAGE_NOT_FOUND_404

public static final ErrorDescription PAGE_NOT_FOUND_404

POLICY_ERROR

public static final ErrorDescription POLICY_ERROR

ACCESS_DENIED

public static final ErrorDescription ACCESS_DENIED

Method Detail

values

public static ErrorDescription[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ErrorDescription c : ErrorDescription.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ErrorDescription valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getLocalizationKey

public String getLocalizationKey()

Gets the key used to resolve the localized error description. The key is used to look up properties in ResourceBundle property files located at conf/localization in the PingAccess installation.

Returns:

The key used in the resource bundle

See Also:

ResourceBundle Documentation

getDescription

public String getDescription(String... substitutions)

Gets a description that will not be localized. This is commonly used for logging and exception messages.

If the description contains place holders in the form '{0}', '{1}', '{2}', etc, they will be replaced with the substitutions vararg.

For example:
description = "{0} and {1} went up the {2}."
getDescription("Jack", "Jill", "hill") = "Jack and Jill went up the hill."

Parameters:

substitutions - the substitution values for the description message

Returns:

A non-localized description of the error with place holders replaced with substitutions