Class ClientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.neo4j.driver.exceptions.Neo4jException

org.neo4j.driver.exceptions.ClientException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthTokenManagerExecutionException, FatalDiscoveryException, ResultConsumedException, SecurityException, TransactionNestingException, TransactionTerminatedException, UnsupportedFeatureException, ValueException

public class ClientException
extends Neo4jException

A ClientException indicates that the client has carried out an operation incorrectly. The error code provided can be used to determine further detail for the problem.

Since:

1.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClientException(String message)	Creates a new instance.
ClientException(String code, String message)	Creates a new instance.
ClientException(String gqlStatus, String statusDescription, String code, String message, Map<String,Value> diagnosticRecord, Throwable cause)	Creates a new instance.
ClientException(String message, Throwable cause)	Creates a new instance.

Method Summary

Methods inherited from class Neo4jException

classification, code, containsGqlStatus, diagnosticRecord, findByGqlStatus, gqlCause, gqlStatus, rawClassification, statusDescription

Modifier and Type	Method	Description
Optional<GqlStatusErrorClassification>	classification()	Returns the error classification as a GqlStatusErrorClassification enum value.
String	code()	Access the status code for this exception.
boolean	containsGqlStatus(String gqlStatus)	Returns whether there is an error with the given GQLSTATUS in this GQL error chain, beginning the search from this exception.
Map<String,Value>	diagnosticRecord()	Returns the GQL diagnostic record.
Optional<Neo4jException>	findByGqlStatus(String gqlStatus)	Finds the first Neo4jException that has the given GQLSTATUS in this GQL error chain, beginning the search from this exception.
Optional<Neo4jException>	gqlCause()	Returns the GQL error cause.
String	gqlStatus()	Returns the GQLSTATUS as defined by the GQL standard.
Optional<String>	rawClassification()	Returns the error classification as a String value.
String	statusDescription()	Returns the GQLSTATUS description.

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Constructor Details

ClientException

public ClientException(String message)

Creates a new instance.

Parameters:

message - the message

ClientException

public ClientException(String message,
 Throwable cause)

Creates a new instance.

Parameters:

message - the message

cause - the cause

ClientException

public ClientException(String code,
 String message)

Creates a new instance.

Parameters:

code - the code

message - the message

ClientException

public ClientException(String gqlStatus,
 String statusDescription,
 String code,
 String message,
 Map<String,Value> diagnosticRecord,
 Throwable cause)

Creates a new instance.

Parameters:

gqlStatus - the GQLSTATUS as defined by the GQL standard

statusDescription - the status description

code - the code

message - the message

diagnosticRecord - the diagnostic record

cause - the cause

Since:

5.26.0