Package com.sun.identity.entitlement

Class EntitlementException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.entitlement.EntitlementException

All Implemented Interfaces:

Serializable

@SupportedAll
public class EntitlementException
extends Exception

Entitlement related exception.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AM_ID_SUBJECT_MEMBERSHIP_EVALUATION_ERROR
static final int	APP_NOT_DELETED_POLICIES_EXIST
static final int	APP_RETRIEVAL_ERROR
static final int	APPLICATION_ALREADY_EXISTS
static final int	APPLICATION_NAME_MISMATCH
static final int	APPLICATION_SEARCH_FAILED
static final int	APPLICATION_TYPE_NOT_FOUND
static final int	AT_LEAST_ONE_OF_TIME_PROPS_SHOULD_BE_DEFINED
static final int	AUTH_LEVEL_NOT_INT_OR_SET
static final int	AUTH_LEVEL_NOT_INTEGER
static final int	AUTH_SCHEME_NOT_FOUND
static final int	AUTHENTICATION_ERROR
static final int	CLIENT_IP_EMPTY
static final int	CONDITION_EVALUATION_FAILED
static final int	EMPTY_PRIVILEGE_NAME
static final int	END_IP_BEFORE_START_IP
static final int	INACTIVE_SUBJECT
static final int	INCONSISTENT_WILDCARDS
static final int	INTERNAL_ERROR
static final int	INVALID_ADMIN
static final int	INVALID_APP_REALM
static final int	INVALID_APP_TYPE
static final int	INVALID_APPLICATION_CLASS
static final int	INVALID_CLASS
static final int	INVALID_ENTITLEMENT_SUBJECT_CLASS
static final int	INVALID_EXPIRATION_DATE
static final int	INVALID_JSON
static final int	INVALID_OAUTH2_SCOPE
static final int	INVALID_PORT
static final int	INVALID_PRIVILEGE_CLASS
static final int	INVALID_PROPERTY_VALUE
static final int	INVALID_PROPERTY_VALUE_UNKNOWN_VALUE
static final int	INVALID_QUERY_FILTER
static final int	INVALID_QUERY_ID
static final int	INVALID_RESOURCE
static final int	INVALID_RESOURCE_TYPE
static final int	INVALID_SCRIPT_ID
static final int	INVALID_SEARCH_FILTER
static final int	INVALID_VALUE
static final int	INVALID_WSDL_LOCATION
static final int	INVALID_XML
static final int	IP_CONDITION_CONFIGURATION_REQUIRED
static final int	JSON_PARSE_ERROR
static final int	MALFORMED_URL
static final int	MISSING_APPLICATION_NAME
static final int	MISSING_CLIENT_ID
static final int	MISSING_PRIVILEGE_JSON
static final int	MISSING_PRIVILEGE_NAME
static final int	MISSING_RESOURCE
static final int	MISSING_RESOURCE_TYPE
static final int	MISSING_RESOURCE_TYPE_NAME
static final int	MODIFY_APPLICATION_FAIL
static final int	MODIFY_RESOURCE_TYPE_FAIL
static final int	NO_RESOURCE_TYPE_EXPECTED
static final int	NO_RESOURCE_TYPE_MATCH_FOUND
static final int	NO_SUCH_APPLICATION
static final int	NO_SUCH_POLICY
static final int	NO_SUCH_REFERRAL_PRIVILEGE
static final int	NO_SUCH_RESOURCE_TYPE
static final int	NOT_FOUND
static final int	NULL_ENTITLEMENT
static final int	PAIR_PROPERTY_NOT_DEFINED
static final int	PERMISSION_DENIED
static final int	POLICY_ALREADY_EXISTS
static final int	POLICY_CLASS_CAST_EXCEPTION
static final int	POLICY_CLASS_NOT_ACCESSIBLE
static final int	POLICY_CLASS_NOT_INSTANTIABLE
static final int	POLICY_DEFINES_INVALID_RESOURCE_TYPE
static final int	POLICY_NAME_MISMATCH
static final int	POLICY_RESOURCE_TYPE_NOT_DEFINED
static final int	PROPERTY_CONTAINS_BLANK_VALUE
static final int	PROPERTY_IS_NOT_A_SET
static final int	PROPERTY_IS_NOT_AN_INTEGER
static final int	PROPERTY_VALUE_NOT_DEFINED
static final int	QUERY_ID_MISSING_UID
static final int	REALM_NOT_FOUND
static final int	REMOVE_APPLICATION_FAIL
static final int	REMOVE_RESOURCE_TYPE_FAIL
static final String	RES_BUNDLE_NAME
static final int	RESOURCE_ENV_NOT_KNOWN
static final int	RESOURCE_LIST_EMPTY
static final int	RESOURCE_TYPE_ALREADY_EXISTS
static final int	RESOURCE_TYPE_ID_MISMATCH
static final int	RESOURCE_TYPE_IN_USE
static final int	RESOURCE_TYPE_REFERENCED
static final int	RESOURCE_TYPE_RETRIEVAL_ERROR
static final int	SESSION_HAS_EXPIRED
static final int	START_DATE_AFTER_END_DATE
static final int	SUBJECT_REQUIRED
static final int	TRANSACTION_STORAGE_FAILURE
static final int	TRANSACTION_STORE_READ_FAILURE
static final int	UNABLE_SEARCH_PRIVILEGES
static final int	UNABLE_SEARCH_PRIVILEGES_MISSING_TOKEN
static final int	UNABLE_TO_CREATE_POLICY
static final int	UNABLE_TO_CREATE_SUBJECT_INDEX
static final int	UNABLE_TO_PARSE_SSOTOKEN_AUTHINSTANT
static final int	UNABLE_TO_QUERY_POLICY_INVALID_UID
static final int	UNABLE_TO_READ_REALM_ATTRIBUTES
static final int	UNABLE_TO_RETRIEVE_SUBJECT_ATTRIBUTE
static final int	UNABLE_TO_SERIALIZE_OBJECT
static final int	UNKNOWN_IDENTITY
static final int	UNKNOWN_POLICY_CLASS
static final int	UNKNOWN_RESOURCE_ATTRIBUTE_CLASS
static final int	UNSUPPORTED_OPERATION
static final int	UNSUPPORTED_SUBJECT_INDEX

