Package org.odpi.openmetadata.commonservices.ffdc.exceptions

Class UserNotAuthorizedException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException
All Implemented Interfaces:
Serializable
public class UserNotAuthorizedException extends UserNotAuthorizedException
The UserNotAuthorizedException is thrown by the OMAG Service when a userId passed on a request is not authorized to perform the requested action.
See Also:

  • Constructor Details

    • UserNotAuthorizedException

      public UserNotAuthorizedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String userId)
      This is the typical constructor used for creating an UserNotAuthorizedException.
      Parameters:
      messageDefinition - content of the message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      userId - offending userId

    • UserNotAuthorizedException

      public UserNotAuthorizedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String userId, Map<String,Object> relatedProperties)
      This is the typical constructor used for creating an UserNotAuthorizedException. The properties allow additional information to be associated with the exception.
      Parameters:
      messageDefinition - content of the message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      userId - offending userId
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

    • UserNotAuthorizedException

      public UserNotAuthorizedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String userId)
      This is the constructor used for creating an UserNotAuthorizedException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.
      Parameters:
      messageDefinition - content of the message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      caughtError - previous error causing this exception
      userId - offending userId

    • UserNotAuthorizedException

      public UserNotAuthorizedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String userId, Map<String,Object> relatedProperties)
      This is the constructor used for creating an UserNotAuthorizedException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.
      Parameters:
      messageDefinition - content of the message
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      caughtError - previous error causing this exception
      userId - offending userId
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

    • UserNotAuthorizedException

      public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, String userId, Map<String,Object> relatedProperties)
      This is the constructor used when receiving an exception from a remote server. The values are stored directly in the response object and are passed explicitly to the new exception. Notice that the technical aspects of the exception - such as class name creating the exception are local values so that the implementation of the server is not exposed.
      Parameters:
      httpCode - http response code to use if this exception flows over a REST call
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      errorMessage - description of error
      errorMessageId - unique identifier for the message
      errorMessageParameters - parameters that were inserted in the message
      systemAction - actions of the system as a result of the error
      userAction - instructions for correcting the error
      caughtErrorClassName - previous error causing this exception
      userId - failing userId
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

    • UserNotAuthorizedException

      @Deprecated public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String userId)
      Deprecated.
      This is the typical constructor used for creating an exception.
      Parameters:
      httpCode - http response code to use if this exception flows over a rest call
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      errorMessage - description of error
      systemAction - actions of the system as a result of the error
      userAction - instructions for correcting the error
      userId - offending userId

    • UserNotAuthorizedException

      @Deprecated public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String userId, Map<String,Object> relatedProperties)
      Deprecated.
      This is the typical constructor used for creating an exception.
      Parameters:
      httpCode - http response code to use if this exception flows over a rest call
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      errorMessage - description of error
      systemAction - actions of the system as a result of the error
      userAction - instructions for correcting the error
      userId - offending userId
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

    • UserNotAuthorizedException

      @Deprecated public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, String userId)
      Deprecated.
      This is the constructor used for creating an exception that resulted from a previous error.
      Parameters:
      httpCode - http response code to use if this exception flows over a rest call
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      errorMessage - description of error
      systemAction - actions of the system as a result of the error
      userAction - instructions for correcting the error
      caughtError - the error that resulted in this exception.
      userId - calling user

    • UserNotAuthorizedException

      @Deprecated public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, String userId, Map<String,Object> relatedProperties)
      Deprecated.
      This is the constructor used for creating an exception that resulted from a previous error.
      Parameters:
      httpCode - http response code to use if this exception flows over a rest call
      className - name of class reporting error
      actionDescription - description of function it was performing when error detected
      errorMessage - description of error
      systemAction - actions of the system as a result of the error
      userAction - instructions for correcting the error
      caughtError - the error that resulted in this exception.
      userId - calling user
      relatedProperties - arbitrary properties that may help with diagnosing the problem.

    • UserNotAuthorizedException

      public UserNotAuthorizedException(UserNotAuthorizedException template)
      This is the copy/clone constructor used for creating an exception.
      Parameters:
      template - object to copy

  • Method Details