org.pageseeder.bridge.control

Class MembershipManager

java.lang.Object

org.pageseeder.bridge.control.MembershipManager

public final class MembershipManager
extends Object

A manager for memberships (based on PageSeeder MemberForGroups and Details).

Since:

0.2.0

Version:

0.2.32

Author:

Christophe Lauret

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MembershipManager.MembershipResult The results of creating a membership operation.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MembershipManager(PSSession session) Creates a new manager for membership using the specified session.

Method Summary

Methods

Modifier and Type	Method and Description
MembershipManager.MembershipResult	add(PSMembership membership, boolean email) Add a member to a group directly (Admin only).
MembershipManager.MembershipResult	add(PSMembership membership, MemberOptions options) Add a member to a group directly (Admin only).
MembershipManager.MembershipResult	create(PSMembership membership) Creates the specified membership in PageSeeder.
MembershipManager.MembershipResult	create(PSMembership membership, String password) Creates the specified membership in PageSeeder.
MembershipManager.MembershipResult	create(PSMembership membership, String password, MemberOptions options) Creates the specified membership in PageSeeder.
List<PSMembership>	find(PSMembership membership, boolean isManager) Returns the list of memberships for specific group matching the values of the specified membership instance.
PSMembership	get(PSGroup group, PSMember member) Returns the membership information for the given group and member.
PSMembership	get(String group, String member) Returns the membership information for the given group and member.
PSMembership	getAuto(String group, String emailOrUsername, boolean isManager) Returns the membership information for the given group and email or username of member.
static PSEntityCache<PSMembership>	getCache()
MembershipManager.MembershipResult	invite(PSMembership membership) Invite a member to the group.
MembershipManager.MembershipResult	invite(PSMembership membership, boolean email) Invite a member to the group.
MembershipManager.MembershipResult	invite(PSMembership membership, MemberOptions options) Create a membership by inviting the member to the group.
MembershipManager.MembershipResult	inviteSelf(PSMembership membership) Create a membership by letting the member inviting herself to the group.
MembershipManager.MembershipResult	inviteSelf(PSMembership membership, boolean email) Create a membership by letting the member inviting herself to the group.
List<PSMembership>	listForGroup(PSGroup group) Returns the list of memberships for specific group.
List<PSMembership>	listForGroup(PSGroup group, boolean includeSubgroups) Returns the list of memberships for specific group.
List<PSMembership>	listForMember(PSMember member)
List<PSMembership>	listForMember(String username) Returns the list of membership for specific user.
MembershipManager.MembershipResult	register(PSMembership membership) Creates the specified membership in PageSeeder.
void	remove(String group, String member) Remove the specified member from the group.
MembershipManager.MembershipResult	save(PSMembership membership) Saves the specified membership in PageSeeder.
MembershipManager.MembershipResult	save(PSMembership membership, boolean forceEmail) Saves the specified membership in PageSeeder.
PSSession	session()
void	updatePassword(PSMembership membership, String password) Updates the password of the member.

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

MembershipManager

public MembershipManager(PSSession session)

Creates a new manager for membership using the specified session.

Parameters:

session - The session used to connect to PageSeeder.

Method Detail

create

public MembershipManager.MembershipResult create(PSMembership membership)
                                          throws APIException

Creates the specified membership in PageSeeder.

Parameters:

membership - The Membership to create.

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

create

public MembershipManager.MembershipResult create(PSMembership membership,
                                        String password)
                                          throws APIException

Creates the specified membership in PageSeeder.

Parameters:

membership - The Membership to create.

password - The password for the user (must be strong enough)

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

create

public MembershipManager.MembershipResult create(PSMembership membership,
                                        String password,
                                        MemberOptions options)
                                          throws APIException

Creates the specified membership in PageSeeder.

Parameters:

membership - The Membership to create.

password - The password for the user (must be strong enough)

options - The member options

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

add

public MembershipManager.MembershipResult add(PSMembership membership,
                                     boolean email)
                                       throws APIException

Add a member to a group directly (Admin only).

Parameters:

membership - The membership to create.

email - true to send a welcome email; false to silently add the member.

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

add

public MembershipManager.MembershipResult add(PSMembership membership,
                                     MemberOptions options)
                                       throws APIException

Add a member to a group directly (Admin only).

Parameters:

membership - The membership to create.

options - The MemberOptions

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

invite

public MembershipManager.MembershipResult invite(PSMembership membership)
                                          throws APIException

Invite a member to the group.

This method will use the default options by sending a welcome email and an invitation based on the group properties.

