org.geomajas.security

Interface FeatureAuthorization

All Superinterfaces:

BaseAuthorization

All Known Subinterfaces:

Authorization, SecurityContext

@Api(allMethods=true)
@UserImplemented
public interface FeatureAuthorization
extends BaseAuthorization

Authorizations at the individual feature level.

Since:

1.6.0

Author:

Joachim Van der Auwera

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isFeatureCreateAuthorized(String layerId, InternalFeature feature) Check whether creation of the feature is allowed.
boolean	isFeatureDeleteAuthorized(String layerId, InternalFeature feature) Check whether deletion of the feature is allowed.
boolean	isFeatureUpdateAuthorized(String layerId, InternalFeature feature) Check whether the feature is allowed to be updated in some way.
boolean	isFeatureUpdateAuthorized(String layerId, InternalFeature orgFeature, InternalFeature newFeature) Check whether a update of the feature to the new state is authorized.
boolean	isFeatureVisible(String layerId, InternalFeature feature) Check whether a feature with given id is visible.

Methods inherited from interface org.geomajas.security.BaseAuthorization

getId, isCommandAuthorized, isLayerCreateAuthorized, isLayerDeleteAuthorized, isLayerUpdateAuthorized, isLayerVisible, isToolAuthorized

Method Detail

isFeatureVisible

boolean isFeatureVisible(String layerId,
                       InternalFeature feature)

Check whether a feature with given id is visible.

It is assumed the layer can convert the feature id to a String and that the security component and/or the person who writes the policies "know" how the layer does this (to allow the policies to be set).

If the layer in not visible, the features should also be not visible.

Parameters:

layerId - layer which contains the feature to test

feature - feature which needs to be tested

Returns:

true when the feature is visible

isFeatureUpdateAuthorized

boolean isFeatureUpdateAuthorized(String layerId,
                                InternalFeature feature)

Check whether the feature is allowed to be updated in some way.

This method can be used to know whether is makes sense to allow the logged in user to change anything about the feature.

It is assumed the layer can convert the feature id to a String and that the security component and/or the person who writes the policies "know" how the layer does this (to allow the policies to be set).

When isFeatureUpdateAuthorized() is true, then isFeatureVisible() should also be true.

Parameters:

layerId - layer which contains the feature to test

feature - feature which needs to tested

Returns:

true when the feature is visible

isFeatureUpdateAuthorized

boolean isFeatureUpdateAuthorized(String layerId,
                                InternalFeature orgFeature,
                                InternalFeature newFeature)

Check whether a update of the feature to the new state is authorized.

This method can be used to check whether the actual update will result in a security exception.

It is assumed the layer can convert the feature id to a String and that the security component and/or the person who writes the policies "know" how the layer does this (to allow the policies to be set).

Parameters:

layerId - layer which contains the feature to test

orgFeature - feature original state, note that just receiving the original state for the client is insufficient for this check as the client could have tampered with the value.

newFeature - feature new state

Returns:

true when the feature is visible

isFeatureDeleteAuthorized

boolean isFeatureDeleteAuthorized(String layerId,
                                InternalFeature feature)

Check whether deletion of the feature is allowed.

When no feature is specified, it checks whether it may be possible to delete a feature.

Parameters:

layerId - layer which contains the feature to test

feature - feature which needs to be deleted

Returns:

true when deleting the feature is allowed

isFeatureCreateAuthorized

boolean isFeatureCreateAuthorized(String layerId,
                                InternalFeature feature)

Check whether creation of the feature is allowed.

When no feature is specified, it checks whether it may be possible to create a feature, same as isLayerCreateAuthorized().

Parameters:

layerId - layer which contains the feature to test

feature - feature which needs to be created

Returns:

true when deleting the feature is allowed