org.geomajas.security

Interface AreaAuthorization

All Superinterfaces:

BaseAuthorization

All Known Subinterfaces:

Authorization, SecurityContext

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

Authorizations based on area.

Since:

1.6.0

Author:

Joachim Van der Auwera

Method Summary

Methods

Modifier and Type	Method and Description
com.vividsolutions.jts.geom.Geometry	getCreateAuthorizedArea(String layerId) Get the area of the layer where creating features is allowed.
com.vividsolutions.jts.geom.Geometry	getDeleteAuthorizedArea(String layerId) Get the area of the layer where deleting features is allowed.
com.vividsolutions.jts.geom.Geometry	getUpdateAuthorizedArea(String layerId) Get the area of the layer where updating features is allowed.
com.vividsolutions.jts.geom.Geometry	getVisibleArea(String layerId) Get the visible area for a layer.
boolean	isPartlyCreateAuthorizedSufficient(String layerId) Indicates whether features which only partly fall inside the area where creation is allowed are still allowed to be created.
boolean	isPartlyDeleteAuthorizedSufficient(String layerId) Indicates whether features which only partly fall inside the deletable area are still considered deletable.
boolean	isPartlyUpdateAuthorizedSufficient(String layerId) Indicates whether features which only partly fall inside the updatable area are still considered updatable.
boolean	isPartlyVisibleSufficient(String layerId) Indicates whether features which only partly fall inside the visible area are still considered visible.

Methods inherited from interface org.geomajas.security.BaseAuthorization

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

Method Detail

getVisibleArea

com.vividsolutions.jts.geom.Geometry getVisibleArea(String layerId)

Get the visible area for a layer.

Note that returning null means that the entire layer is invisible.

The return value should be consistent with the isLayerVisible() method. If isLayerVisible() is false, this method should return null. If isLayerVisible() is true, a Geometry should be returned.

Geometry coordinates need to be in layer coordinate space.

Parameters:

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

Returns:

geometry which indicates the visible area or null when nothing is visible

isPartlyVisibleSufficient

boolean isPartlyVisibleSufficient(String layerId)

Indicates whether features which only partly fall inside the visible area are still considered visible.

Parameters:

layerId - layer id for which the status needs to be checked

Returns:

true when any feature which intersects the visible area is considered visible, false when a feature needs to be inside the visible area to be considered visible.

getUpdateAuthorizedArea

com.vividsolutions.jts.geom.Geometry getUpdateAuthorizedArea(String layerId)

Get the area of the layer where updating features is allowed.

Note that returning null means that the entire layer prohibits updates.

The return value should be consistent with the isLayerUpdateAuthorized() method. If isLayerUpdateAuthorized() is false, this method should return null. If isLayerUpdateAuthorized() is true, a Geometry should be returned.

The return value should also be consistent with getVisibleArea(). The returned area should be contained in the visible area.

Geometry coordinates need to be in layer coordinate space.

Parameters:

layerId - layer id for which the area where updates are allowed should be returned

Returns:

geometry which indicates the updatable area or null when nothing is updatable

isPartlyUpdateAuthorizedSufficient

boolean isPartlyUpdateAuthorizedSufficient(String layerId)

Indicates whether features which only partly fall inside the updatable area are still considered updatable.

Parameters:

layerId - layer id for which the status needs to be checked

Returns:

true when any feature which intersects the visible area is considered updatable, false when a feature needs to be inside the updatable area to be considered updatable.

getCreateAuthorizedArea

com.vividsolutions.jts.geom.Geometry getCreateAuthorizedArea(String layerId)

Get the area of the layer where creating features is allowed.

Note that returning null means that the entire layer prohibits creation.

The return value should be consistent with the isLayerCreateAuthorized() method. If isLayerCreateAuthorized() is false, this method should return null. If isLayerCreateAuthorized() is true, a Geometry should be returned.

The return value should also be consistent with getVisibleArea(). The returned area should be contained in the visible area.

Geometry coordinates need to be in layer coordinate space.

Parameters:

layerId - layer id for which the area where creating features is allowed should be returned

Returns:

geometry which indicates the area where creation is allowed or null when nothing can be created

isPartlyCreateAuthorizedSufficient

boolean isPartlyCreateAuthorizedSufficient(String layerId)

Indicates whether features which only partly fall inside the area where creation is allowed are still allowed to be created.

Parameters:

layerId - layer id for which the status needs to be checked

Returns:

true when any feature which intersects the createAuthorized area is allowed to be created, false when a feature needs to be inside the creatable area to be created.

getDeleteAuthorizedArea

com.vividsolutions.jts.geom.Geometry getDeleteAuthorizedArea(String layerId)

Get the area of the layer where deleting features is allowed.

Note that returning null means that the entire layer prohibits deletion.

The return value should be consistent with the isLayerDeleteAuthorized() method. If isLayerDeleteAuthorized() is false, this method should return null. If isLayerDeleteAuthorized() is true, a Geometry should be returned.

The return value should also be consistent with getVisibleArea(). The returned area should be contained in the visible area.

Geometry coordinates need to be in layer coordinate space.

Parameters:

layerId - layer id for which the area where creating features is allowed should be returned

Returns:

geometry which indicates the area in which deletion is allowed or null when nothing can be deleted

isPartlyDeleteAuthorizedSufficient

boolean isPartlyDeleteAuthorizedSufficient(String layerId)

Indicates whether features which only partly fall inside the deletable area are still considered deletable.

Parameters:

layerId - layer id for which the status needs to be checked

Returns:

true when any feature which intersects the deletable area is considered deletable, false when a feature needs to be inside the deletable area to be considered deletable.