org.elasticsearch

Class ElasticsearchException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.elasticsearch.ElasticsearchException

All Implemented Interfaces:

Serializable, ToXContent

Direct Known Subclasses:

AggregationExecutionException, AggregationInitializationException, AliasFilterParsingException, AlreadyExpiredException, BlobStoreException, BroadcastShardOperationFailedException, CancellableThreads.ExecutionCancelledException, CircuitBreakingException, ClusterBlockException, DelayRecoveryException, ElasticsearchGenerationException, ElasticsearchParseException, ElasticsearchSecurityException, ElasticsearchTimeoutException, EngineException, EsRejectedExecutionException, ExpressionScriptCompilationException, ExpressionScriptExecutionException, FailedNodeException, GatewayException, GroovyScriptCompilationException, GroovyScriptExecutionException, HttpException, IllegalIndexShardStateException, IncompatibleClusterStateVersionException, IndexAlreadyExistsException, IndexClosedException, IndexCreationException, IndexPrimaryShardNotAllocatedException, IndexShardAlreadyExistsException, IndexShardRecoveryException, IndexShardRestoreException, IndexShardSnapshotException, IndexTemplateAlreadyExistsException, IndexTemplateMissingException, IndexWarmerMissingException, InvalidAggregationPathException, InvalidAliasNameException, InvalidIndexNameException, InvalidIndexTemplateException, Lucene.EarlyTerminationException, MapperException, MasterNotDiscoveredException, NodeClosedException, NoNodeAvailableException, NoShardAvailableActionException, NotSerializableExceptionWrapper, PercolateException, PercolatorException, PrimaryMissingActionException, ProcessClusterEventTimeoutException, QueryParsingException, RecoverFilesRecoveryException, RecoveryFailedException, RepositoryException, ResourceNotFoundException, RoutingException, RoutingMissingException, Script.ScriptParseException, ScriptException, SearchContextMissingException, SearchException, SearchPhaseExecutionException, SearchSourceBuilderException, SettingsException, SizeHeaderFrameDecoder.HttpOnTransportException, SnapshotException, TimestampParsingException, TranslogCorruptedException, TranslogException, TranslogRecoveryPerformer.BatchOperationException, TransportException, TransportReplicationAction.RetryOnPrimaryException, TransportReplicationAction.RetryOnReplicaException, TypeMissingException, UnavailableShardsException, UncategorizedExecutionException

public class ElasticsearchException
extends RuntimeException
implements ToXContent

A base class for all elasticsearch exceptions.

See Also:

Serialized Form

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static String	REST_EXCEPTION_SKIP_CAUSE
static boolean	REST_EXCEPTION_SKIP_CAUSE_DEFAULT
static String	REST_EXCEPTION_SKIP_STACK_TRACE
static boolean	REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ElasticsearchException(StreamInput in)
ElasticsearchException(String msg, Object... args) Construct a ElasticsearchException with the specified detail message.
ElasticsearchException(String msg, Throwable cause, Object... args) Construct a ElasticsearchException with the specified detail message and nested exception.
ElasticsearchException(Throwable cause)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String key, List<String> value) Adds a new header with the given key.
void	addHeader(String key, String... value) Adds a new header with the given key.
protected void	causeToXContent(XContentBuilder builder, ToXContent.Params params) Renders a cause exception as xcontent
boolean	contains(Class exType) Check whether this exception contains an exception of the given type: either it is of the given class itself or it contains a nested cause of the given type.
String	getDetailedMessage() Return the detail message, including the message from the nested exception if there is one.
protected String	getExceptionName()
static String	getExceptionName(Throwable ex) Returns a underscore case name for the given exception.
List<String>	getHeader(String key) Returns the list of header values for the given key or null if not header for the given key exists.
Set<String>	getHeaderKeys() Returns a set of all header keys on this exception
static int	getId(Class<? extends ElasticsearchException> exception) Returns the serialization id the given exception.
String	getIndex()
List<String>	getResourceId()
String	getResourceType()
Throwable	getRootCause() Retrieve the innermost cause of this exception, if none, returns the current exception.
ShardId	getShardId()
ElasticsearchException[]	guessRootCauses() Returns the root cause of this exception or mupltiple if different shards caused different exceptions
static ElasticsearchException[]	guessRootCauses(Throwable t) Returns the root cause of this exception or mupltiple if different shards caused different exceptions.
protected void	innerToXContent(XContentBuilder builder, ToXContent.Params params) Renders additional per exception information into the xcontent
static boolean	isRegistered(Class<? extends Throwable> exception) Retruns true iff the given class is a registered for an exception to be read.
static ElasticsearchException	readException(StreamInput input, int id)
static <T extends Throwable> T	readStackTrace(T throwable, StreamInput in) Deserializes stacktrace elements as well as suppressed exceptions from the given output stream and adds it to the given exception.
protected void	renderHeader(XContentBuilder builder, ToXContent.Params params)
static void	renderThrowable(XContentBuilder builder, ToXContent.Params params, Throwable t)
void	setIndex(Index index)
void	setIndex(String index)
void	setResources(String type, String... id)
void	setShard(ShardId shardId)
RestStatus	status() Returns the rest status code associated with this exception.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static void	toXContent(XContentBuilder builder, ToXContent.Params params, Throwable ex) Statis toXContent helper method that also renders non ElasticsearchException instances as XContent.
Throwable	unwrapCause() Unwraps the actual cause from the exception for cases when the exception is a ElasticsearchWrapperException.
static <T extends Throwable> T	writeStackTraces(T throwable, StreamOutput out) Serializes the given exceptions stacktrace elements as well as it's suppressed exceptions to the given output stream.
void	writeTo(StreamOutput out)

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

