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

Class DbAclCheckedExceptionMapper

java.lang.Object

com.illumon.iris.db.v2.permissions.rs.BaseExceptionMapper<DbAclCheckedException>

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

All Implemented Interfaces:

io.deephaven.shadow.resteasy.javax.ws.rs.ext.ExceptionMapper<DbAclCheckedException>

@Provider
public class DbAclCheckedExceptionMapper
extends BaseExceptionMapper<DbAclCheckedException>

The ExceptionMapper for all checked exceptions raised in the acl api. Subclass of BaseExceptionMapper that helps populate AuditEvent with error information specific to DbAclCheckedException

Field Summary

Fields inherited from class com.illumon.iris.db.v2.permissions.rs.BaseExceptionMapper

request

Constructor Summary

Constructors

Constructor	Description
DbAclCheckedExceptionMapper()

Method Summary

Modifier and Type	Method	Description
protected String	getCommandName(DbAclCheckedException exception)	The name of the command the request uri points to, if NPE or generic error would include the requestURI
protected String	getErrorDetails(DbAclCheckedException exception)	Part of the error message that is logged, allows implementations to customize what can be included
protected io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status	getResponseStatus(DbAclCheckedException exception)	Implementations should return the appropriate Response Status to build and propagate in the Response
protected void	updateAuditEventBuilder(io.deephaven.enterprise.auth.audit.AuditEventBuilder aeBuilder, DbAclCheckedException exception)	The implementations can add customization detail of what to log for in AuditEvent

Methods inherited from class com.illumon.iris.db.v2.permissions.rs.BaseExceptionMapper

handleShadowExceptionMappers, toResponse

Methods inherited from class java.lang.Object

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

Constructor Details

DbAclCheckedExceptionMapper

public DbAclCheckedExceptionMapper()

Method Details

getCommandName

protected String getCommandName(@NotNull
 DbAclCheckedException exception)

Description copied from class: BaseExceptionMapper

The name of the command the request uri points to, if NPE or generic error would include the requestURI

Specified by:

getCommandName in class BaseExceptionMapper<DbAclCheckedException>

Parameters:

exception - The exception that has occurred

Returns:

name of the command the request uri points to

getErrorDetails

protected String getErrorDetails(@NotNull
 DbAclCheckedException exception)

Description copied from class: BaseExceptionMapper

Part of the error message that is logged, allows implementations to customize what can be included

Specified by:

getErrorDetails in class BaseExceptionMapper<DbAclCheckedException>

Parameters:

exception - The exception that has occurred

Returns:

string with customized details about the specific error

getResponseStatus

protected io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status getResponseStatus(@NotNull
 DbAclCheckedException exception)

Description copied from class: BaseExceptionMapper

Implementations should return the appropriate Response Status to build and propagate in the Response

Specified by:

getResponseStatus in class BaseExceptionMapper<DbAclCheckedException>

Parameters:

exception - The thrown exception used to extract the response status

Returns:

The Response Status for the exception

updateAuditEventBuilder

protected void updateAuditEventBuilder(@NotNull
 io.deephaven.enterprise.auth.audit.AuditEventBuilder aeBuilder,
 @NotNull
 DbAclCheckedException exception)

Description copied from class: BaseExceptionMapper

The implementations can add customization detail of what to log for in AuditEvent

Specified by:

updateAuditEventBuilder in class BaseExceptionMapper<DbAclCheckedException>

Parameters:

aeBuilder - The AuditEventBuilder instance being used in building the AuditEvent to log

exception - The thrown exception