openconnector

Class ConnectorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

openconnector.ConnectorException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AuthenticationFailedException, ConnectionFailedException, InsufficientPermissionException, InvalidConfigurationException, InvalidRequestException, InvalidResponseException, ObjectAlreadyExistsException, ObjectNotFoundException

public class ConnectorException
extends java.lang.RuntimeException

A generic exception thrown by connectors when operations fail. This usually indicates some problem with the underlying resource or the data passed to the resource.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConnectorException() Default constructor.
ConnectorException(Message message) Construct a new ConnectorException with a detailed message.
ConnectorException(Message message, java.lang.Throwable cause) Create a new ConnectorException from an existing exception and object Message.
ConnectorException(java.lang.String message) Constructor.
ConnectorException(java.lang.String error, java.lang.String suggestion, java.lang.Throwable t) Create a new ConnectorException from an error text, suggestion text and existing exception.
ConnectorException(java.lang.String message, java.lang.Throwable cause) Constructor.

Method Summary

Modifier and Type	Method and Description
Message	getDetailedError()
java.lang.String	getLocalizedMessage() Returns the final message string.
java.lang.String	getMessage() Returns the final message string.
Message	getMessageInstance() Returns the actual Message object so it can be added to the message list on another object.
Message	getPossibleSuggestion()
void	setDetailedError(Message error)
void	setDetailedError(java.lang.String key, java.lang.Object... args)
void	setLocalizedMessage(Message message)
void	setPossibleSuggestion(Message suggestion)
void	setPossibleSuggestion(java.lang.String key, java.lang.Object... args)

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

Constructor Detail

ConnectorException

public ConnectorException()

Default constructor.

ConnectorException

public ConnectorException(java.lang.String message)

Constructor.

ConnectorException

public ConnectorException(Message message)

Construct a new ConnectorException with a detailed message.

Parameters:

message - detailed message with type Message.

ConnectorException

public ConnectorException(java.lang.String message,
                          java.lang.Throwable cause)

Constructor.

ConnectorException

public ConnectorException(Message message,
                          java.lang.Throwable cause)

Create a new ConnectorException from an existing exception and object Message. By calling this constructor, the existing exception will be embedded with the message passed

Parameters:

message - detailed message with type Message.

cause - Throwable exception.

ConnectorException

public ConnectorException(java.lang.String error,
                          java.lang.String suggestion,
                          java.lang.Throwable t)

Create a new ConnectorException from an error text, suggestion text and existing exception.

The error and suggestion being set here is used later to prepare well formatted exception message based on resource bundle key 'msg_with_suggestion' and 'msg_no_suggestion'. But all this happens lazily when openconnector exception gets converted to it's counterpart exception in sailpoint.connector.

Parameters:

error - ResourceBundle message key, or a plain text message containing error details.

suggestion - ResourceBundle message key, or a plain text message containing hints to solve the error.

t - Throwable object t can be provided at the time of calling following constructor.

Method Detail

getMessage

public java.lang.String getMessage()

Returns the final message string.

Overrides:

getMessage in class java.lang.Throwable

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Returns the final message string.

Overrides:

getLocalizedMessage in class java.lang.Throwable

setLocalizedMessage

public void setLocalizedMessage(Message message)

getDetailedError

public Message getDetailedError()

setDetailedError

public void setDetailedError(java.lang.String key,
                             java.lang.Object... args)

setDetailedError

public void setDetailedError(Message error)

getPossibleSuggestion

public Message getPossibleSuggestion()

setPossibleSuggestion

public void setPossibleSuggestion(java.lang.String key,
                                  java.lang.Object... args)

setPossibleSuggestion

public void setPossibleSuggestion(Message suggestion)

getMessageInstance

public Message getMessageInstance()

Returns the actual Message object so it can be added to the message list on another object.

Returns:

Message instance for this exception or null.