Skip navigation links

oracle.security.am.engines.common.identity.provider.exceptions
Class IdentityProviderException

java.lang.Object
java.lang.Throwable
java.lang.Exception
oracle.security.am.engines.common.identity.provider.exceptions.IdentityProviderException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TestConnectionException

public class IdentityProviderException

extends java.lang.Exception

If an error occurs User Identity Provider will throw an exception of type IdentityProviderException.

Since:

11gR1

Version:

$Header: ngam/src/engines/common/identity/src/main/java/oracle/security/am/engines/common/identity/provider/exceptions/IdentityProviderException.java /main/15 2012/04/27 14:43:41 lahariha Exp $

See Also:

Serialized Form

Nested Class Summary

static class

IdentityProviderException.ERROR_CODES

Field Summary

protected static java.lang.String

COMPONENT_BUNDLE_CLASS Child top-level component exceptions may need to redeclare this if using a nonstandard bundle class name (don't do that).

Constructor Summary

IdentityProviderException()
Constructs a default exception.

IdentityProviderException(IdentityProviderException.ERROR_CODES code, java.lang.Throwable cause)
Constructs a new exception with the specified message ID and cause.

IdentityProviderException(oracle.security.idm.IMException ime)
Constructs exception along with setting primary error message

IdentityProviderException(java.lang.String messageID)
Constructs a new exception with the specified message ID.

IdentityProviderException(java.lang.String messageID, oracle.security.idm.IMException ime)
Constructs exception along with setting primary error message

IdentityProviderException(java.lang.String messageID, oracle.security.idm.IMException ime, java.lang.Object[] params)
Constructs exception along with setting primary error message

IdentityProviderException(java.lang.String messageID, oracle.security.idm.IMException ime, java.lang.String userName, java.lang.String idstore)

IdentityProviderException(java.lang.String messageID, java.lang.Object[] params)
Constructs a new exception with the specified message ID and parameters.

IdentityProviderException(java.lang.String messageID, java.lang.Throwable cause)
Constructs a new exception with the specified message ID and cause.

IdentityProviderException(java.lang.String messageID, java.lang.Throwable cause, java.lang.Object[] params)
Constructs a new exception with passed message ID, cause, and parameters.

IdentityProviderException(java.lang.Throwable cause)
Constructs a new exception with the specified cause.

Method Summary

void	extractAndSetNativeErrorCode(java.lang.String userName, long start, long dStart, oracle.security.idm.IMException ex)
void	extractAndSetNativeErrorCodeForPswdChange(java.lang.String userName, long start, long dStart, oracle.security.idm.IMException ex)
java.lang.String	getBundleName() Returns the class name of the ResourceBundle holding messages for this component.
IdentityProviderException.ERROR_CODES	getErrorCode()
java.lang.String	getMessage() Returns the detail message string associated with the message ID for the current locale.
java.lang.String	getMessage(java.util.Locale locale) Returns the detail message string associated with the message ID for the requested locale, if available.
java.lang.String	getMessageID() Returns the message ID that was passed in on creation, if any.
java.lang.String	getPrimaryErrorCode()
void	setErrorcode(IdentityProviderException.ERROR_CODES e) Getter and Setter for error codes
void	setPrimaryErrorCode(java.lang.String primaryErrorCode)
java.lang.String	toString() In addition, the message ID is included as a separate field from the message itself if those are distinct.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_BUNDLE_CLASS

protected static final java.lang.String COMPONENT_BUNDLE_CLASS

Child top-level component exceptions may need to redeclare this if using a nonstandard bundle class name (don't do that).

See Also:

getBundleName(), Constant Field Values

Constructor Detail

IdentityProviderException

public IdentityProviderException()

Constructs a default exception.

IdentityProviderException

public IdentityProviderException(java.lang.String messageID)

Constructs a new exception with the specified message ID.

IdentityProviderException

public IdentityProviderException(java.lang.String messageID,
                                 java.lang.Object[] params)

Constructs a new exception with the specified message ID and parameters.

IdentityProviderException

public IdentityProviderException(IdentityProviderException.ERROR_CODES code,
                                 java.lang.Throwable cause)

Constructs a new exception with the specified message ID and cause.

IdentityProviderException

public IdentityProviderException(java.lang.String messageID,
                                 java.lang.Throwable cause)

Constructs a new exception with the specified message ID and cause.

IdentityProviderException

public IdentityProviderException(java.lang.String messageID,
                                 oracle.security.idm.IMException ime)

Constructs exception along with setting primary error message

Parameters:

messageID -

ime -

IdentityProviderException

public IdentityProviderException(java.lang.String messageID,
                                 java.lang.Throwable cause,
                                 java.lang.Object[] params)

Constructs a new exception with passed message ID, cause, and parameters.

IdentityProviderException

public IdentityProviderException(java.lang.String messageID,
                                 oracle.security.idm.IMException ime,
                                 java.lang.Object[] params)

Constructs exception along with setting primary error message

Parameters:

messageID -

ime -

params -

IdentityProviderException

public IdentityProviderException(java.lang.String messageID,
                                 oracle.security.idm.IMException ime,
                                 java.lang.String userName,
                                 java.lang.String idstore)

IdentityProviderException

public IdentityProviderException(java.lang.Throwable cause)

Constructs a new exception with the specified cause.

IdentityProviderException

public IdentityProviderException(oracle.security.idm.IMException ime)

Constructs exception along with setting primary error message

Parameters:

ime -

Method Detail

setErrorcode

public void setErrorcode(IdentityProviderException.ERROR_CODES e)

Getter and Setter for error codes

getErrorCode

public IdentityProviderException.ERROR_CODES getErrorCode()

getMessageID

public java.lang.String getMessageID()

Returns the message ID that was passed in on creation, if any.

getMessage

public java.lang.String getMessage()

Returns the detail message string associated with the message ID for the current locale. If not found, the message ID itself is returned.

Overrides:

getMessage in class java.lang.Throwable

getMessage

public java.lang.String getMessage(java.util.Locale locale)

Returns the detail message string associated with the message ID for the requested locale, if available. If not found, the message ID itself is returned, or null if unset.

getBundleName

public java.lang.String getBundleName()

Returns the class name of the ResourceBundle holding messages for this component. It's required this be overridden by the top-level exception class of other components.

toString

public java.lang.String toString()

In addition, the message ID is included as a separate field from the message itself if those are distinct.

Overrides:

toString in class java.lang.Throwable

getPrimaryErrorCode

public java.lang.String getPrimaryErrorCode()

Returns:

the primaryErrorCode

setPrimaryErrorCode

public void setPrimaryErrorCode(java.lang.String primaryErrorCode)

Parameters:

primaryErrorCode - the primaryErrorCode to set

extractAndSetNativeErrorCode

public void extractAndSetNativeErrorCode(java.lang.String userName,
                                         long start,
                                         long dStart,
                                         oracle.security.idm.IMException ex)

extractAndSetNativeErrorCodeForPswdChange

public void extractAndSetNativeErrorCodeForPswdChange(java.lang.String userName,
                                                      long start,
                                                      long dStart,
                                                      oracle.security.idm.IMException ex)

Skip navigation links