org.jahia.services.usermanager

Class JahiaGroupImpl

java.lang.Object

org.jahia.services.usermanager.JahiaGroup

org.jahia.services.usermanager.JahiaGroupImpl

All Implemented Interfaces:

Serializable, Group, Principal, JahiaPrincipal

Direct Known Subclasses:

GuestGroup, UsersGroup

public class JahiaGroupImpl
extends JahiaGroup

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 String	name Group unique identification name
protected String	path Group global identification key, unique in all the sites and Jahia servers sharing the same groups data source.

Fields inherited from class org.jahia.services.usermanager.JahiaGroup

hidden, membership, mGroupKey, mGroupname, mMembers, mSiteID, preloadedGroups

Constructor Summary

Constructors

Constructor and Description
JahiaGroupImpl(String name, String path, String siteKey, Properties properties)

Method Summary

Modifier and Type	Method and Description
boolean	addMember(Principal user) Adds the specified member to the group.
void	addMembers(Collection<Principal> principals) Adds the specified members to the group.
boolean	equals(Object o) Compares this principal to the specified object.
String	getGroupKey() Return the group key.
String	getGroupname() Returns the name of this group.
String	getLocalPath() Get the path of this user in the local store.
protected Set<Principal>	getMembersMap() Returns members of this group.
String	getName() Returns the unique identifier of this principal object.
Properties	getProperties() Get grp's properties list.
String	getProperty(String key) Retrieve the requested grp property.
String	getProviderName() Get the providerName of this user.
String	getSiteKey()
int	hashCode() Returns a hashcode for this principal.
boolean	isMember(Principal principal) Returns true if the passed principal is a member of the group.
Enumeration<Principal>	members() Returns an Iterator of the members in the group.
boolean	removeMember(Principal user) Removes the specified member from the group.
boolean	removeProperty(String key) Remove the specified property from the properties list.
boolean	setProperty(String key, String value) Add (or update if not already in the property list) a property key-value pair in the grp's properties list.
String	toString() Returns a string representation of this group.

Methods inherited from class org.jahia.services.usermanager.JahiaGroup

getMembers, getRecursiveUserMembers, getSiteID, isHidden, isPreloadedGroups, removeMembers, setHidden

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Field Detail

name

protected String name

Group unique identification name

path

protected String path

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

Constructor Detail

JahiaGroupImpl

public JahiaGroupImpl(String name,
                      String path,
                      String siteKey,
                      Properties properties)

Method Detail

getProperties

public Properties getProperties()

Description copied from class: JahiaGroup

Get grp's properties list.

Specified by:

getProperties in class JahiaGroup

Returns:

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

getProperty

public String getProperty(String key)

Description copied from class: JahiaGroup

Retrieve the requested grp property.

Specified by:

getProperty in class JahiaGroup

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 boolean removeProperty(String key)

Description copied from class: JahiaGroup

Remove the specified property from the properties list.

Specified by:

removeProperty in class JahiaGroup

Parameters:

key - Property's name.

setProperty

public boolean setProperty(String key,
                           String value)

Description copied from class: JahiaGroup

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

Specified by:

setProperty in class JahiaGroup

Parameters:

key - Property's name.

value - Property's value.

addMembers

public void addMembers(Collection<Principal> principals)

Description copied from class: JahiaGroup

Adds the specified members to the group.

Specified by:

addMembers in class JahiaGroup

Parameters:

principals - The principals to add to this group.

getGroupKey

public String getGroupKey()

Return the group key.

Overrides:

getGroupKey in class JahiaGroup

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

Overrides:

getName in class JahiaGroup

Returns:

The unique identifier of this group.

getMembersMap

protected Set<Principal> getMembersMap()

Description copied from class: JahiaGroup

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

Specified by:

getMembersMap in class JahiaGroup

Returns:

members of this group

getGroupname

public String getGroupname()

Returns the name of this group.

Overrides:

getGroupname in class JahiaGroup

Returns:

The name of this group.

addMember

public boolean addMember(Principal user)

Adds the specified member to the group.

Specified by:

addMember in interface Group

Specified by:

addMember in class JahiaGroup

Parameters:

user - the principal to add to this group.

Returns:

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

removeMember

public boolean removeMember(Principal user)

Removes the specified member from the group.

Specified by:

removeMember in interface Group

Specified by:

removeMember in class JahiaGroup

Parameters:

user - the principal to remove from this group.

Returns:

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

isMember

public boolean isMember(Principal principal)

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

Overrides:

isMember in class JahiaGroup

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()

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

Overrides:

members in class JahiaGroup

Returns:

An Iterator of the group members.

toString

public String toString()

Returns a string representation of this group.

Specified by:

toString in interface Principal

Specified by:

toString in class JahiaGroup

Returns:

A string representation of this group.

getLocalPath

public String getLocalPath()

Get the path of this user in the local store. For examle for LDAP user this will return the path of the user in the JCR with all necessary encoding.

Returns:

String representation of the name of the provider of this user

getProviderName

public String getProviderName()

Get the providerName of this user.

Specified by:

getProviderName in interface JahiaPrincipal

Specified by:

getProviderName in class JahiaGroup

Returns:

String representation of the name of the provider of this user

getSiteKey

public String getSiteKey()

equals

public boolean equals(Object o)

Description copied from class: JahiaGroup

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 JahiaGroup

Parameters:

o - Principal to compare with.

Returns:

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

hashCode

public int hashCode()

Description copied from class: JahiaGroup

Returns a hashcode for this principal.

Specified by:

hashCode in interface Principal

Specified by:

hashCode in class JahiaGroup

Returns:

A hashcode for this principal.