org.forgerock.script.exception

Class ScriptThrownException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.script.ScriptException

org.forgerock.script.exception.ScriptThrownException

All Implemented Interfaces:

Serializable

public class ScriptThrownException
extends ScriptException

An exception that is thrown to indicate that an executed script encountered an exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScriptThrownException(Exception e, Object value) Constructs a new exception with the specified value and cause.
ScriptThrownException(String message, Object value) Constructs a new exception with the specified value and detail message.
ScriptThrownException(String message, String fileName, int lineNumber, int columnNumber, Object value)
ScriptThrownException(String message, String fileName, int lineNumber, Object value)

Method Summary

Modifier and Type	Method and Description
Object	getValue() Returns the value that was thrown from the script.
ResourceException	toResourceException(int defaultCode, String defaultMsg) Converts the script exception to an appropriate json resource exception.
String	toString()

Methods inherited from class javax.script.ScriptException

getColumnNumber, getFileName, getLineNumber, getMessage

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptThrownException

public ScriptThrownException(String message,
                             Object value)

Constructs a new exception with the specified value and detail message.

ScriptThrownException

public ScriptThrownException(Exception e,
                             Object value)

Constructs a new exception with the specified value and cause.

ScriptThrownException

public ScriptThrownException(String message,
                             String fileName,
                             int lineNumber,
                             Object value)

ScriptThrownException

public ScriptThrownException(String message,
                             String fileName,
                             int lineNumber,
                             int columnNumber,
                             Object value)

Method Detail

getValue

public Object getValue()

Returns the value that was thrown from the script.

toResourceException

public ResourceException toResourceException(int defaultCode,
                                             String defaultMsg)

Converts the script exception to an appropriate json resource exception. The exception message is set to, in order of precedence 1. Specific message set in the thrown script exception 2. Default exception supplied to this method, or if null 3. value toString of this exception

Parameters:

defaultMsg - a default message to use if no explicit message is set, or null if value toString shoudl be used instead

Returns:

the appropriate JsonResourceException

Throws:

JsonValueException - when value can not be converted to ResourceException

toString

public String toString()

Overrides:

toString in class Throwable