org.jahia.services.usermanager

Class JahiaGroup

java.lang.Object

org.jahia.services.usermanager.JahiaGroup

All Implemented Interfaces:

Serializable, Group, Principal, JahiaPrincipal

Direct Known Subclasses:

JahiaGroupImpl

public abstract class JahiaGroup
extends Object
implements JahiaPrincipal, Group

This class represents a group of Principals which can be users or groups. A group can have subgroups holding again users or subgroups.

Each group is defined with a name, which is unique inside a site, but not necessarily unique between two sites. Each group has also a unique identification key, which is unique in the database. This way, a group is uniquely identified in all the sites and Jahia servers sharing the same database.

The group names are used only to present an intuitive signification for the administrators of each site. As the key is the only way to assure unicity between the sites and servers, it will be used to represent the group inside of jahia and not the group name.

Version:

2.2

Author:

Fulco Houkes

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hidden
protected Map<String,Boolean>	membership
protected String	mGroupKey Group global identification key, unique in all the sites and Jahia servers sharing the same groups data source.
protected String	mGroupname Group unique identification name
protected Set<Principal>	mMembers Map holding all the group members.
protected int	mSiteID The site id
protected boolean	preloadedGroups

Constructor Summary

Constructors

Constructor and Description
JahiaGroup()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addMember(Principal principal) Deprecated.
abstract void	addMembers(Collection<Principal> principals) Deprecated.
boolean	equals(Object another) Compares this principal to the specified object.
String	getGroupKey() Return the group key.
String	getGroupname() Returns the name of this group.
Collection<Principal>	getMembers() Deprecated.
protected abstract Set<Principal>	getMembersMap() Deprecated.
String	getName() Returns the unique identifier of this principal object.
abstract Properties	getProperties() Get grp's properties list.
abstract String	getProperty(String key) Retrieve the requested grp property.
abstract String	getProviderName() Deprecated.
Set<Principal>	getRecursiveUserMembers() Deprecated.
int	getSiteID() Deprecated. use siteKey instead
abstract int	hashCode() Returns a hashcode for this principal.
boolean	isHidden()
boolean	isMember(Principal principal) Deprecated.
boolean	isPreloadedGroups()
Enumeration<Principal>	members() Deprecated. use getMembers
abstract boolean	removeMember(Principal principal) Deprecated.
boolean	removeMembers() Deprecated.
abstract boolean	removeProperty(String key) Deprecated.
void	setHidden(boolean hidden)
abstract boolean	setProperty(String key, String value) Deprecated.
abstract String	toString() Returns a string representation of this group.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jahia.services.usermanager.JahiaPrincipal

getLocalPath

Methods inherited from interface java.security.Principal

implies

Field Detail

mGroupname

protected String mGroupname

Group unique identification name

mGroupKey

protected String mGroupKey

Group global identification key, unique in all the sites and Jahia servers sharing the same groups data source.

hidden

protected boolean hidden

mSiteID

protected int mSiteID

The site id

preloadedGroups

protected boolean preloadedGroups

membership

protected Map<String,Boolean> membership

mMembers

protected Set<Principal> mMembers

Map holding all the group members.

Constructor Detail

JahiaGroup

public JahiaGroup()

Method Detail

getProperties

public abstract Properties getProperties()

Get grp's properties list.

Returns:

Return a reference on the grp's properties list, or null if no property is present.

getProperty

public abstract String getProperty(String key)

Retrieve the requested grp property.

Parameters:

key - Property's name.

Returns:

Return the property's value of the specified key, or null if the property does not exist.

removeProperty

public abstract boolean removeProperty(String key)

Deprecated.

Remove the specified property from the properties list.

Parameters:

key - Property's name.

setProperty

public abstract boolean setProperty(String key,
                                    String value)

Deprecated.

Add (or update if not already in the property list) a property key-value pair in the grp's properties list.

Parameters:

key - Property's name.

value - Property's value.

addMember

public abstract boolean addMember(Principal principal)

Deprecated.

Adds the specified member to the group.

Specified by:

addMember in interface Group

Parameters:

principal - The principal to add to this group.

Returns:

Return true if the member was successfully added, false if the principal was already a member.

addMembers

public abstract void addMembers(Collection<Principal> principals)

Deprecated.

Adds the specified members to the group.

Parameters:

principals - The principals to add to this group.

equals

public boolean equals(Object another)

Compares this principal to the specified object. Returns true if the object passed in matches the principal represented by the implementation of this interface.

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Parameters:

another - Principal to compare with.

Returns:

Return true if the principal passed in is the same as that encapsulated by this principal, and false otherwise.

getGroupKey

public String getGroupKey()

Return the group key.

Returns:

REturn the unique group identification key.

getName

public String getName()

Returns the unique identifier of this principal object.

Specified by:

getName in interface Principal

Returns:

The unique identifier of this group.

getGroupname

public String getGroupname()

Returns the name of this group.

Returns:

The name of this group.

getSiteID

public int getSiteID()

Deprecated. use siteKey instead

Returns the site id.

Returns:

int the siteID.

hashCode

public abstract int hashCode()

Returns a hashcode for this principal.

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

Returns:

A hashcode for this principal.

isMember

public boolean isMember(Principal principal)

Deprecated.

Returns true if the passed principal is a member of the group. This method does a recursive search, so if a principal belongs to a group which is a member of this group, true is returned. Note this method does not load automatically all members of the group if they were not preloaded before.

Specified by:

isMember in interface Group

Parameters:

principal - The principal whose membership is to be checked.

Returns:

Return true if the principal is a member of this group, false otherwise.

members

public Enumeration<Principal> members()

Deprecated. use getMembers

Returns an Iterator of the members in the group. The returned objects can be instances of either Principal or Group.

Note that the Group is an instantiation of the Principal class.

Specified by:

members in interface Group

Returns:

An Iterator of the group members.

getMembers

public Collection<Principal> getMembers()

Deprecated.

getMembersMap

protected abstract Set<Principal> getMembersMap()

Deprecated.

Returns members of this group. If members were not loaded before, forces loading.

Returns:

members of this group

getRecursiveUserMembers

public Set<Principal> getRecursiveUserMembers()

Deprecated.

This method returns ONLY a list of users. All sub groups are expanded to return only the full list of members.

Returns:

Set a set of JahiaUsers that are all the implicit and explicit users in this group

removeMember

public abstract boolean removeMember(Principal principal)

Deprecated.

Removes the specified member from the group.

Specified by:

removeMember in interface Group

Parameters:

principal - The principal to remove from this group.

Returns:

Return true if the principal was removed, or false if the principal was not a member.

removeMembers

public boolean removeMembers()

Deprecated.

Removes all members from the group.

Returns:

Return false on error

toString

public abstract String toString()

Returns a string representation of this group.

Specified by:

toString in interface Principal

Overrides:

toString in class Object

Returns:

A string representation of this group.

getProviderName

public abstract String getProviderName()

Deprecated.

Get the name of the provider of this group.

Specified by:

getProviderName in interface JahiaPrincipal

Returns:

String representation of the name of the provider of this group

isPreloadedGroups

public boolean isPreloadedGroups()

isHidden

public boolean isHidden()

setHidden

public void setHidden(boolean hidden)