Constructor Summary

Constructors

Constructor	Description
EntitlementException(int errorCode)	Creates an entitlement exception.
EntitlementException(int errorCode, Object... params)	Creates an entitlement exception.
EntitlementException(int errorCode, Object[] params, Throwable cause)	Creates an entitlement exception.
EntitlementException(int errorCode, Throwable cause)	Creates an entitlement exception.
EntitlementException(int errorCode, Throwable cause, Object... params)

Method Summary

Modifier and Type	Method	Description
int	getErrorCode()	Returns error code.
String	getLocalizedMessage()	Returns localized exception message.
String	getLocalizedMessage(Locale locale)	Returns localized exception message using the errorCode as key.
String	getMessage()	Returns exception message.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Details

RES_BUNDLE_NAME

public static final String RES_BUNDLE_NAME

See Also:

• Constant Field Values

UNABLE_TO_CREATE_POLICY

public static final int UNABLE_TO_CREATE_POLICY

See Also:

• Constant Field Values

INVALID_PRIVILEGE_CLASS

public static final int INVALID_PRIVILEGE_CLASS

See Also:

• Constant Field Values

EMPTY_PRIVILEGE_NAME

public static final int EMPTY_PRIVILEGE_NAME

See Also:

• Constant Field Values

NULL_ENTITLEMENT

public static final int NULL_ENTITLEMENT

See Also:

• Constant Field Values

UNSUPPORTED_OPERATION

public static final int UNSUPPORTED_OPERATION

See Also:

• Constant Field Values

INVALID_APPLICATION_CLASS

public static final int INVALID_APPLICATION_CLASS

See Also:

• Constant Field Values

INVALID_XML

public static final int INVALID_XML

See Also:

• Constant Field Values

INVALID_WSDL_LOCATION

public static final int INVALID_WSDL_LOCATION

See Also:

• Constant Field Values

MISSING_PRIVILEGE_JSON

public static final int MISSING_PRIVILEGE_JSON

See Also:

• Constant Field Values

SESSION_HAS_EXPIRED

public static final int SESSION_HAS_EXPIRED

See Also:

• Constant Field Values

INVALID_JSON

public static final int INVALID_JSON

See Also:

• Constant Field Values

MISSING_PRIVILEGE_NAME

public static final int MISSING_PRIVILEGE_NAME

See Also:

• Constant Field Values

POLICY_NAME_MISMATCH

public static final int POLICY_NAME_MISMATCH

See Also:

• Constant Field Values

RESOURCE_LIST_EMPTY

public static final int RESOURCE_LIST_EMPTY

See Also:

• Constant Field Values

RESOURCE_TYPE_ID_MISMATCH

public static final int RESOURCE_TYPE_ID_MISMATCH

See Also:

• Constant Field Values

UNSUPPORTED_SUBJECT_INDEX

public static final int UNSUPPORTED_SUBJECT_INDEX

See Also:

• Constant Field Values

UNABLE_TO_CREATE_SUBJECT_INDEX

