org.pageseeder.bridge.control

Class GroupManager

java.lang.Object

org.pageseeder.bridge.control.GroupManager

public final class GroupManager
extends Object

A manager for groups, projects and group folders.

Since:

0.2.0

Version:

0.3.3

Author:

Christophe Lauret

Field Summary

Fields

Modifier and Type	Field and Description
protected PSSession	_session The user connecting to the server.

Constructor Summary

Constructors

Constructor and Description
GroupManager(PSSession session) Creates a new manager for PageSeeder groups.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSubGroup(PSGroup group, PSGroup subgroup) Adds a group as a subgroup of another.
void	addSubGroup(PSGroup group, PSGroup subgroup, PSNotification notification, PSRole role, boolean listed) Adds a group as a subgroup of another.
PSThreadStatus	archiveGroup(PSGroup group, PSMember editor) Archives the specified group in PageSeeder.
void	createGroup(PSGroup group, PSMember creator) Creates the specified group in PageSeeder using default PageSeeder options.
void	createGroup(PSGroup group, PSMember creator, GroupOptions options) Creates the specified group in PageSeeder.
void	createGroupFolder(PSGroup group, String url) Creates the group folder.
void	createGroupFolder(PSGroup group, String url, boolean isPublic) Deprecated. Use createGroupFolder(PSGroup, String) instead
void	createPersonalGroup(PSMember member) Creates a personal group for specified member.
void	createProject(PSProject project, PSMember creator) Creates the specified project in PageSeeder.
void	createProject(PSProject project, PSMember creator, GroupOptions options) Creates the specified project in PageSeeder.
void	deleteSubGroup(PSGroup group, PSGroup subgroup) Removes a subgroup from another group.
void	editGroup(PSGroup group, PSMember editor) Edit the specified group in PageSeeder (name not included, use renameGroup(PSGroup, PSMember, String) to rename a group).
void	editGroup(PSGroup group, PSMember editor, GroupOptions options) Edit the specified group in PageSeeder (name not included, use renameGroup(PSGroup, PSMember, String) to rename a group).
List<PSGroup>	findGroups(PSMember member, String prefix, boolean includeAll) Returns the list of projects and groups (max 1000) for the given member.
List<PSGroup>	findGroups(PSMember member, String prefix, int max, boolean includeAll) Returns the list of projects and groups for the given member.
PSGroup	get(String name) Returns the group for the specified name.
static PSEntityCache<PSGroup>	getCache() Returns the internal cache used for the groups.
static PSEntityCache<PSGroupFolder>	getFoldersCache() Returns the internal cache used for group folders.
PSGroupFolder	getGroupFolder(PSGroup group, String url) Returns the group folder for the specified URL.
static String	getHostURL() Deprecated. Use PSConfig.getDefault().getHostURL();
PSProject	getProject(String name) Returns the project for the specified name.
void	groupIsArchived(PSGroup group) Should be called when the archive group thread is completed, to update the local cache
void	groupIsRenamed(PSGroup group) Should be called when the rename group thread is completed, to update the local cache
List<PSGroup>	listProjectTree(PSMember member, String nameprefix, int max) Returns the list of projects and groups for the given member.
List<PSGroup>	listProjectTree(PSMember member, String nameprefix, int max, boolean showGroup, boolean showAll) Returns the list of projects and groups for the given member.
List<PSGroup>	listSubGroups(PSGroup group) Returns the list of subgroups for the specified group.
void	putResource(PSProject project, PSResource resource, boolean overwrite) Put a resource on the project.
PSThreadStatus	renameGroup(PSGroup group, PSMember editor, String newname) Renames the specified group in PageSeeder.
PSSession	session()

Methods inherited from class java.lang.Object

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

Field Detail

_session

protected final PSSession _session

The user connecting to the server.

Constructor Detail

GroupManager

public GroupManager(PSSession session)

Creates a new manager for PageSeeder groups.

Parameters:

session - A valid session to connect to PageSeeder.

Method Detail

createGroup

public void createGroup(PSGroup group,
               PSMember creator)
                 throws FailedPrecondition,
                        APIException

Creates the specified group in PageSeeder using default PageSeeder options.

The member creating the group will automatically be made a member of the group.

Parameters:

group - The group to create

creator - The member creating the request

Throws:

FailedPrecondition - Should a precondition fail to create a group

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If either the group or member is null.

createGroup

public void createGroup(PSGroup group,
               PSMember creator,
               GroupOptions options)
                 throws FailedPrecondition,
                        APIException

Creates the specified group in PageSeeder.

The optional group options parameters can be used to specify additional option to create the group or set some group properties.

Parameters:

