Package org.apache.tinkerpop.gremlin.driver.exception

Class FailResponseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.tinkerpop.gremlin.driver.exception.ResponseException

org.apache.tinkerpop.gremlin.driver.exception.FailResponseException

All Implemented Interfaces:

Serializable, Failure

public class FailResponseException
extends ResponseException
implements Failure

Provides a Failure implementation for ResponseException. This exception is thrown instead of a ResponseException when the server response carries an exception of EXCEPTION_NAME which indicates that a step in the traversal failed by way of GraphTraversal.fail(). This approach helps make remote exception handling for that step more consistent with the local GraphTraversal.fail() behavior.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXCEPTION_NAME	The exception name returned in a server response when a GraphTraversal.fail() step is triggered.

Constructor Summary

Constructors

Constructor	Description
FailResponseException(io.netty.handler.codec.http.HttpResponseStatus responseStatusCode, String serverMessage)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getMetadata()	Gets any additional metadata associated with the failure.
Traversal.Admin	getTraversal()	Gets the Traversal that contained the fail() step that triggered the failure.
Traverser.Admin	getTraverser()	Gets the Traverser that was being processed when the failure was triggered.

Methods inherited from class org.apache.tinkerpop.gremlin.driver.exception.ResponseException

create, getRemoteException, getResponseStatusCode

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

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Failure

format, getMessage

Field Details

EXCEPTION_NAME

public static final String EXCEPTION_NAME

The exception name returned in a server response when a GraphTraversal.fail() step is triggered.

See Also:

• Constant Field Values

Constructor Details

FailResponseException

public FailResponseException(io.netty.handler.codec.http.HttpResponseStatus responseStatusCode,
 String serverMessage)

Method Details

getMetadata

public Map<String,Object> getMetadata()

Description copied from interface: Failure

Gets any additional metadata associated with the failure. Returns an empty Map when there is no metadata.

Specified by:

getMetadata in interface Failure

getTraverser

public Traverser.Admin getTraverser()

Description copied from interface: Failure

Gets the Traverser that was being processed when the failure was triggered. May return null when the Failure was reconstructed from a remote response where this context is not available.

Specified by:

getTraverser in interface Failure

getTraversal

public Traversal.Admin getTraversal()

Description copied from interface: Failure

Gets the Traversal that contained the fail() step that triggered the failure. May return null when the Failure was reconstructed from a remote response where this context is not available.

Specified by:

getTraversal in interface Failure