Package com.illumon.iris.db.v2.permissions.rs.exceptions

Class DbAclUncheckedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.deephaven.UncheckedDeephavenException

com.illumon.iris.db.v2.permissions.rs.exceptions.DbAclUncheckedException

All Implemented Interfaces:

DeephavenAclRestApiError, Serializable

public class DbAclUncheckedException
extends UncheckedDeephavenException
implements DeephavenAclRestApiError

Known error conditions raised as unchecked exceptions while processing Acl Rest Api will throw this error. The error implements DeephavenAclRestApiError that allows customized audit information to be captured

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DbAclUncheckedException(io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus, String commandName, String commandDetails)	Constructs a new exception with null as its detail message.
DbAclUncheckedException(String reason, io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus, String commandName, String commandDetails)	Constructor that supports taking a detailed message describing the error.
DbAclUncheckedException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace, io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus, String commandName, String commandDetails)	Constructor that builds a DbAclUncheckedException using the passed in message, optional cause, suppression indicator and writable stacktrace flag.
DbAclUncheckedException(String reason, Throwable cause, io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus, String commandName, String commandDetails)	Constructor that builds a DbAclUncheckedException using the passed in message and optional cause.
DbAclUncheckedException(Throwable cause, io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus, String commandName, String commandDetails)	Constructor that builds a DbAclUncheckedException using the specified cause.

Method Summary

Modifier and Type	Method	Description
String	getCommandDetails()	Customized details that identifies the error, this will be logged in the AuditEventLogger under details column
String	getCommandName()	Identifies the DbAclWriter method invoked by acl rest api request.
io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status	getResponseStatus()	Identifies the ResponseStatus returned in API Response

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

Constructor Details

DbAclUncheckedException

public DbAclUncheckedException(@NotNull
 io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus,
 String commandName,
 String commandDetails)

Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

responseStatus - The Response status that will be propagated to clients

commandName - The failed command name for audit logs

commandDetails - Details related to the error for audit logs

DbAclUncheckedException

public DbAclUncheckedException(@NotNull
 String reason,
 @NotNull
 io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus,
 String commandName,
 String commandDetails)

Constructor that supports taking a detailed message describing the error. See RuntimeException(String)

Parameters:

reason - A detailed message describing the error.

responseStatus - The Response status that will be propagated to clients

commandName - Optional failed command name for audit logs

commandDetails - Optional details related to the error for audit logs

DbAclUncheckedException

public DbAclUncheckedException(@Nullable
 Throwable cause,
 @NotNull
 io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus,
 String commandName,
 String commandDetails)

Constructor that builds a DbAclUncheckedException using the specified cause. See RuntimeException(Throwable)

Parameters:

cause - The passed in cause.

responseStatus - The Response status that will be propagated to clients

commandName - Optional failed command name for audit logs

commandDetails - Optional details related to the error for audit logs

DbAclUncheckedException

public DbAclUncheckedException(@NotNull
 String reason,
 @Nullable
 Throwable cause,
 @NotNull
 io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus,
 @Nullable
 String commandName,
 @Nullable
 String commandDetails)

Constructor that builds a DbAclUncheckedException using the passed in message and optional cause. See RuntimeException(String, Throwable)

Parameters:

reason - The passed in message detailing the error

cause - Optional cause, null would indicate the error is unknown

responseStatus - The Response status that will be propagated to clients

commandName - Optional failed command name for audit logs

commandDetails - Optional details related to the error for audit logs

DbAclUncheckedException

public DbAclUncheckedException(@NotNull
 String message,
 @Nullable
 Throwable cause,
 boolean enableSuppression,
 boolean writableStackTrace,
 @NotNull
 io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status responseStatus,
 String commandName,
 String commandDetails)

Constructor that builds a DbAclUncheckedException using the passed in message, optional cause, suppression indicator and writable stacktrace flag. See RuntimeException(String, Throwable, boolean, boolean)

Parameters:

message - The passed in message detailing the error

cause - Optional cause, null would indicate the error is unknown

enableSuppression - Boolean that indicates suppression is enabled or disabled

writableStackTrace - Boolean that indicates if stacktrace is writable

responseStatus - The Response status that will be propagated to clients

commandName - Optional failed command name for audit logs

commandDetails - Optional details related to the error for audit logs

Method Details

getResponseStatus

public io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status getResponseStatus()

Description copied from interface: DeephavenAclRestApiError

Identifies the ResponseStatus returned in API Response

Specified by:

getResponseStatus in interface DeephavenAclRestApiError

Returns:

The Response status that should be propagated to clients

getCommandName

public String getCommandName()

Description copied from interface: DeephavenAclRestApiError

Identifies the DbAclWriter method invoked by acl rest api request.

Specified by:

getCommandName in interface DeephavenAclRestApiError

Returns:

the name of the command that caused the exception

getCommandDetails

public String getCommandDetails()

Description copied from interface: DeephavenAclRestApiError

Customized details that identifies the error, this will be logged in the AuditEventLogger under details column

Specified by:

getCommandDetails in interface DeephavenAclRestApiError

Returns:

customized details of the exception