group - The group to create

creator - The member making the request

options - The group creation options (including group properties)

Throws:

FailedPrecondition - Should a precondition fail to create a group

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If either the group or member is null.

createProject

public void createProject(PSProject project,
                 PSMember creator)
                   throws FailedPrecondition,
                          APIException

Creates the specified project in PageSeeder.

Parameters:

project - The project to create

creator - The member making the request

Throws:

FailedPrecondition - Should a precondition fail to create a project

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If either the project or member is null.

createProject

public void createProject(PSProject project,
                 PSMember creator,
                 GroupOptions options)
                   throws FailedPrecondition,
                          APIException

Creates the specified project in PageSeeder.

The optional project options parameters can be used to specify additional option to create the project or set some group properties.

Parameters:

project - The project to create

creator - The member making the request

options - The group creation options (including group properties)

Throws:

FailedPrecondition - Should a precondition fail to create a project

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If either the project or member is null.

createGroupFolder

public void createGroupFolder(PSGroup group,
                     String url,
                     boolean isPublic)
                       throws InvalidEntityException,
                              APIException

Deprecated. Use createGroupFolder(PSGroup, String) instead

Returns the connector to create a group folder.

Parameters:

group - The group where the group folder should be created.

url - The URL of the group folder.

isPublic - true for a public group folder.

Throws:

InvalidEntityException - If the group is invalid.

APIException - If an error occurs while communicating with PageSeeder.

createGroupFolder

public void createGroupFolder(PSGroup group,
                     String url)
                       throws InvalidEntityException,
                              APIException

Creates the group folder.

Parameters:

group - The group where the group folder should be created.

url - The url of the group folder.

Throws:

InvalidEntityException - If the group is invalid.

APIException - If an error occurs while communicating with PageSeeder.

createPersonalGroup

public void createPersonalGroup(PSMember member)
                         throws APIException

Creates a personal group for specified member.

Parameters:

member - The member needs to create a personal group.

Throws:

APIException - If an error occurs while communicating with PageSeeder.

renameGroup

public PSThreadStatus renameGroup(PSGroup group,
                         PSMember editor,
                         String newname)
                           throws FailedPrecondition,
                                  APIException

Renames the specified group in PageSeeder.

Renaming a group is an asynchronous operation on PageSeeder so this method returns a PSThreadStatus object.

The groupIsRenamed(PSGroup) must be called when the thread is completed successfully.

Parameters:

group - The group to rename

editor - The member making the request

newname - The new group name

Throws:

FailedPrecondition - Should a precondition fail

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If the group, editor or newname is null.

groupIsRenamed

public void groupIsRenamed(PSGroup group)

Should be called when the rename group thread is completed, to update the local cache

Parameters:

group - the group that was renamed

Throws:

NullPointerException - If the group is null.

archiveGroup

public PSThreadStatus archiveGroup(PSGroup group,
                          PSMember editor)
                            throws FailedPrecondition,
                                   APIException

Archives the specified group in PageSeeder.

Archiving a group is an asynchronous operation on PageSeeder so this method returns a PSThreadStatus object.

The groupIsArchived(PSGroup) must be called when the thread is completed successfully.

Parameters:

group - The group to archive

editor - The member making the request

Throws:

FailedPrecondition - Should a precondition fail

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If the group or editor is null.

groupIsArchived

public void groupIsArchived(PSGroup group)

Should be called when the archive group thread is completed, to update the local cache

Parameters:

group - the group that was archived

Throws:

NullPointerException - If the group is null.

editGroup

public void editGroup(PSGroup group,
             PSMember editor)
               throws FailedPrecondition,
                      APIException

Edit the specified group in PageSeeder (name not included, use renameGroup(PSGroup, PSMember, String) to rename a group).

Parameters:

group - The group to edit

editor - The member making the request

Throws:

FailedPrecondition - Should a precondition fail to edit the group

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If the group or editor is null.

editGroup

public void editGroup(PSGroup group,
             PSMember editor,
             GroupOptions options)
               throws FailedPrecondition,
                      APIException

Edit the specified group in PageSeeder (name not included, use renameGroup(PSGroup, PSMember, String) to rename a group).

The optional group options parameters can be used to specify additional options to edit the group or set some group properties.

Parameters:

group - The group to edit

editor - The member making the request

options - The group creation options (including group properties)

Throws:

FailedPrecondition - Should a precondition fail to edit the group

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If the group or editor is null.

get

public PSGroup get(String name)
            throws APIException

Returns the group for the specified name.

Parameters:

name - The name of the group.

Returns:

The corresponding instance.

Throws:

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If either the name of the group is null.

