Skip navigation links

oracle.idm.connection
Class ConnectionException

java.lang.Object
java.lang.Throwable
java.lang.Exception
oracle.idm.connection.ConnectionException

All Implemented Interfaces:

java.io.Serializable, XmlPrintable

public class ConnectionException

extends java.lang.Exception

implements XmlPrintable

This class represents connection exceptions. This framework ignores all exceptions reported during connection usage and processing except for ConnectionExceptions. This means that all other exceptions will be propagated to the calling APIs. Implementers of the IdM Connection Framework components need to wrap all exceptions that need to be handled by the framework with a ConnectionException and specify the original exception via the cause property.

See Also:

Serialized Form

Field Summary

protected java.lang.String

tag Tag used to print the connection as an XML element.

Constructor Summary

ConnectionException()
Constructor for the connection exception.

ConnectionException(java.lang.String message)
Constructor for the connection exception.

ConnectionException(java.lang.String message, Connection connection)
Constructor for the connection exception.

ConnectionException(java.lang.String message, Connection connection, java.lang.Throwable cause)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, Connection connection)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, Connection connection, java.lang.Throwable cause)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, java.lang.String operation)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, java.lang.String operation, Connection connection)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, java.lang.String operation, Connection connection, java.lang.Throwable cause)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, java.lang.String operation, java.util.Map parameters)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, java.lang.String operation, java.util.Map parameters, Connection connection)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, java.lang.String operation, java.util.Map parameters, Connection connection, java.lang.Throwable cause)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, java.lang.String operation, java.util.Map parameters, java.lang.Throwable cause)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, java.lang.String operation, java.lang.Throwable cause)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.String type, java.lang.Throwable cause)
Constructor for the connection exception.

ConnectionException(java.lang.String message, java.lang.Throwable cause)
Constructor for the connection exception.

ConnectionException(java.lang.Throwable cause)
Constructor for the connection exception.

Method Summary

Connection	getConnection() Returns the connection that triggered this exception.
java.util.Collection	getLocalizedMessages() Returns localized messages associated with this connection exception and all of its causes.
java.util.Collection	getMessages() Returns messages associated with this connection exception and all of its causes.
java.lang.String	getOperation() Returns the operation that triggered this exception.
java.util.Map	getParameters() Returns the operation parameters.
java.lang.String	getType() Returns the type that triggered this exception.
boolean	isAlteredConnection() Returns true if this is an altered connection exception.
boolean	isLeakedConnection() Returns true if this is a connection leak exception.
boolean	isMatchingOperation(java.lang.String operation) Tests if the connection exception operation value matches.
boolean	isMatchingType(java.lang.String type) Tests if the connection exception type value matches.
java.lang.String	toString()
void	xprint(XmlPrintWriter out) Prints connection exception properties to the XmlPrintWriter as an XML element.
protected void	xprintBody(XmlPrintWriter out) This method prints the connection manager XML tag body.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

tag

protected java.lang.String tag

Tag used to print the connection as an XML element.

Constructor Detail

ConnectionException

public ConnectionException()

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.Throwable cause)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message)

Constructor for the connection exception.

ConnectionException

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

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           Connection connection)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           Connection connection,
                           java.lang.Throwable cause)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           java.lang.Throwable cause)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           Connection connection)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           Connection connection,
                           java.lang.Throwable cause)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           java.lang.String operation)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           java.lang.String operation,
                           java.lang.Throwable cause)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           java.lang.String operation,
                           Connection connection)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           java.lang.String operation,
                           Connection connection,
                           java.lang.Throwable cause)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           java.lang.String operation,
                           java.util.Map parameters)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           java.lang.String operation,
                           java.util.Map parameters,
                           java.lang.Throwable cause)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           java.lang.String operation,
                           java.util.Map parameters,
                           Connection connection)

Constructor for the connection exception.

ConnectionException

public ConnectionException(java.lang.String message,
                           java.lang.String type,
                           java.lang.String operation,
                           java.util.Map parameters,
                           Connection connection,
                           java.lang.Throwable cause)

Constructor for the connection exception.

Method Detail

isLeakedConnection

public boolean isLeakedConnection()

Returns true if this is a connection leak exception.

isAlteredConnection

public boolean isAlteredConnection()

Returns true if this is an altered connection exception.

getType

public java.lang.String getType()

Returns the type that triggered this exception.

Returns:

String representing the connection type

isMatchingType

public final boolean isMatchingType(java.lang.String type)

Tests if the connection exception type value matches.

Every connection exception matches the Connection.TYPE value.

Returns:

true if the type matches, false otherwise

getOperation

public java.lang.String getOperation()

Returns the operation that triggered this exception.

Returns:

String representing the connection operation

isMatchingOperation

public final boolean isMatchingOperation(java.lang.String operation)

Tests if the connection exception operation value matches.

Every connection exception matches the Connection.Operation.EVERY value.

Returns:

true if the operation matches, false otherwise

getParameters

public java.util.Map getParameters()

Returns the operation parameters.

Returns:

Map representing the operation parameters

getConnection

public Connection getConnection()

Returns the connection that triggered this exception.

Returns:

Connection this connection exception occured on

getMessages

public java.util.Collection getMessages()

Returns messages associated with this connection exception and all of its causes.

Returns:

collection of messages for this exception, null if none were collected

getLocalizedMessages

public java.util.Collection getLocalizedMessages()

Returns localized messages associated with this connection exception and all of its causes.

Returns:

collection of localized messages for this exception, null if none were collected

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

xprint

public void xprint(XmlPrintWriter out)

Prints connection exception properties to the XmlPrintWriter as an XML element.

Specified by:

xprint in interface XmlPrintable

Parameters:

out - XmlPrintWriter for printing connection exception propeties.

xprintBody

protected void xprintBody(XmlPrintWriter out)

This method prints the connection manager XML tag body.

Skip navigation links