com.haulmont.cuba.core

Interface PersistenceSecurity

All Superinterfaces:

Security

All Known Implementing Classes:

PersistenceSecurityImpl

public interface PersistenceSecurity
extends Security

Interface providing methods to apply security on persistence layer.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONSTRAINT_PARAM_SESSION_ATTR
static java.lang.String	CONSTRAINT_PARAM_USER_GROUP_ID
static java.lang.String	CONSTRAINT_PARAM_USER_ID
static java.lang.String	CONSTRAINT_PARAM_USER_LOGIN
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	applyConstraints(java.util.Collection<Entity> entities) Applies in-memory constraints to the entity fields by filtered data
void	applyConstraints(Entity entity) Applies in-memory constraints to the entity by filtered data
boolean	applyConstraints(Query query) Modifies the query depending on current user's security constraints.
void	assertToken(Entity entity) Validate that security token exists for specific cases.
void	assertTokenForREST(Entity entity, View view) Validate that security token for REST exists for specific cases.
void	calculateFilteredData(java.util.Collection<Entity> entities) Calculate filtered data
void	calculateFilteredData(Entity entity) Calculate filtered data
boolean	filterByConstraints(java.util.Collection<Entity> entities) Filter entities in collection by in-memory constraints
boolean	filterByConstraints(Entity entity) Filter entity by in-memory constraints
void	restoreFilteredData(Entity entity) Restores filtered data from security token
void	restoreSecurityState(Entity entity) Reads security token and restores security state
default void	restoreSecurityStateAndFilteredData(Entity entity) Reads security token and restores security state and filtered data
void	setQueryParam(Query query, java.lang.String paramName) Sets the query param to a value provided by user session (see constants above).

Methods inherited from interface com.haulmont.cuba.core.global.Security

checkSpecificPermission, evaluateConstraintScript, hasConstraints, hasInMemoryConstraints, isEntityAttrPermitted, isEntityAttrPermitted, isEntityAttrReadPermitted, isEntityAttrReadPermitted, isEntityAttrUpdatePermitted, isEntityAttrUpdatePermitted, isEntityOpPermitted, isEntityOpPermitted, isPermitted, isPermitted, isScreenPermitted, isSpecificPermitted

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

CONSTRAINT_PARAM_SESSION_ATTR

static final java.lang.String CONSTRAINT_PARAM_SESSION_ATTR

See Also:

Constant Field Values

CONSTRAINT_PARAM_USER_LOGIN

static final java.lang.String CONSTRAINT_PARAM_USER_LOGIN

See Also:

Constant Field Values

CONSTRAINT_PARAM_USER_ID

static final java.lang.String CONSTRAINT_PARAM_USER_ID

See Also:

Constant Field Values

CONSTRAINT_PARAM_USER_GROUP_ID

static final java.lang.String CONSTRAINT_PARAM_USER_GROUP_ID

See Also:

Constant Field Values

Method Detail

applyConstraints

boolean applyConstraints(Query query)

Modifies the query depending on current user's security constraints.

Parameters:

query - query to modify

Returns:

true if any constraints have been applied

setQueryParam

void setQueryParam(Query query,
                   java.lang.String paramName)

Sets the query param to a value provided by user session (see constants above).

Parameters:

query - Query instance

paramName - parameter to set

applyConstraints

void applyConstraints(Entity entity)

Applies in-memory constraints to the entity by filtered data

Parameters:

entity - -

applyConstraints

void applyConstraints(java.util.Collection<Entity> entities)

Applies in-memory constraints to the entity fields by filtered data

Parameters:

entities - - collection of entities

filterByConstraints

boolean filterByConstraints(java.util.Collection<Entity> entities)

Filter entities in collection by in-memory constraints

Parameters:

entities - - collection of entities that will be filtered

Returns:

true if some items were filtered out

filterByConstraints

boolean filterByConstraints(Entity entity)

Filter entity by in-memory constraints

Parameters:

entity - - entity that will be filtered

Returns:

true, if entity should be filtered out from client output

restoreSecurityState

void restoreSecurityState(Entity entity)

Reads security token and restores security state

Parameters:

entity - - entity to restore security state

restoreFilteredData

void restoreFilteredData(Entity entity)

Restores filtered data from security token

Parameters:

entity - - entity to restore filtered data

restoreSecurityStateAndFilteredData

default void restoreSecurityStateAndFilteredData(Entity entity)

Reads security token and restores security state and filtered data

Parameters:

entity - - entity to restore

assertToken

void assertToken(Entity entity)

Validate that security token exists for specific cases. For example, security constraints exists

Parameters:

entity - - entity to check security token

assertTokenForREST

void assertTokenForREST(Entity entity,
                        View view)

Validate that security token for REST exists for specific cases. For example, security constraints exists

Parameters:

entity - - entity to check security token

view - - view for entity

calculateFilteredData

void calculateFilteredData(Entity entity)

Calculate filtered data

Parameters:

entity - for which will calculate filtered data

calculateFilteredData

void calculateFilteredData(java.util.Collection<Entity> entities)

Calculate filtered data

Parameters:

entities - - collection of entities for which will calculate filtered data