getProject

public PSProject getProject(String name)
                     throws APIException

Returns the project for the specified name.

Parameters:

name - The name of the project.

Returns:

The corresponding instance or null.

Throws:

APIException - If an error occurs while communicating with PageSeeder.

NullPointerException - If either the name of the group is null.

getGroupFolder

public PSGroupFolder getGroupFolder(PSGroup group,
                           String url)
                             throws APIException

Returns the group folder for the specified URL.

Parameters:

group - The group the group folder belongs to

url - The URL of the group folder

Returns:

The corresponding instance or null.

Throws:

APIException

addSubGroup

public void addSubGroup(PSGroup group,
               PSGroup subgroup)
                 throws APIException

Adds a group as a subgroup of another.

Parameters:

group - The group accepting the subgroup.

subgroup - The subgroup to add to the group.

Throws:

APIException

addSubGroup

public void addSubGroup(PSGroup group,
               PSGroup subgroup,
               PSNotification notification,
               PSRole role,
               boolean listed)
                 throws APIException

Adds a group as a subgroup of another.

Parameters:

group - The group accepting the subgroup.

subgroup - The subgroup to add to the group.

notification - The notification options for users added via the subgroup.

role - The role for users added via the subgroup.

listed - Whether users added via the subgroup should have their email address listed.

Throws:

APIException

deleteSubGroup

public void deleteSubGroup(PSGroup group,
                  PSGroup subgroup)
                    throws APIException

Removes a subgroup from another group.

Parameters:

group - The "parent" group.

subgroup - The subgroup to remove.

Throws:

APIException

listSubGroups

public List<PSGroup> listSubGroups(PSGroup group)
                            throws APIException

Returns the list of subgroups for the specified group.

Parameters:

group - The group.

Throws:

APIException

listProjectTree

public List<PSGroup> listProjectTree(PSMember member,
                            String nameprefix,
                            int max)
                              throws APIException

Returns the list of projects and groups for the given member. This is less efficient than findGroups methods.

Parameters:

member - The member making the request.

nameprefix - the prefix of project/group.

max - the maximum number of projects/groups to return (may be more results as ancestors are added).

Returns:

the list of projects and groups for the given member.

Throws:

APIException

listProjectTree

public List<PSGroup> listProjectTree(PSMember member,
                            String nameprefix,
                            int max,
                            boolean showGroup,
                            boolean showAll)
                              throws APIException

Returns the list of projects and groups for the given member. This is less efficient than findGroups methods.

Parameters:

member - The member making the request.

nameprefix - the prefix of project/group.

max - the maximum number of projects/groups to return (may be more results as ancestors are added).

showGroup - whether to return groups

showAll - Whether to return all projects/groups for server (Administrator only)

Returns:

the list of projects and groups for the given member.

Throws:

APIException

findGroups

public List<PSGroup> findGroups(PSMember member,
                       String prefix,
                       boolean includeAll)
                         throws APIException

Returns the list of projects and groups (max 1000) for the given member. This is more efficient than listProjectTree methods.

Parameters:

member - The member

prefix - The prefix of project/group name

includeAll - Whether to return all projects/groups for server (Administrator only)

Throws:

APIException

findGroups

public List<PSGroup> findGroups(PSMember member,
                       String prefix,
                       int max,
                       boolean includeAll)
                         throws APIException

Returns the list of projects and groups for the given member. This is more efficient than listProjectTree methods.

Parameters:

member - The member

prefix - The prefix of project/group name

max - The maximum number of projects/groups to return.

includeAll - Whether to return all projects/groups for server (Administrator only)

Throws:

APIException

putResource

public void putResource(PSProject project,
               PSResource resource,
               boolean overwrite)
                 throws FailedPrecondition,
                        APIException

Put a resource on the project.

Implementation note: this method only supports text resources, not binary resources.

Parameters:

project - The project the resource is associated with.

resource - The actual resource

overwrite - true to overwrite the resource; false otherwise.

Throws:

FailedPrecondition - If the location is empty; or the project is not identifiable; or the content is binary; or the content is empty.

APIException - For any other error communicating with PageSeeder.

getCache

public static PSEntityCache<PSGroup> getCache()

Returns the internal cache used for the groups.

Returns:

the internal cache used for the groups.

getFoldersCache

public static PSEntityCache<PSGroupFolder> getFoldersCache()

Returns the internal cache used for group folders.

Returns:

the internal cache used for group folders

getHostURL

@Deprecated
public static String getHostURL()

Deprecated. Use PSConfig.getDefault().getHostURL();

Returns:

the host URL.

session

public PSSession session()

Returns:

the session used by the class.