sirius.web.security

Class Permissions

java.lang.Object

sirius.web.security.Permissions

public class Permissions
extends Object

Helper class to parse permission based annotations and the expand permission profiles.

Can be used to parse all present Permission and NotPermission annotations for a given element.

Can also be used to expand a permission profile defined in security.profiles into an effective list of permissions.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,Set<String>>	profilesCache
protected static List<String>	publicRoles

Method Summary

Modifier and Type	Method and Description
static Set<String>	applyProfiles(Collection<String> roles) Expands all permission profiles to obtain the effective set of permissions for a given list or permission and profile names.
static Set<String>	applyProfilesAndPublicRoles(Collection<String> roles) Expands all permission profiles just like applyProfiles(java.util.Collection).
static Set<String>	computePermissionsFromAnnotations(AnnotatedElement object) Parses all available permission annotations for the given element.
static boolean	wearsPermissionAnnotation(AnnotatedElement object) Determines if the given element wears a permission annotation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

profilesCache

protected static Map<String,Set<String>> profilesCache

publicRoles

protected static List<String> publicRoles

Method Detail

applyProfiles

public static Set<String> applyProfiles(Collection<String> roles)

Expands all permission profiles to obtain the effective set of permissions for a given list or permission and profile names.

Parameters:

roles - the list of permissions and or profiles to expand

Returns:

an effective list of permissions based on the profiles defined in security.profiles

applyProfilesAndPublicRoles

public static Set<String> applyProfilesAndPublicRoles(Collection<String> roles)

Expands all permission profiles just like applyProfiles(java.util.Collection). Also all public roles defined in security.publicRoles are included to the roles set before profiles are expanded.

Parameters:

roles - the list of permissions and or profiles to expand

Returns:

an effective list of permissions based on the profiles defined in security.profiles and the public roles defined in security.publicRoles

computePermissionsFromAnnotations

public static Set<String> computePermissionsFromAnnotations(AnnotatedElement object)

Parses all available permission annotations for the given element.

Parameters:

object - the element for check for permissions

Returns:

a set of permissions required to execute the annotated element

wearsPermissionAnnotation

public static boolean wearsPermissionAnnotation(AnnotatedElement object)

Determines if the given element wears a permission annotation.

Parameters:

object - the java element to check

Returns:

true if there is a permission annotation, false otherwise

See Also:

Permission, PermissionList, NotPermission, NotPermissionList, LoginRequired