Parameters:

membership - The membership to create.

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

invite

public MembershipManager.MembershipResult invite(PSMembership membership,
                                        boolean email)
                                          throws APIException

Invite a member to the group.

Parameters:

membership - The membership to create.

email - true to send a welcome email; false to silently add the member.

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

invite

public MembershipManager.MembershipResult invite(PSMembership membership,
                                        MemberOptions options)
                                          throws APIException

Create a membership by inviting the member to the group.

Only the invitation and sendWelcomeEmail are considered.

Parameters:

membership - The membership to create.

options - The member options.

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

inviteSelf

public MembershipManager.MembershipResult inviteSelf(PSMembership membership)
                                              throws APIException

Create a membership by letting the member inviting herself to the group.

A welcome email will be sent to the user.

Parameters:

membership - The membership to create.

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

inviteSelf

public MembershipManager.MembershipResult inviteSelf(PSMembership membership,
                                            boolean email)
                                              throws APIException

Create a membership by letting the member inviting herself to the group. To work the group owner must be the same as another group the member

Parameters:

membership - The membership to create.

email - true to send the welcome email; false otherwise (the member is added silently)

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

register

public MembershipManager.MembershipResult register(PSMembership membership)
                                            throws APIException

Creates the specified membership in PageSeeder.

Parameters:

membership - The Membership to create.

Returns:

The result of the membership creation as an enumeration value.

Throws:

APIException - if the operation is not successful or caused by client.

get

public PSMembership get(String group,
               String member)
                 throws APIException

Returns the membership information for the given group and member.

Parameters:

group - The name of the group.

member - The username of the member.

Returns:

The corresponding membership if it exists or null if the member does not belong to the group

Throws:

APIException

getAuto

public PSMembership getAuto(String group,
                   String emailOrUsername,
                   boolean isManager)
                     throws APIException

Returns the membership information for the given group and email or username of member.

Parameters:

group - The name of the group.

emailOrUsername - The username or email of the member.

isManager - true to indicate that the user is a manager.

Returns:

The corresponding membership if it exists or null if the member does not belong to the group

Throws:

APIException

get

public PSMembership get(PSGroup group,
               PSMember member)
                 throws APIException

Returns the membership information for the given group and member.

Parameters:

group - The group instance.

member - The member instance.

Returns:

The corresponding membership if it exists or null if the member does not belong to the group

Throws:

APIException

remove

public void remove(String group,
          String member)
            throws APIException

Remove the specified member from the group.

Parameters:

group - The group the member is to be removed from

member - The username of the member

Throws:

APIException

save

public MembershipManager.MembershipResult save(PSMembership membership)
                                        throws APIException

Saves the specified membership in PageSeeder.

Parameters:

membership - The Membership to create.

Throws:

APIException

save

public MembershipManager.MembershipResult save(PSMembership membership,
                                      boolean forceEmail)
                                        throws APIException

Saves the specified membership in PageSeeder.

Parameters:

membership - The Membership to create.

forceEmail - A boolean to force email change

Throws:

APIException

updatePassword

public void updatePassword(PSMembership membership,
                  String password)
                    throws APIException

Updates the password of the member.

Throws:

APIException

listForMember

public List<PSMembership> listForMember(PSMember member)
                                 throws APIException

Returns:

the list of memberships for the specified member.

Throws:

APIException

listForMember

public List<PSMembership> listForMember(String username)
                                 throws APIException

Returns the list of membership for specific user.

Parameters:

username - the member username

Throws:

APIException

listForGroup

public List<PSMembership> listForGroup(PSGroup group)
                                throws APIException

Returns the list of memberships for specific group.

Parameters:

group - the name of the group.

Returns:

the list of memberships.

Throws:

APIException

listForGroup

public List<PSMembership> listForGroup(PSGroup group,
                              boolean includeSubgroups)
                                throws APIException

Returns the list of memberships for specific group.

Parameters:

group - the name of the group.

includeSubgroups - if members from subgroups should be included

Returns:

the list of memberships.

Throws:

APIException

find

public List<PSMembership> find(PSMembership membership,
                      boolean isManager)
                        throws APIException

Returns the list of memberships for specific group matching the values of the specified membership instance.

Parameters:

membership - search predicate.

isManager - true to indicate that the user is a manager.

Returns:

the list of memberships.

Throws:

APIException

getCache

public static PSEntityCache<PSMembership> getCache()

Returns:

the internal cache for memberships.

session

public PSSession session()

Returns:

the session used by the class.