org.geomajas.security

Interface BaseAuthorization

All Known Subinterfaces:

AreaAuthorization, AttributeAuthorization, Authorization, FeatureAuthorization, SecurityContext, VectorLayerSelectFilterAuthorization

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

Base authorization, determines authorization of tools and commands and entire layers.

Since:

1.6.0

Author:

Joachim Van der Auwera

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Id for this authorization object if any.
boolean	isCommandAuthorized(String commandName) Check whether the command with given name is allowed to be used.
boolean	isLayerCreateAuthorized(String layerId) Check whether creating new features may be allowed.
boolean	isLayerDeleteAuthorized(String layerId) Check whether there are features in the layer which can be deleted.
boolean	isLayerUpdateAuthorized(String layerId) Check whether there are features in the layer which can be updated.
boolean	isLayerVisible(String layerId) Check whether there are features in the layer which are visible.
boolean	isToolAuthorized(String toolId) Check whether the tool with given id is allowed to be used.

Method Detail

getId

String getId()

Id for this authorization object if any.

Lack of id can hamper caching of data.

When two Authorization objects from the same SecurityService have the same id, they should behave exactly the same.

The id is not allowed to contain the horizontal bar ("|") or at ("@") characters (except on the SecurityContext where these characters are used to make the combination of contained authentications unique).

Returns:

authentication id

isToolAuthorized

boolean isToolAuthorized(String toolId)

Check whether the tool with given id is allowed to be used.

Parameters:

toolId - tool id, as specified in ClientToolInfo.

Returns:

true when access is allowed

isCommandAuthorized

boolean isCommandAuthorized(String commandName)

Check whether the command with given name is allowed to be used.

Parameters:

commandName - name of command as passed to CommandDispatcher

Returns:

true when access is allowed

isLayerVisible

boolean isLayerVisible(String layerId)

Check whether there are features in the layer which are visible.

Parameters:

layerId - layer id for which the visibility should be tested

Returns:

true when the logged in user is allowed to see part of the layer

isLayerUpdateAuthorized

boolean isLayerUpdateAuthorized(String layerId)

Check whether there are features in the layer which can be updated.

When isLayerUpdateAuthorized() is true, then isLayerVisible() should also be true.

Parameters:

layerId - layer id for which the visible area should be returned

Returns:

true when the logged in user is allowed to edit the visible part of the layer

isLayerCreateAuthorized

boolean isLayerCreateAuthorized(String layerId)

Check whether creating new features may be allowed.

When isLayerCreateAuthorized() is true, then isLayerVisible() should also be true.

Parameters:

layerId - layer id for which the visible area should be returned

Returns:

true when the logged in user is allowed to edit the visible part of the layer

isLayerDeleteAuthorized

boolean isLayerDeleteAuthorized(String layerId)

Check whether there are features in the layer which can be deleted.

When isLayerDeleteAuthorized() is true, then isLayerVisible() should also be true.

Parameters:

layerId - layer id for which the visible area should be returned

Returns:

true when the logged in user is allowed to edit the visible part of the layer