Package io.jmix.uiconstraints.security.constraint

Class UiComponentPolicyConstraint

java.lang.Object

io.jmix.uiconstraints.security.constraint.UiComponentPolicyConstraint

All Implemented Interfaces:

AccessConstraint<UiComponentPolicyContext>

@NullMarked
@Component("uicns_UiComponentPolicyConstraint")
public class UiComponentPolicyConstraint
extends Object
implements AccessConstraint<UiComponentPolicyContext>

Answers a UiComponentPolicyContext from the UI component policies assigned to the current user: a policy with the DENY effect denies the corresponding permission, and a component that no policy mentions is left permitted, since policies only restrict.

The constraint is registered by UiComponentPolicyConstraintsRegistration, so it takes part in AccessManager.applyRegisteredConstraints(T) along with the constraints of other policy types. An application may register a constraint of its own for the same context to restrict a component further; note that the applier only asks about components some policy of the current user mentions.

See Also:

• CurrentUserUiComponentPolicies

Field Summary

Fields

Modifier and Type	Field	Description
protected final CurrentUserUiComponentPolicies	currentUserUiComponentPolicies

Constructor Summary

Constructors

Constructor	Description
UiComponentPolicyConstraint(CurrentUserUiComponentPolicies currentUserUiComponentPolicies)

Method Summary

Modifier and Type	Method	Description
void	applyTo(UiComponentPolicyContext context)	Applies the constraint to the given access context.
Class<UiComponentPolicyContext>	getContextType()	Returns the access constraint type.

Methods inherited from class java.lang.Object

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

Field Details

currentUserUiComponentPolicies

protected final CurrentUserUiComponentPolicies currentUserUiComponentPolicies

Constructor Details

UiComponentPolicyConstraint

public UiComponentPolicyConstraint(CurrentUserUiComponentPolicies currentUserUiComponentPolicies)

Method Details

getContextType

public Class<UiComponentPolicyContext> getContextType()

Description copied from interface: AccessConstraint

Returns the access constraint type.

Specified by:

getContextType in interface AccessConstraint<UiComponentPolicyContext>

applyTo

public void applyTo(UiComponentPolicyContext context)

Description copied from interface: AccessConstraint

Applies the constraint to the given access context.

Specified by:

applyTo in interface AccessConstraint<UiComponentPolicyContext>