Package org.elasticsearch.script

Class ScriptException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.elasticsearch.ElasticsearchException

org.elasticsearch.script.ScriptException

All Implemented Interfaces:

Serializable, Writeable, ToXContent, ToXContentFragment

public class ScriptException
extends ElasticsearchException

Exception from a scripting engine.

A ScriptException has the following components:

• message: A short and simple summary of what happened, such as "compile error".
• cause: The underlying cause of the exception.
• scriptStack: An implementation-specific "stacktrace" for the error in the script.
• script: Identifier for which script failed.
• lang: Scripting engine language, such as "painless"

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptException.Position

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.ElasticsearchException

REST_EXCEPTION_SKIP_STACK_TRACE, REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT, STACK_TRACE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ScriptException(String message, Throwable cause, List<String> scriptStack, String script, String lang)	Create a new ScriptException with null Position.
ScriptException(String message, Throwable cause, List<String> scriptStack, String script, String lang, ScriptException.Position pos)	Create a new ScriptException.
ScriptException(StreamInput in)	Deserializes a ScriptException from a StreamInput

Method Summary

Modifier and Type	Method	Description
String	getLang()	Returns the language of the script.
ScriptException.Position	getPos()	Returns the position of the error.
String	getScript()	Returns the identifier for which script.
List<String>	getScriptStack()	Returns the stacktrace for the error in the script.
protected void	metadataToXContent(XContentBuilder builder, ToXContent.Params params)	Renders additional per exception information into the XContent
RestStatus	status()	Returns the rest status code associated with this exception.
String	toJsonString()	Returns a JSON version of this exception for debugging.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.ElasticsearchException

addHeader, addHeader, addMetadata, addMetadata, failureFromXContent, fromXContent, generateFailureXContent, generateThrowableXContent, getDetailedMessage, getExceptionName, getExceptionName, getHeader, getHeaderKeys, getHeaders, getId, getIndex, getMetadata, getMetadata, getMetadataKeys, getResourceId, getResourceType, getRootCause, getShardId, guessRootCauses, guessRootCauses, innerFromXContent, innerToXContent, isRegistered, readException, readStackTrace, setIndex, setIndex, setResources, setShard, toString, toXContent, unwrapCause, writeStackTraces

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

ScriptException

public ScriptException(String message,
 Throwable cause,
 List<String> scriptStack,
 String script,
 String lang,
 ScriptException.Position pos)

Create a new ScriptException.

Parameters:

message - A short and simple summary of what happened, such as "compile error". Must not be null.

cause - The underlying cause of the exception. Must not be null.

scriptStack - An implementation-specific "stacktrace" for the error in the script. Must not be null, but can be empty (though this should be avoided if possible).

script - Identifier for which script failed. Must not be null.

lang - Scripting engine language, such as "painless". Must not be null.

pos - Position of error within script, may be null.

Throws:

NullPointerException - if any parameters are null except pos.

ScriptException

public ScriptException(String message,
 Throwable cause,
 List<String> scriptStack,
 String script,
 String lang)

Create a new ScriptException with null Position.

ScriptException

public ScriptException(StreamInput in)
                throws IOException

Deserializes a ScriptException from a StreamInput

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ElasticsearchException

Throws:

IOException

metadataToXContent

protected void metadataToXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Description copied from class: ElasticsearchException

Renders additional per exception information into the XContent

Overrides:

metadataToXContent in class ElasticsearchException

Throws:

IOException

getScriptStack

public List<String> getScriptStack()

Returns the stacktrace for the error in the script.

Returns:

a read-only list of frames, which may be empty.

getScript

public String getScript()

Returns the identifier for which script.

Returns:

script's name or source text that identifies the script.

getLang

public String getLang()

Returns the language of the script.

Returns:

the lang parameter of the scripting engine.

getPos

public ScriptException.Position getPos()

Returns the position of the error.

toJsonString

public String toJsonString()

Returns a JSON version of this exception for debugging.

status

public RestStatus status()

Description copied from class: ElasticsearchException

Returns the rest status code associated with this exception.

Overrides:

status in class ElasticsearchException