Package org.apache.solr.common

Class SolrException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.solr.common.SolrException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CloudSolrClient.RouteException, NonExistentCoreException, RemoteSolrException, SolrErrorWrappingException

public class SolrException
extends RuntimeException

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SolrException.ErrorCode	This list of valid HTTP Status error codes that Solr may return when there is a "Server Side" error.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Map<String,Object>>	details
protected NamedList<String>	metadata

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SolrException(int code, String msg, Throwable th)	Constructor that can set arbitrary http status code.
	SolrException(SolrException.ErrorCode code, String msg)
	SolrException(SolrException.ErrorCode code, String msg, Throwable th)
	SolrException(SolrException.ErrorCode code, Throwable th)

Method Summary

Modifier and Type	Method	Description
int	code()	The HTTP Status code associated with this Exception.
List<Map<String,Object>>	getDetails()
NamedList<String>	getMetadata()
String	getMetadata(String key)
String	getResponseMessage()
static Throwable	getRootCause(Throwable t)
String	getRootThrowable()
String	getThrowable()
static boolean	hasCause(Throwable t, Class<? extends Throwable> type)	Whether t or anything in its cause chain is of the given type.
void	setDetails(List<Map<String,Object>> details)
void	setMetadata(String key, String value)
void	setMetadata(NamedList<String> metadata)
static SolrException	wrapLuceneTragicExceptionIfNecessary(Exception e)	Ensure that the provided tragic exception is wrapped in a 5xx SolrException

Methods inherited from class java.lang.Throwable

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

Field Details

metadata

protected NamedList<String> metadata

details

protected List<Map<String,Object>> details

Constructor Details

SolrException

public SolrException(SolrException.ErrorCode code,
 String msg)

SolrException

public SolrException(SolrException.ErrorCode code,
 String msg,
 Throwable th)

SolrException

public SolrException(SolrException.ErrorCode code,
 Throwable th)

SolrException

protected SolrException(int code,
 String msg,
 Throwable th)

Constructor that can set arbitrary http status code. Not for use in Solr, but may be used by clients in subclasses to capture errors returned by the servlet container or other HTTP proxies.

Method Details

code

public int code()

The HTTP Status code associated with this Exception. For SolrExceptions thrown by Solr "Server Side", this should be a valid SolrException.ErrorCode, however client side exceptions may contain an arbitrary error code based on the behavior of the Servlet Container hosting Solr, or any HTTP Proxies that may exist between the client and the server.

Returns:

The HTTP Status code associated with this Exception

setMetadata

public void setMetadata(NamedList<String> metadata)

getMetadata

public NamedList<String> getMetadata()

getMetadata

public String getMetadata(String key)

setMetadata

public void setMetadata(String key,
 String value)

setDetails

public void setDetails(List<Map<String,Object>> details)

getDetails

public List<Map<String,Object>> getDetails()

getResponseMessage

public String getResponseMessage()

getThrowable

public String getThrowable()

getRootThrowable

public String getRootThrowable()

getRootCause

public static Throwable getRootCause(Throwable t)

hasCause

public static boolean hasCause(Throwable t,
 Class<? extends Throwable> type)

Whether t or anything in its cause chain is of the given type. Prefer this to getRootCause(java.lang.Throwable) when classifying a failure, since a transport may report it wrapped at any depth.

wrapLuceneTragicExceptionIfNecessary

public static SolrException wrapLuceneTragicExceptionIfNecessary(Exception e)

Ensure that the provided tragic exception is wrapped in a 5xx SolrException

Tragic exceptions (those that Lucene's IndexWriter uses to signify it has become inoperable) are expected to have a 5xx error code. This method takes an input tragic exception and adds the expected wrapper, if necessary.

Parameters:

e - the exception to check the code on. If not a SolrException, then this method acts as a no-op.