oracle.odi.core.security

Class PermissionDeniedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

oracle.odi.exception.OdiUncheckedException

oracle.odi.core.security.OdiSecurityException

oracle.odi.core.security.PermissionDeniedException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AuthenticationRequiredException, AuthorizationServiceException

public class PermissionDeniedException
extends OdiSecurityException

Exception raised when attempting an operation that is not granted to the authenticated user.

Since:

11.1.1.3.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PermissionDeniedException(java.lang.Class oclass, PermissionType pt, long id, boolean snp) Deprecated. since 11.1.1.6.0. Instead of using constructor directly, appropriate method (#getExceptionForSnpClass() or #getExceptionForEntityClass()) should be called.
PermissionDeniedException(java.lang.Class oclass, PermissionType pt, long id, boolean snp, oracle.odi.internal.util.MessageHandle msg, java.lang.Object[] pMsgArgs) Deprecated. since 11.1.1.6.0. Instead of using constructor directly, appropriate method (#getExceptionForSnpClass() or #getExceptionForEntityClass()) should be called.
PermissionDeniedException(oracle.odi.internal.util.MessageHandle msg, java.lang.Object[] pMsgArgs) Construct a PermissionDeniedException object.
PermissionDeniedException(Permission per) Construct a PermissionDeniedException object.
PermissionDeniedException(Permission per, oracle.odi.internal.util.MessageHandle msg, java.lang.Object[] pMsgArgs) Construct a PermissionDeniedException object.
PermissionDeniedException(java.lang.Throwable pCause, oracle.odi.internal.util.MessageHandle pErrorMsg, java.lang.Object[] pMsgArgs) Base constructor with custom error message.

Method Summary

Modifier and Type	Method and Description
long	getDatabaseId() Return the id of the object to check.
Permission	getDeniedPermission() Return the Permission object which gets denied.
java.lang.Class	getEntityClass() Return the ODI class of the object to check.
PermissionType	getPermissionType() Return the permission type to check.
java.lang.Class	getSnpClass() Return the SNP class of the object to check.
static PermissionDeniedException	permissionDeniedForEntityClass(java.lang.Class entityClass, PermissionType pt, long id) Create PermissionDetailedException for Entity Class with default error message Messages.ERR_SECURITY_OPERATION_IS_NOT_GRANTED.
static PermissionDeniedException	permissionDeniedForEntityClass(java.lang.Class entityClass, PermissionType pt, long id, oracle.odi.internal.util.MessageHandle msg, java.lang.Object[] pMsgArgs) Create PermissionDetailedException for Entity Class.
static PermissionDeniedException	permissionDeniedForSnpClass(java.lang.Class snpClass, PermissionType pt, long id) Create PermissionDetailedException for Snp Class with default error message Messages.ERR_SECURITY_OPERATION_IS_NOT_GRANTED.
static PermissionDeniedException	permissionDeniedForSnpClass(java.lang.Class snpClass, PermissionType pt, long id, java.lang.Throwable cause) Create PermissionDetailedException for Snp Class with default error message Messages.ERR_SECURITY_OPERATION_IS_NOT_GRANTED.
static PermissionDeniedException	permissionDeniedForSnpClass(java.lang.Class snpClass, PermissionType pt, long id, java.lang.Throwable cause, oracle.odi.internal.util.MessageHandle msg, java.lang.Object[] pMsgArgs) Create PermissionDetailedException for Snp Class.

Methods inherited from class oracle.odi.exception.OdiUncheckedException

getErrorID, getErrorMsgHandle, getLocalizedMessage, getLocalizedMessage, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PermissionDeniedException

public PermissionDeniedException(java.lang.Throwable pCause,
                                 oracle.odi.internal.util.MessageHandle pErrorMsg,
                                 java.lang.Object[] pMsgArgs)

Base constructor with custom error message. Error message arguments are used for customizing error message. The number of arguments should match number of required arguments at error message.

Parameters:

pCause - exception root cause.

pErrorMsg - custom error message.

pMsgArgs - error message arguments.

PermissionDeniedException

public PermissionDeniedException(oracle.odi.internal.util.MessageHandle msg,
                                 java.lang.Object[] pMsgArgs)

Construct a PermissionDeniedException object.

Parameters:

msg - message about the permission denied problem.

pMsgArgs - error message arguments.

PermissionDeniedException

public PermissionDeniedException(Permission per)

Construct a PermissionDeniedException object.

Parameters:

per - Permission object.

PermissionDeniedException

public PermissionDeniedException(Permission per,
                                 oracle.odi.internal.util.MessageHandle msg,
                                 java.lang.Object[] pMsgArgs)

Construct a PermissionDeniedException object.

Parameters:

msg - message about the permission denied problem.

per - Permission object.

pMsgArgs - error message arguments.

PermissionDeniedException

@Deprecated
public PermissionDeniedException(java.lang.Class oclass,
                                             PermissionType pt,
                                             long id,
                                             boolean snp)

Deprecated. since 11.1.1.6.0. Instead of using constructor directly, appropriate method (#getExceptionForSnpClass() or #getExceptionForEntityClass()) should be called.

Construct a PermissionDeniedException object.

Parameters:

oclass - the class of the object to check permission.

pt - PermissionType object representing type of priviledge.

id - the id of the object to check permission.

snp - true if the object is SnpXXX object, false if the object is OdiXXXX object.

PermissionDeniedException

@Deprecated
public PermissionDeniedException(java.lang.Class oclass,
                                             PermissionType pt,
                                             long id,
                                             boolean snp,
                                             oracle.odi.internal.util.MessageHandle msg,
                                             java.lang.Object[] pMsgArgs)

Deprecated. since 11.1.1.6.0. Instead of using constructor directly, appropriate method (#getExceptionForSnpClass() or #getExceptionForEntityClass()) should be called.

Construct a PermissionDeniedException object.

Parameters:

msg - message about the permission denied problem.

oclass - the class of the object to check permission. Should be child of IRepositoryEntity or DwgObject

pt - PermissionType object representing type of privilege.

id - the id of the object to check permission.

snp - true if the object is SnpXXX object, false if the object is OdiXXXX object.

pMsgArgs - error message arguments.

Method Detail

permissionDeniedForSnpClass

public static PermissionDeniedException permissionDeniedForSnpClass(java.lang.Class snpClass,
                                                                    PermissionType pt,
                                                                    long id,
                                                                    java.lang.Throwable cause,
                                                                    oracle.odi.internal.util.MessageHandle msg,
                                                                    java.lang.Object[] pMsgArgs)

Create PermissionDetailedException for Snp Class.

Parameters:

snpClass - snp class of the object to check permission.

pt - permission type, which was violated.

id - database id.

cause - exception root cause, can be null.

msg - Custom messages.

pMsgArgs - error message arguments.

Returns:

PermissionDetailedException object.

permissionDeniedForSnpClass

public static PermissionDeniedException permissionDeniedForSnpClass(java.lang.Class snpClass,
                                                                    PermissionType pt,
                                                                    long id)

Create PermissionDetailedException for Snp Class with default error message Messages.ERR_SECURITY_OPERATION_IS_NOT_GRANTED.

Parameters:

snpClass - snp class of the object to check permission.

pt - permission type, which was violated.

id - database id.

Returns:

PermissionDetailedException object.

permissionDeniedForSnpClass

public static PermissionDeniedException permissionDeniedForSnpClass(java.lang.Class snpClass,
                                                                    PermissionType pt,
                                                                    long id,
                                                                    java.lang.Throwable cause)

Create PermissionDetailedException for Snp Class with default error message Messages.ERR_SECURITY_OPERATION_IS_NOT_GRANTED.

Parameters:

snpClass - snp class of the object to check permission.

pt - permission type, which was violated.

id - database id.

cause - exception root cause, can be null.

Returns:

PermissionDetailedException object.

permissionDeniedForEntityClass

public static PermissionDeniedException permissionDeniedForEntityClass(java.lang.Class entityClass,
                                                                       PermissionType pt,
                                                                       long id,
                                                                       oracle.odi.internal.util.MessageHandle msg,
                                                                       java.lang.Object[] pMsgArgs)

Create PermissionDetailedException for Entity Class.

Parameters:

entityClass - entity class of the object to check permission.

pt - permission type, which was violated.

id - database id.

msg - Custom messages.

pMsgArgs - error message arguments.

Returns:

PermissionDetailedException object.

permissionDeniedForEntityClass

public static PermissionDeniedException permissionDeniedForEntityClass(java.lang.Class entityClass,
                                                                       PermissionType pt,
                                                                       long id)

Create PermissionDetailedException for Entity Class with default error message Messages.ERR_SECURITY_OPERATION_IS_NOT_GRANTED.

Parameters:

entityClass - entity class of the object to check permission.

pt - permission type, which was violated.

id - database id.

Returns:

PermissionDetailedException object.

getDeniedPermission

public Permission getDeniedPermission()

Return the Permission object which gets denied.

Returns:

the Permission object which gets denied.

getPermissionType

public PermissionType getPermissionType()

Return the permission type to check.

Returns:

the permission type to check.

getDatabaseId

public long getDatabaseId()

Return the id of the object to check.

Returns:

the id of the object to check.

getSnpClass

public java.lang.Class getSnpClass()

Return the SNP class of the object to check.

Returns:

the SNP class of the object to check.

getEntityClass

public java.lang.Class getEntityClass()

Return the ODI class of the object to check.

Returns:

the ODI class of the object to check.