Interface DeephavenAclRestApiError

All Known Implementing Classes:
DbAclCheckedException, DbAclUncheckedException

public interface DeephavenAclRestApiError
This interface captures the information needed to log AuditEvents. Checked DbAclCheckedException and unchecked DbAclUncheckedException implement it.
  • Method Summary

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

    • getResponseStatus

      io.deephaven.shadow.resteasy.javax.ws.rs.core.Response.Status getResponseStatus()
      Identifies the ResponseStatus returned in API Response
      Returns:
      The Response status that should be propagated to clients
    • getCommandName

      String getCommandName()
      Identifies the DbAclWriter method invoked by acl rest api request.
      Returns:
      the name of the command that caused the exception
    • getCommandDetails

      String getCommandDetails()
      Customized details that identifies the error, this will be logged in the AuditEventLogger under details column
      Returns:
      customized details of the exception