Class UseOtherPermissionNameCustomPermissionChecker

java.lang.Object

com.kingsrook.qqq.backend.core.actions.permissions.UseOtherPermissionNameCustomPermissionChecker

All Implemented Interfaces:

CustomPermissionChecker, InitializableViaCodeReference

public class UseOtherPermissionNameCustomPermissionChecker
extends Object
implements CustomPermissionChecker, InitializableViaCodeReference

Simple implementation of a Custom Permission Checker, that takes a permissionName property, and just checks if the session has that permission.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PERMISSION_NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
UseOtherPermissionNameCustomPermissionChecker()

Method Summary

Modifier and Type	Method	Description
static QCodeReferenceWithProperties	build(String permissionName)	Factory method to build a code reference to this class, with the given permission name.
AvailablePermission	buildAvailablePermission(QPermissionRules rules, PermissionSubType permissionSubType, String baseName, MetaDataWithName metaDataWithName, String objectType)	To assist with PermissionsHelper.getAllAvailablePermissions(QInstance) this method lets the application return a specialized AvailablePermission object, e.g., with the name that the permission name that the custom checker will use.
void	checkPermissionsThrowing(AbstractActionInput actionInput, MetaDataWithPermissionRules metaDataWithPermissionRules)	Per CustomPermissionChecker, check if the active session has the permission specified as this class's permissionName property.
String	getPermissionName()	Getter for permissionName
boolean	handlesBuildAvailablePermission()	To assist with PermissionsHelper.getAllAvailablePermissions(QInstance) this method indicates that this implementation of this interface has implemented CustomPermissionChecker.buildAvailablePermission(QPermissionRules, PermissionSubType, String, MetaDataWithName, String)
void	initialize(QCodeReference codeReference)	As per InitializableViaCodeReference, initialize an instance of this class using the supplied QCodeReference, which is expected to be a QCodeReferenceWithProperties.
void	setPermissionName(String permissionName)	Setter for permissionName
UseOtherPermissionNameCustomPermissionChecker	withPermissionName(String permissionName)	Fluent setter for permissionName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.kingsrook.qqq.backend.core.actions.permissions.CustomPermissionChecker

buildBaseAvailablePermission

Field Details

PERMISSION_NAME_PROPERTY

public static final String PERMISSION_NAME_PROPERTY

See Also:

• Constant Field Values

Constructor Details

UseOtherPermissionNameCustomPermissionChecker

public UseOtherPermissionNameCustomPermissionChecker()

Method Details

build

public static QCodeReferenceWithProperties build(String permissionName)

Factory method to build a code reference to this class, with the given permission name.

Parameters:

permissionName - Full name of the permission to be checked by instances of this class

Returns:

code reference that can be passed to, e.g., QPermissionRules.withCustomPermissionChecker(QCodeReference)

initialize

public void initialize(QCodeReference codeReference)

As per InitializableViaCodeReference, initialize an instance of this class using the supplied QCodeReference, which is expected to be a QCodeReferenceWithProperties.

Specified by:

initialize in interface InitializableViaCodeReference

checkPermissionsThrowing

public void checkPermissionsThrowing(AbstractActionInput actionInput,
 MetaDataWithPermissionRules metaDataWithPermissionRules)
                              throws QPermissionDeniedException

Per CustomPermissionChecker, check if the active session has the permission specified as this class's permissionName property.

Specified by:

checkPermissionsThrowing in interface CustomPermissionChecker

Parameters:

actionInput - generally the input data container for the action being performed - e.g., an InsertInput or RunProcessInput

metaDataWithPermissionRules - the table/process/etc that is being requested by a user.

Throws:

QPermissionDeniedException - to indicate the user does not have permission. The method should return without exception to indicate permission granted,

handlesBuildAvailablePermission

public boolean handlesBuildAvailablePermission()

Description copied from interface: CustomPermissionChecker

To assist with PermissionsHelper.getAllAvailablePermissions(QInstance) this method indicates that this implementation of this interface has implemented CustomPermissionChecker.buildAvailablePermission(QPermissionRules, PermissionSubType, String, MetaDataWithName, String)

Specified by:

handlesBuildAvailablePermission in interface CustomPermissionChecker

Returns:

in the default implementation, false is returned.

buildAvailablePermission

public AvailablePermission buildAvailablePermission(QPermissionRules rules,
 PermissionSubType permissionSubType,
 String baseName,
 MetaDataWithName metaDataWithName,
 String objectType)

Description copied from interface: CustomPermissionChecker

To assist with PermissionsHelper.getAllAvailablePermissions(QInstance) this method lets the application return a specialized AvailablePermission object, e.g., with the name that the permission name that the custom checker will use.

Specified by:

buildAvailablePermission in interface CustomPermissionChecker

Returns:

an AvailablePermission object to add to the set of all available permissions. If null, then no permission is added to that result.

See Also:

• CustomPermissionChecker.buildBaseAvailablePermission(QPermissionRules, PermissionSubType, MetaDataWithName, String)

getPermissionName

public String getPermissionName()

Getter for permissionName

See Also:

• withPermissionName(String)

setPermissionName

public void setPermissionName(String permissionName)

Setter for permissionName

See Also:

• withPermissionName(String)

withPermissionName

public UseOtherPermissionNameCustomPermissionChecker withPermissionName(String permissionName)

Fluent setter for permissionName

Parameters:

permissionName - The full permission name that is checked by this checker. note that this value is not expected to be directly set via this setter - but rather, via the initialization of this class through a QCodeReferenceWithProperties.

Returns:

this