org.forgerock.openam.scripting

Class ScriptException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.shared.locale.L10NMessageImpl

org.forgerock.openam.scripting.ScriptException

All Implemented Interfaces:

L10NMessage, Serializable

public class ScriptException
extends L10NMessageImpl

General script exception that allows for localised messages.

Since:

13.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScriptException(ScriptConstants.ScriptErrorCode errorCode, String... arguments) Construct a ScriptException.
ScriptException(ScriptConstants.ScriptErrorCode errorCode, Throwable cause, String... arguments) Construct a ScriptException.

Method Summary

Modifier and Type	Method and Description
static ScriptException	createAndLogDebug(org.slf4j.Logger logger, ScriptConstants.ScriptErrorCode errorCode, String... arguments) Convenience method that will log the message represented by the error code and construct a new ScriptException.
static ScriptException	createAndLogDebug(org.slf4j.Logger logger, ScriptConstants.ScriptErrorCode errorCode, Throwable cause, String... arguments) Convenience method that will log the message represented by the error code and construct a new ScriptException.
static ScriptException	createAndLogError(org.slf4j.Logger logger, ScriptConstants.ScriptErrorCode errorCode, String... arguments) Convenience method that will log the message represented by the error code and construct a new ScriptException.
static ScriptException	createAndLogError(org.slf4j.Logger logger, ScriptConstants.ScriptErrorCode errorCode, Throwable cause, String... arguments) Convenience method that will log the message represented by the error code and construct a new ScriptException.
ScriptConstants.ScriptErrorCode	getScriptErrorCode() Get the ScriptErrorCode that describes this error.

Methods inherited from class com.sun.identity.shared.locale.L10NMessageImpl

getErrorCode, getL10NMessage, getMessage, getMessageArgs, getResourceBundleName

Methods inherited from class java.lang.Throwable

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

ScriptException

public ScriptException(ScriptConstants.ScriptErrorCode errorCode,
                       Throwable cause,
                       String... arguments)

Construct a ScriptException.

Parameters:

errorCode - The error code to use for the exception message.

cause - The Throwable that caused the error.

arguments - Arguments used in the message associated with the error code.

ScriptException

public ScriptException(ScriptConstants.ScriptErrorCode errorCode,
                       String... arguments)

Construct a ScriptException.

Parameters:

errorCode - The error code to use for the exception message.

arguments - Arguments used in the message associated with the error code.

Method Detail

getScriptErrorCode

public ScriptConstants.ScriptErrorCode getScriptErrorCode()

Get the ScriptErrorCode that describes this error.

Returns:

the script error code.

createAndLogError

public static ScriptException createAndLogError(org.slf4j.Logger logger,
                                                ScriptConstants.ScriptErrorCode errorCode,
                                                Throwable cause,
                                                String... arguments)

Convenience method that will log the message represented by the error code and construct a new ScriptException.

Parameters:

logger - The logger to which the error should be written.

errorCode - The error code to use for the exception message.

cause - The Throwable that caused the error.

arguments - Arguments used in the message associated with the error code.

Returns:

A new ScriptException.

createAndLogDebug

public static ScriptException createAndLogDebug(org.slf4j.Logger logger,
                                                ScriptConstants.ScriptErrorCode errorCode,
                                                Throwable cause,
                                                String... arguments)

Convenience method that will log the message represented by the error code and construct a new ScriptException.

Parameters:

logger - The logger to which the error should be written.

errorCode - The error code to use for the exception message.

cause - The Throwable that caused the error.

arguments - Arguments used in the message associated with the error code.

Returns:

A new ScriptException.

createAndLogError

public static ScriptException createAndLogError(org.slf4j.Logger logger,
                                                ScriptConstants.ScriptErrorCode errorCode,
                                                String... arguments)

Convenience method that will log the message represented by the error code and construct a new ScriptException.

Parameters:

logger - The logger to which the error should be written.

errorCode - The error code to use for the exception message.

arguments - Arguments used in the message associated with the error code.

Returns:

A new ScriptException.

createAndLogDebug

public static ScriptException createAndLogDebug(org.slf4j.Logger logger,
                                                ScriptConstants.ScriptErrorCode errorCode,
                                                String... arguments)

Convenience method that will log the message represented by the error code and construct a new ScriptException.

Parameters:

logger - The logger to which the error should be written.

errorCode - The error code to use for the exception message.

arguments - Arguments used in the message associated with the error code.

Returns:

A new ScriptException.