com.sap.cloud.sdk.cloudplatform.security.user.exception

Class UserNotInRoleException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.sap.cloud.sdk.cloudplatform.security.user.exception.UserNotInRoleException

All Implemented Interfaces:

WithErrorResponse, Serializable

public class UserNotInRoleException
extends RuntimeException
implements WithErrorResponse

Exception indicating that a user does not have a required role.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserNotInRoleException(User user, Role role) Creates the exception with an error message based on the given user and role.
UserNotInRoleException(User user, Role role, String message) Creates the exception by delegating the message to the super constructor and storing the user and the rule.
UserNotInRoleException(User user, Role role, String message, Throwable cause) Creates the exception by delegating the message and the causing exception to the super constructor and storing the user and the rule.

Method Summary

Modifier and Type	Method and Description
ResponseWithErrorCode	getErrorResponse() Gets the response containing an HTTP error code.
Role	getRole()
User	getUser()

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 Detail

UserNotInRoleException

public UserNotInRoleException(@Nullable
                              User user,
                              @Nullable
                              Role role)

Creates the exception with an error message based on the given user and role.

Parameters:

user - The user which didn't have the needed role.

role - The role which the user didn't have.

UserNotInRoleException

public UserNotInRoleException(@Nullable
                              User user,
                              @Nullable
                              Role role,
                              String message)

Creates the exception by delegating the message to the super constructor and storing the user and the rule.

Parameters:

user - The user which didn't have the needed role.

role - The role which the user didn't have.

message - The exception message.

UserNotInRoleException

public UserNotInRoleException(@Nullable
                              User user,
                              @Nullable
                              Role role,
                              String message,
                              Throwable cause)

Creates the exception by delegating the message and the causing exception to the super constructor and storing the user and the rule.

Parameters:

user - The user which didn't have the needed role.

role - The role which the user didn't have.

message - The exception message.

cause - The exception that caused the exception to be created.

Method Detail

getErrorResponse

@Nonnull
public ResponseWithErrorCode getErrorResponse()

Description copied from interface: WithErrorResponse

Gets the response containing an HTTP error code.

Specified by:

getErrorResponse in interface WithErrorResponse

Returns:

The error response.

getUser

@Nullable
public User getUser()

getRole

@Nullable
public Role getRole()