org.gatein.api.security

Class Membership

java.lang.Object

org.gatein.api.security.Membership

All Implemented Interfaces:

Serializable

public class Membership
extends Object
implements Serializable

Represents a membership in a group

Author:

Nick Scavelli

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY

Constructor Summary

Constructors

Constructor and Description
Membership(String membershipType, Group group) Creates a new membership for users with the specified membership type in the specified group
Membership(User user) Creates a new membership for the specified user

Method Summary

Methods

Modifier and Type	Method and Description
static Membership	any(String... group) Creates a new membership for any membership type in the specified group
static Membership	fromString(String membership)
Group	getGroup() Returns the group
String	getMembershipType() Returns the membership type
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final String ANY

See Also:

Constant Field Values

Constructor Detail

Membership

public Membership(String membershipType,
          Group group)

Creates a new membership for users with the specified membership type in the specified group

Parameters:

membershipType - the membership type

group - the group

Membership

public Membership(User user)

Creates a new membership for the specified user

Parameters:

user - the user

Method Detail

any

public static Membership any(String... group)

Creates a new membership for any membership type in the specified group

Parameters:

group - the group

Returns:

the membership

getMembershipType

public String getMembershipType()

Returns the membership type

Returns:

the membership type

getGroup

public Group getGroup()

Returns the group

Returns:

the group

toString

public String toString()

Overrides:

toString in class Object

fromString

public static Membership fromString(String membership)