public static final int UNABLE_TO_CREATE_SUBJECT_INDEX

See Also:

• Constant Field Values

UNKNOWN_IDENTITY

public static final int UNKNOWN_IDENTITY

See Also:

• Constant Field Values

UNABLE_TO_QUERY_POLICY_INVALID_UID

public static final int UNABLE_TO_QUERY_POLICY_INVALID_UID

See Also:

• Constant Field Values

UNABLE_TO_SERIALIZE_OBJECT

public static final int UNABLE_TO_SERIALIZE_OBJECT

See Also:

• Constant Field Values

NO_SUCH_POLICY

public static final int NO_SUCH_POLICY

See Also:

• Constant Field Values

UNABLE_SEARCH_PRIVILEGES

public static final int UNABLE_SEARCH_PRIVILEGES

See Also:

• Constant Field Values

UNABLE_SEARCH_PRIVILEGES_MISSING_TOKEN

public static final int UNABLE_SEARCH_PRIVILEGES_MISSING_TOKEN

See Also:

• Constant Field Values

POLICY_ALREADY_EXISTS

public static final int POLICY_ALREADY_EXISTS

See Also:

• Constant Field Values

RESOURCE_TYPE_ALREADY_EXISTS

public static final int RESOURCE_TYPE_ALREADY_EXISTS

See Also:

• Constant Field Values

NO_SUCH_RESOURCE_TYPE

public static final int NO_SUCH_RESOURCE_TYPE

See Also:

• Constant Field Values

RESOURCE_TYPE_IN_USE

public static final int RESOURCE_TYPE_IN_USE

See Also:

• Constant Field Values

RESOURCE_TYPE_RETRIEVAL_ERROR

public static final int RESOURCE_TYPE_RETRIEVAL_ERROR

See Also:

• Constant Field Values

APPLICATION_ALREADY_EXISTS

public static final int APPLICATION_ALREADY_EXISTS

See Also:

• Constant Field Values

APPLICATION_NAME_MISMATCH

public static final int APPLICATION_NAME_MISMATCH

See Also:

• Constant Field Values

REMOVE_APPLICATION_FAIL

public static final int REMOVE_APPLICATION_FAIL

See Also:

• Constant Field Values

MODIFY_APPLICATION_FAIL

public static final int MODIFY_APPLICATION_FAIL

See Also:

• Constant Field Values

REMOVE_RESOURCE_TYPE_FAIL

public static final int REMOVE_RESOURCE_TYPE_FAIL

See Also:

• Constant Field Values

MODIFY_RESOURCE_TYPE_FAIL

public static final int MODIFY_RESOURCE_TYPE_FAIL

See Also:

• Constant Field Values

RESOURCE_TYPE_REFERENCED

public static final int RESOURCE_TYPE_REFERENCED

See Also:

• Constant Field Values

POLICY_DEFINES_INVALID_RESOURCE_TYPE

public static final int POLICY_DEFINES_INVALID_RESOURCE_TYPE

See Also:

• Constant Field Values

MISSING_RESOURCE_TYPE

public static final int MISSING_RESOURCE_TYPE

See Also:

• Constant Field Values

INVALID_RESOURCE_TYPE

public static final int INVALID_RESOURCE_TYPE

See Also:

• Constant Field Values

NO_RESOURCE_TYPE_EXPECTED

public static final int NO_RESOURCE_TYPE_EXPECTED

See Also:

• Constant Field Values

MISSING_APPLICATION_NAME

public static final int MISSING_APPLICATION_NAME

See Also:

• Constant Field Values

APP_RETRIEVAL_ERROR

public static final int APP_RETRIEVAL_ERROR

See Also:

• Constant Field Values

MISSING_RESOURCE_TYPE_NAME

public static final int MISSING_RESOURCE_TYPE_NAME

See Also:

• Constant Field Values

NO_SUCH_REFERRAL_PRIVILEGE

public static final int NO_SUCH_REFERRAL_PRIVILEGE

See Also:

• Constant Field Values

NO_RESOURCE_TYPE_MATCH_FOUND

public static final int NO_RESOURCE_TYPE_MATCH_FOUND

See Also:

• Constant Field Values

INCONSISTENT_WILDCARDS

public static final int INCONSISTENT_WILDCARDS

See Also:

• Constant Field Values

INVALID_PORT

public static final int INVALID_PORT

See Also:

• Constant Field Values

MALFORMED_URL

public static final int MALFORMED_URL

See Also:

• Constant Field Values

INVALID_RESOURCE

public static final int INVALID_RESOURCE

See Also:

• Constant Field Values

INVALID_ENTITLEMENT_SUBJECT_CLASS

