io.jmix.core.security

Class AccessDeniedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.jmix.core.security.AccessDeniedException

All Implemented Interfaces:

java.io.Serializable

public class AccessDeniedException
extends java.lang.RuntimeException

Exception that is raised on attempt to violate a security constraint.

You can throw this exception in application code if you want a standard notification about "access denied" to be shown to the user and the event to be logged.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AccessDeniedException(java.lang.String type, java.lang.String resource) Constructor.
AccessDeniedException(java.lang.String type, java.lang.String resource, java.lang.String action) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAction()
java.lang.String	getResource()
java.lang.String	getType()

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

AccessDeniedException

public AccessDeniedException(java.lang.String type,
                             java.lang.String resource)

Constructor.

Parameters:

resource - permission target object, e.g. a screen id or entity operation name. When throwing the exception in application code, can be any string suitable to describe the situation in the log.

type - permission type

AccessDeniedException

public AccessDeniedException(java.lang.String type,
                             java.lang.String resource,
                             @Nullable
                             java.lang.String action)

Constructor.

Parameters:

resource - permission target object, e.g. a screen id or entity operation name. When throwing the exception in application code, can be any string suitable to describe the situation in the log.

type - permission type

action - type of operation on resource

Method Detail

getType

public java.lang.String getType()

getResource

public java.lang.String getResource()

getAction

public java.lang.String getAction()