org.gatein.api.security

Class Permission

java.lang.Object

org.gatein.api.security.Permission

All Implemented Interfaces:

Serializable

public class Permission
extends Object
implements Serializable

Represents the permissions for a resource

Author:

Nick Scavelli

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Permission() Creates a permission where everyone can access the resource (public)
Permission(Membership membership) Creates a permission where users with the specified membership can access the resource
Permission(Set<Membership> memberships) Creates a permission where users with one or more of the specified memberships can access the resource
Permission(String membershipType, Group group) Creates a permission where users with the specified member type in the specified group can access the resource
Permission(User user) Creates a permission where the the specified user can access the resource

Method Summary

Methods

Modifier and Type	Method and Description
Permission	addMembership(Membership membership) Creates a new permission that includes all memberships of this permission and the specified membership
static Permission	any(String... group) Returns a permission where users with any membership type in the specified group can access the resource
static Permission	everyone() Returns a permission where everyone can access the resource (public)
Set<Membership>	getMemberships() Returns all memberships with permissions to access the resource
boolean	isAccessibleToEveryone() Returns true if everyone has permissions to access the item
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Permission

public Permission()

Creates a permission where everyone can access the resource (public)

Permission

public Permission(String membershipType,
          Group group)

Creates a permission where users with the specified member type in the specified group can access the resource

Parameters:

membershipType - the membership type

group - the group

Permission

public Permission(User user)

Creates a permission where the the specified user can access the resource

Parameters:

user - the user

Permission

public Permission(Membership membership)

Creates a permission where users with the specified membership can access the resource

Parameters:

membership - the membership

Permission

public Permission(Set<Membership> memberships)

Creates a permission where users with one or more of the specified memberships can access the resource

Parameters:

memberships - the memberships

Method Detail

everyone

public static Permission everyone()

Returns a permission where everyone can access the resource (public)

Returns:

the permission

any

public static Permission any(String... group)

Returns a permission where users with any membership type in the specified group can access the resource

Parameters:

group - the group

Returns:

the permission

getMemberships

public Set<Membership> getMemberships()

Returns all memberships with permissions to access the resource

Returns:

the memberships

addMembership

public Permission addMembership(Membership membership)

Creates a new permission that includes all memberships of this permission and the specified membership

Parameters:

membership - the membership to add

Returns:

the new permission

isAccessibleToEveryone

public boolean isAccessibleToEveryone()

Returns true if everyone has permissions to access the item

Returns:

true if resource is public

toString

public String toString()

Overrides:

toString in class Object