Package com.surrealdb

Class NotAllowedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.surrealdb.SurrealException

com.surrealdb.ServerException

com.surrealdb.NotAllowedException

All Implemented Interfaces:

Serializable

public class NotAllowedException
extends ServerException

Permission denied, method not allowed, function or scripting blocked.

Details use the {kind, details?} format with variants defined in NotAllowedDetailKind. Auth details further nest AuthDetailKind variants.

See Also:

• ErrorKind.NOT_ALLOWED
• Serialized Form

Method Summary

Modifier and Type	Method	Description
String	getFunctionName()	Returns the name of the function that is not allowed, if applicable.
String	getMethodName()	Returns the name of the method that is not allowed, if applicable.
String	getTargetName()	Returns the name of the target that is not allowed, if applicable.
boolean	isInvalidAuth()	Returns true when authentication failed (invalid credentials).
boolean	isScriptingBlocked()	Returns true when scripting is blocked.
boolean	isTokenExpired()	Returns true when the token used for authentication has expired.

Methods inherited from class com.surrealdb.ServerException

findCause, findCause, getDetails, getKind, getKindEnum, getServerCause, hasKind, hasKind

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

Method Details

isTokenExpired

public boolean isTokenExpired()

Returns true when the token used for authentication has expired.

Returns:

whether the detail matches Auth -> TokenExpired

isInvalidAuth

public boolean isInvalidAuth()

Returns true when authentication failed (invalid credentials).

Returns:

whether the detail matches Auth -> InvalidAuth

isScriptingBlocked

public boolean isScriptingBlocked()

Returns true when scripting is blocked.

Returns:

whether the detail kind is Scripting

getMethodName

public String getMethodName()

Returns the name of the method that is not allowed, if applicable.

Returns:

the method name, or null

getFunctionName

public String getFunctionName()

Returns the name of the function that is not allowed, if applicable.

Returns:

the function name, or null

getTargetName

public String getTargetName()

Returns the name of the target that is not allowed, if applicable.

Returns:

the target name, or null