public static final int INVALID_ENTITLEMENT_SUBJECT_CLASS

See Also:

• Constant Field Values

INVALID_CLASS

public static final int INVALID_CLASS

See Also:

• Constant Field Values

INVALID_APP_TYPE

public static final int INVALID_APP_TYPE

See Also:

• Constant Field Values

INVALID_APP_REALM

public static final int INVALID_APP_REALM

See Also:

• Constant Field Values

APPLICATION_TYPE_NOT_FOUND

public static final int APPLICATION_TYPE_NOT_FOUND

See Also:

• Constant Field Values

NO_SUCH_APPLICATION

public static final int NO_SUCH_APPLICATION

See Also:

• Constant Field Values

NOT_FOUND

public static final int NOT_FOUND

See Also:

• Constant Field Values

PERMISSION_DENIED

public static final int PERMISSION_DENIED

See Also:

• Constant Field Values

SUBJECT_REQUIRED

public static final int SUBJECT_REQUIRED

See Also:

• Constant Field Values

INVALID_SEARCH_FILTER

public static final int INVALID_SEARCH_FILTER

See Also:

• Constant Field Values

UNKNOWN_POLICY_CLASS

public static final int UNKNOWN_POLICY_CLASS

See Also:

• Constant Field Values

UNKNOWN_RESOURCE_ATTRIBUTE_CLASS

public static final int UNKNOWN_RESOURCE_ATTRIBUTE_CLASS

See Also:

• Constant Field Values

POLICY_CLASS_CAST_EXCEPTION

public static final int POLICY_CLASS_CAST_EXCEPTION

See Also:

• Constant Field Values

POLICY_CLASS_NOT_INSTANTIABLE

public static final int POLICY_CLASS_NOT_INSTANTIABLE

See Also:

• Constant Field Values

POLICY_CLASS_NOT_ACCESSIBLE

public static final int POLICY_CLASS_NOT_ACCESSIBLE

See Also:

• Constant Field Values

INVALID_PROPERTY_VALUE

public static final int INVALID_PROPERTY_VALUE

See Also:

• Constant Field Values

INVALID_VALUE

public static final int INVALID_VALUE

See Also:

• Constant Field Values

START_DATE_AFTER_END_DATE

public static final int START_DATE_AFTER_END_DATE

See Also:

• Constant Field Values

APP_NOT_DELETED_POLICIES_EXIST

public static final int APP_NOT_DELETED_POLICIES_EXIST

See Also:

• Constant Field Values

INVALID_PROPERTY_VALUE_UNKNOWN_VALUE

public static final int INVALID_PROPERTY_VALUE_UNKNOWN_VALUE

See Also:

• Constant Field Values

IP_CONDITION_CONFIGURATION_REQUIRED

public static final int IP_CONDITION_CONFIGURATION_REQUIRED

See Also:

• Constant Field Values

INACTIVE_SUBJECT

public static final int INACTIVE_SUBJECT

See Also:

• Constant Field Values

MISSING_RESOURCE

public static final int MISSING_RESOURCE

See Also:

• Constant Field Values

JSON_PARSE_ERROR

public static final int JSON_PARSE_ERROR

See Also:

• Constant Field Values

AUTHENTICATION_ERROR

public static final int AUTHENTICATION_ERROR

See Also:

• Constant Field Values

CLIENT_IP_EMPTY

public static final int CLIENT_IP_EMPTY

See Also:

• Constant Field Values

RESOURCE_ENV_NOT_KNOWN

public static final int RESOURCE_ENV_NOT_KNOWN

See Also:

• Constant Field Values

APPLICATION_SEARCH_FAILED

public static final int APPLICATION_SEARCH_FAILED

See Also:

• Constant Field Values

INVALID_QUERY_FILTER

public static final int INVALID_QUERY_FILTER

See Also:

• Constant Field Values

INVALID_QUERY_ID

public static final int INVALID_QUERY_ID

See Also:

• Constant Field Values

QUERY_ID_MISSING_UID

public static final int QUERY_ID_MISSING_UID

See Also:

• Constant Field Values

CONDITION_EVALUATION_FAILED

public static final int CONDITION_EVALUATION_FAILED

See Also:

• Constant Field Values

UNABLE_TO_RETRIEVE_SUBJECT_ATTRIBUTE

public static final int UNABLE_TO_RETRIEVE_SUBJECT_ATTRIBUTE

See Also:

• Constant Field Values

INVALID_OAUTH2_SCOPE

public static final int INVALID_OAUTH2_SCOPE

See Also:

• Constant Field Values

AUTH_LEVEL_NOT_INTEGER

