Package ch.tocco.nice2.rest.entity.api.ruleprovider

Class AbstractEntityRuleProvider

java.lang.Object

ch.tocco.nice2.rest.entity.api.ruleprovider.AbstractEntityRuleProvider

All Implemented Interfaces:

RuleProvider

Direct Known Subclasses:

FunctionMutationRuleProvider, JobApplicationRuleProvider, MembershipAdministrationRuleProvider, MembershipRegistrationRuleProvider, MembershipSearchRuleProvider, OwnTimetableRuleProvider, PresenceCheckRuleProvider, ReservationLecturerBookingConfirmationRuleProvider, WageViewRuleProvider

public abstract class AbstractEntityRuleProvider
extends Object
implements RuleProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected final QueryBuilderFactory	queryBuilderFactory

Constructor Summary

Constructors

Constructor	Description
AbstractEntityRuleProvider(TypeManager typeManager, DataModel dataModel, FormModel formModel, QueryBuilderFactory queryBuilderFactory)

Method Summary

Modifier and Type	Method	Description
protected boolean	allowDefaultAccess()	Per default access to some entities used by the widget config is granted.
protected boolean	allowReportingAccess()	Per default access to the entities used for generating reports is granted.
final void	createRulesForRequest(Principal principal, @Nullable String widgetKey, PolicyBuilder policyBuilder)
protected void	denyEntityReadAccessForPaths(PolicyBuilder policyBuilder, String model, Condition condition, String... paths)	Helper method to deny read access for specific paths for entities of a model which match the condition.
protected void	denyEntityWriteAccessForPaths(PolicyBuilder policyBuilder, String model, Condition condition, String... paths)	Helper method to deny write access for specific paths for entities of a model which match the condition.
protected Condition	getKeyCondition(String relation, List<PrimaryKey> keys)	Helper method which returns the key condition for a relation
protected void	grantActionAccess(PolicyBuilder policyBuilder, String... actionIds)
protected void	grantCreateAccess(PolicyBuilder policyBuilder, String... models)
protected void	grantEntityDeleteAccess(PolicyBuilder policyBuilder, String model, Condition condition)	Helper method to grant delete access to entities of a model which match the condition.
protected void	grantEntityReadAccess(PolicyBuilder policyBuilder, String model, Condition condition)	Helper method to grant read access to entities of a model which match the condition.
protected void	grantEntityReadAccessForPaths(PolicyBuilder policyBuilder, String model, Condition condition, String... paths)	Helper method to grant read access for specific paths for entities of a model which match the condition.
protected void	grantEntityWriteAccess(PolicyBuilder policyBuilder, String model, Condition condition)	Helper method to grant write access to entities of a model which match the condition.
protected void	grantEntityWriteAccessForPaths(PolicyBuilder policyBuilder, String model, Condition condition, String... paths)	Helper method to grant write access for specific paths for entities of a model which match the condition.
protected void	grantFullReadAccess(PolicyBuilder policyBuilder, String model)	Helper method to grant full (= all paths) read to all entities of a model.
protected void	grantReportingAccess(PolicyBuilder policyBuilder)
protected List<PrimaryKey>	loadRelatedKeys(String targetModel, String relation, List<PrimaryKey> sourceKeys)	Helper method which returns the primary keys of the related source keys
void	rulesForRequest(Principal principal, @Nullable String widgetKey, PolicyBuilder policyBuilder)	Implement specific rules for this rule provider.
void	setRuleProviderContributions(List<RuleProviderContribution> contributions)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.web.core.api.ruleprovider.RuleProvider

getId

Field Details

queryBuilderFactory

protected final QueryBuilderFactory queryBuilderFactory

Constructor Details

AbstractEntityRuleProvider

public AbstractEntityRuleProvider(TypeManager typeManager,
 DataModel dataModel,
 FormModel formModel,
 QueryBuilderFactory queryBuilderFactory)

Method Details

createRulesForRequest

public final void createRulesForRequest(Principal principal,
 @Nullable
 @Nullable String widgetKey,
 PolicyBuilder policyBuilder)

Specified by:

createRulesForRequest in interface RuleProvider

rulesForRequest

@VisibleForTesting
public void rulesForRequest(Principal principal,
 @Nullable
 @Nullable String widgetKey,
 PolicyBuilder policyBuilder)

Implement specific rules for this rule provider.

allowDefaultAccess

protected boolean allowDefaultAccess()

Per default access to some entities used by the widget config is granted. However this can be disabled here

allowReportingAccess

protected boolean allowReportingAccess()

Per default access to the entities used for generating reports is granted. However this can be disabled here

grantFullReadAccess

protected void grantFullReadAccess(PolicyBuilder policyBuilder,
 String model)

Helper method to grant full (= all paths) read to all entities of a model.

grantActionAccess

protected void grantActionAccess(PolicyBuilder policyBuilder,
 String... actionIds)

grantCreateAccess

protected void grantCreateAccess(PolicyBuilder policyBuilder,
 String... models)

grantEntityDeleteAccess

protected void grantEntityDeleteAccess(PolicyBuilder policyBuilder,
 String model,
 Condition condition)

Helper method to grant delete access to entities of a model which match the condition.

grantEntityReadAccess

protected void grantEntityReadAccess(PolicyBuilder policyBuilder,
 String model,
 Condition condition)

Helper method to grant read access to entities of a model which match the condition. Paths which are not whitelisted via contribution are not readable.

grantEntityWriteAccess

protected void grantEntityWriteAccess(PolicyBuilder policyBuilder,
 String model,
 Condition condition)

Helper method to grant write access to entities of a model which match the condition. Paths which are not whitelisted via contribution are not readable.

grantEntityWriteAccessForPaths

protected void grantEntityWriteAccessForPaths(PolicyBuilder policyBuilder,
 String model,
 Condition condition,
 String... paths)

Helper method to grant write access for specific paths for entities of a model which match the condition.

grantEntityReadAccessForPaths

protected void grantEntityReadAccessForPaths(PolicyBuilder policyBuilder,
 String model,
 Condition condition,
 String... paths)

Helper method to grant read access for specific paths for entities of a model which match the condition.

denyEntityWriteAccessForPaths

protected void denyEntityWriteAccessForPaths(PolicyBuilder policyBuilder,
 String model,
 Condition condition,
 String... paths)

Helper method to deny write access for specific paths for entities of a model which match the condition.

denyEntityReadAccessForPaths

protected void denyEntityReadAccessForPaths(PolicyBuilder policyBuilder,
 String model,
 Condition condition,
 String... paths)

Helper method to deny read access for specific paths for entities of a model which match the condition.

loadRelatedKeys

protected List<PrimaryKey> loadRelatedKeys(String targetModel,
 String relation,
 List<PrimaryKey> sourceKeys)

Helper method which returns the primary keys of the related source keys

getKeyCondition

protected Condition getKeyCondition(String relation,
 List<PrimaryKey> keys)

Helper method which returns the key condition for a relation

grantReportingAccess

@VisibleForTesting
protected void grantReportingAccess(PolicyBuilder policyBuilder)

setRuleProviderContributions

@Autowired
public void setRuleProviderContributions(List<RuleProviderContribution> contributions)