Package org.ametys.plugins.core.group

Class GroupHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.group.GroupHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class GroupHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper class for groups, for common operations on Group

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
GroupHelper()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	group2JSON(Group group, boolean users)	Get group as JSON object
List<Map<String,Object>>	groups2JSON(List<Group> groups, boolean users)	Get groups as JSON object
void	saxGroup(Group group, ContentHandler handler)	Sax a Group
void	saxGroup(Group group, ContentHandler handler, String tagName)	Sax a Group
void	saxGroup(Group group, ContentHandler handler, String tagName, boolean withUsers)	Sax a Group
void	saxGroupIdentity(GroupIdentity groupIdentity, ContentHandler handler)	Sax a Group identity
void	saxGroupIdentity(GroupIdentity groupIdentity, ContentHandler handler, String tagName)	Sax a Group identity
void	saxGroupIdentity(GroupIdentity groupIdentity, ContentHandler handler, String tagName, boolean withUsers)	Sax a Group identity
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

Constructor Detail

GroupHelper

public GroupHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

saxGroupIdentity

public void saxGroupIdentity(GroupIdentity groupIdentity,
                             ContentHandler handler)
                      throws SAXException

Sax a Group identity

Parameters:

groupIdentity - the group identity to sax

handler - the content handler

Throws:

SAXException - If a SAX error occurs

saxGroupIdentity

public void saxGroupIdentity(GroupIdentity groupIdentity,
                             ContentHandler handler,
                             String tagName)
                      throws SAXException

Sax a Group identity

Parameters:

groupIdentity - the group identity to sax

handler - the content handler

tagName - the XML tag for saxed group

Throws:

SAXException - If a SAX error occurs

saxGroupIdentity

public void saxGroupIdentity(GroupIdentity groupIdentity,
                             ContentHandler handler,
                             String tagName,
                             boolean withUsers)
                      throws SAXException

Sax a Group identity

Parameters:

groupIdentity - the group identity to sax

handler - the content handler

tagName - the XML tag for saxed group

withUsers - if true, users of the group will be saxed with the group

Throws:

SAXException - If a SAX error occurs

saxGroup

public void saxGroup(Group group,
                     ContentHandler handler)
              throws SAXException

Sax a Group

Parameters:

group - the group to sax

handler - the content handler

Throws:

SAXException - If a SAX error occurs

saxGroup

public void saxGroup(Group group,
                     ContentHandler handler,
                     String tagName)
              throws SAXException

Sax a Group

Parameters:

group - the group to sax

handler - the content handler

tagName - the XML tag for saxed group

Throws:

SAXException - If a SAX error occurs

saxGroup

public void saxGroup(Group group,
                     ContentHandler handler,
                     String tagName,
                     boolean withUsers)
              throws SAXException

Sax a Group

Parameters:

group - the group to sax

handler - the content handler

tagName - the XML tag for saxed group

withUsers - if true, users of the group will be saxed with the group

Throws:

SAXException - If a SAX error occurs

group2JSON

public Map<String,Object> group2JSON(Group group,
                                           boolean users)

Get group as JSON object

Parameters:

group - the group

users - true to get users' group

Returns:

the group as JSON object

groups2JSON

public List<Map<String,Object>> groups2JSON(List<Group> groups,
                                                  boolean users)

Get groups as JSON object

Parameters:

groups - the groups

users - true to get users' group

Returns:

the group as JSON object