public static final int AUTH_LEVEL_NOT_INTEGER

See Also:

• Constant Field Values

PROPERTY_VALUE_NOT_DEFINED

public static final int PROPERTY_VALUE_NOT_DEFINED

See Also:

• Constant Field Values

AUTH_LEVEL_NOT_INT_OR_SET

public static final int AUTH_LEVEL_NOT_INT_OR_SET

See Also:

• Constant Field Values

AUTH_SCHEME_NOT_FOUND

public static final int AUTH_SCHEME_NOT_FOUND

See Also:

• Constant Field Values

INVALID_ADMIN

public static final int INVALID_ADMIN

See Also:

• Constant Field Values

AM_ID_SUBJECT_MEMBERSHIP_EVALUATION_ERROR

public static final int AM_ID_SUBJECT_MEMBERSHIP_EVALUATION_ERROR

See Also:

• Constant Field Values

UNABLE_TO_PARSE_SSOTOKEN_AUTHINSTANT

public static final int UNABLE_TO_PARSE_SSOTOKEN_AUTHINSTANT

See Also:

• Constant Field Values

AT_LEAST_ONE_OF_TIME_PROPS_SHOULD_BE_DEFINED

public static final int AT_LEAST_ONE_OF_TIME_PROPS_SHOULD_BE_DEFINED

See Also:

• Constant Field Values

PAIR_PROPERTY_NOT_DEFINED

public static final int PAIR_PROPERTY_NOT_DEFINED

See Also:

• Constant Field Values

END_IP_BEFORE_START_IP

public static final int END_IP_BEFORE_START_IP

See Also:

• Constant Field Values

INVALID_SCRIPT_ID

public static final int INVALID_SCRIPT_ID

See Also:

• Constant Field Values

INVALID_EXPIRATION_DATE

public static final int INVALID_EXPIRATION_DATE

See Also:

• Constant Field Values

MISSING_CLIENT_ID

public static final int MISSING_CLIENT_ID

See Also:

• Constant Field Values

PROPERTY_IS_NOT_AN_INTEGER

public static final int PROPERTY_IS_NOT_AN_INTEGER

See Also:

• Constant Field Values

PROPERTY_IS_NOT_A_SET

public static final int PROPERTY_IS_NOT_A_SET

See Also:

• Constant Field Values

PROPERTY_CONTAINS_BLANK_VALUE

public static final int PROPERTY_CONTAINS_BLANK_VALUE

See Also:

• Constant Field Values

TRANSACTION_STORAGE_FAILURE

public static final int TRANSACTION_STORAGE_FAILURE

See Also:

• Constant Field Values

TRANSACTION_STORE_READ_FAILURE

public static final int TRANSACTION_STORE_READ_FAILURE

See Also:

• Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

See Also:

• Constant Field Values

REALM_NOT_FOUND

public static final int REALM_NOT_FOUND

See Also:

• Constant Field Values

UNABLE_TO_READ_REALM_ATTRIBUTES

public static final int UNABLE_TO_READ_REALM_ATTRIBUTES

See Also:

• Constant Field Values

POLICY_RESOURCE_TYPE_NOT_DEFINED

public static final int POLICY_RESOURCE_TYPE_NOT_DEFINED

See Also:

• Constant Field Values

Constructor Details

EntitlementException

public EntitlementException(int errorCode)

Creates an entitlement exception.

Parameters:

errorCode - Error code.

EntitlementException

public EntitlementException(int errorCode,
 Object... params)

Creates an entitlement exception.

Parameters:

errorCode - Error code.

params - Parameters for formatting the message string.

EntitlementException

public EntitlementException(int errorCode,
 Throwable cause)

Creates an entitlement exception.

Parameters:

errorCode - Error code.

cause - Root cause.

EntitlementException

public EntitlementException(int errorCode,
 Object[] params,
 Throwable cause)

Creates an entitlement exception.

Parameters:

errorCode - Error code.

params - Parameters for formatting the message string.

cause - Root cause.

EntitlementException

public EntitlementException(int errorCode,
 Throwable cause,
 Object... params)

Method Details

getErrorCode

public int getErrorCode()

Returns error code.

Returns:

error code.

getMessage

public String getMessage()

Returns exception message.

Overrides:

getMessage in class Throwable

Returns:

exception message.

getLocalizedMessage

public String getLocalizedMessage()

Returns localized exception message.

Overrides:

getLocalizedMessage in class Throwable

Returns:

localized exception message.

getLocalizedMessage

public String getLocalizedMessage(Locale locale)

Returns localized exception message using the errorCode as key.

Parameters:

locale - Locale of the message.

Returns:

localized exception message.