org.seedstack.seed.security

Interface Scope

All Superinterfaces:

Serializable

All Known Implementing Classes:

SimpleScope

public interface Scope
extends Serializable

A scope is an additional verification to be made on a permission. When verifying a permission, we verify if the scope given to the user includes the scope to verify. As an example, one could consider hierarchical scopes where EU includes EU/France. If the user has the scope EU on a permission and we verify a permission valid in EU/France, it will be granted. On the contrary if the user has the scope US and we verify a permission valid in EU/France is will not be granted. Often there is no need for hierarchical scopes and the provided SimpleScope can be used directly. Simple scopes are not hierarchical and are just checked with strict equality.

Method Summary

Modifier and Type	Method and Description
String	getName() Return the name of the scope.
String	getValue() Returns the value of the scope represented as a string.
boolean	includes(Scope scope) Verifies if the current scope includes the given scope.

Method Detail

getName

String getName()

Return the name of the scope.

Returns:

the name of the scope.

getValue

String getValue()

Returns the value of the scope represented as a string.

Returns:

a string representation of the scope.

includes

boolean includes(Scope scope)

Verifies if the current scope includes the given scope.

Parameters:

scope - the scope to check

Returns:

whether this includes the given scope