Field Detail

REST_EXCEPTION_SKIP_CAUSE

public static final String REST_EXCEPTION_SKIP_CAUSE

See Also:

Constant Field Values

REST_EXCEPTION_SKIP_STACK_TRACE

public static final String REST_EXCEPTION_SKIP_STACK_TRACE

See Also:

Constant Field Values

REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT

public static final boolean REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT

See Also:

Constant Field Values

REST_EXCEPTION_SKIP_CAUSE_DEFAULT

public static final boolean REST_EXCEPTION_SKIP_CAUSE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

ElasticsearchException

public ElasticsearchException(Throwable cause)

ElasticsearchException

public ElasticsearchException(String msg,
                              Object... args)

Construct a ElasticsearchException with the specified detail message. The message can be parameterized using {} as placeholders for the given arguments

Parameters:

msg - the detail message

args - the arguments for the message

ElasticsearchException

public ElasticsearchException(String msg,
                              Throwable cause,
                              Object... args)

Construct a ElasticsearchException with the specified detail message and nested exception. The message can be parameterized using {} as placeholders for the given arguments

Parameters:

msg - the detail message

cause - the nested exception

args - the arguments for the message

ElasticsearchException

public ElasticsearchException(StreamInput in)
                       throws IOException

Throws:

IOException

Method Detail

addHeader

public void addHeader(String key,
                      String... value)

Adds a new header with the given key. This method will replace existing header if a header with the same key already exists

addHeader

public void addHeader(String key,
                      List<String> value)

Adds a new header with the given key. This method will replace existing header if a header with the same key already exists

getHeaderKeys

public Set<String> getHeaderKeys()

Returns a set of all header keys on this exception

getHeader

public List<String> getHeader(String key)

Returns the list of header values for the given key or null if not header for the given key exists.

status

public RestStatus status()

Returns the rest status code associated with this exception.

unwrapCause

public Throwable unwrapCause()

Unwraps the actual cause from the exception for cases when the exception is a ElasticsearchWrapperException.

See Also:

ExceptionsHelper.unwrapCause(Throwable)

getDetailedMessage

public String getDetailedMessage()

Return the detail message, including the message from the nested exception if there is one.

getRootCause

public Throwable getRootCause()

Retrieve the innermost cause of this exception, if none, returns the current exception.

contains

public boolean contains(Class exType)

Check whether this exception contains an exception of the given type: either it is of the given class itself or it contains a nested cause of the given type.

Parameters:

exType - the exception type to look for

Returns:

whether there is a nested exception of the specified type

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

readException

public static ElasticsearchException readException(StreamInput input,
                                                   int id)
                                            throws IOException

Throws:

IOException

isRegistered

public static boolean isRegistered(Class<? extends Throwable> exception)

Retruns true iff the given class is a registered for an exception to be read.

getId

public static int getId(Class<? extends ElasticsearchException> exception)

Returns the serialization id the given exception.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

innerToXContent

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

Renders additional per exception information into the xcontent

Throws:

IOException

causeToXContent

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

Renders a cause exception as xcontent

Throws:

IOException

renderHeader

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

Throws:

IOException

toXContent

public static void toXContent(XContentBuilder builder,
                              ToXContent.Params params,
                              Throwable ex)
                       throws IOException

Statis toXContent helper method that also renders non ElasticsearchException instances as XContent.

Throws:

IOException

guessRootCauses

public ElasticsearchException[] guessRootCauses()

Returns the root cause of this exception or mupltiple if different shards caused different exceptions

guessRootCauses

public static ElasticsearchException[] guessRootCauses(Throwable t)

Returns the root cause of this exception or mupltiple if different shards caused different exceptions. If the given exception is not an instance of ElasticsearchException an empty array is returned.

getExceptionName

protected String getExceptionName()

getExceptionName

public static String getExceptionName(Throwable ex)

Returns a underscore case name for the given exception. This method strips Elasticsearch prefixes from exception names.

toString

public String toString()

Overrides:

toString in class Throwable

readStackTrace

public static <T extends Throwable> T readStackTrace(T throwable,
                                                     StreamInput in)
                                              throws IOException

Deserializes stacktrace elements as well as suppressed exceptions from the given output stream and adds it to the given exception.

Throws:

IOException

writeStackTraces

public static <T extends Throwable> T writeStackTraces(T throwable,
                                                       StreamOutput out)
                                                throws IOException

Serializes the given exceptions stacktrace elements as well as it's suppressed exceptions to the given output stream.

Throws:

IOException

getIndex

public String getIndex()

getShardId

public ShardId getShardId()

setIndex

public void setIndex(Index index)

setIndex

public void setIndex(String index)

setShard

public void setShard(ShardId shardId)

setResources

public void setResources(String type,
                         String... id)

getResourceId

public List<String> getResourceId()

getResourceType

public String getResourceType()

renderThrowable

public static void renderThrowable(XContentBuilder builder,
                                   ToXContent.Params params,
                                   Throwable t)
                            throws IOException

Throws:

IOException