org.nuxeo.ecm.social.workspace.service

Class SocialWorkspaceServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.social.workspace.service.SocialWorkspaceServiceImpl

All Implemented Interfaces:

SocialWorkspaceService, Adaptable, Component, Extensible

public class SocialWorkspaceServiceImpl
extends DefaultComponent
implements SocialWorkspaceService

Default implementation of SocialWorkspaceService service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURATION_EP
static String	NEWS_ITEMS_ROOT_ACL_NAME
static String	PUBLIC_SOCIAL_WORKSPACE_ACL_NAME
static String	SOCIAL_WORKSPACE_ACL_NAME
static String	SOCIAL_WORKSPACE_CONTAINER_EP

Constructor Summary

Constructors

Constructor and Description
SocialWorkspaceServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptSubscriptionRequest(SocialWorkspace socialWorkspace, SubscriptionRequest subscriptionRequest) Accepts the subscriptionRequest for socialWorkspace.
void	activate(ComponentContext context) Activates the component.
boolean	addSocialWorkspaceAdministrator(SocialWorkspace socialWorkspace, Principal principal) Adds a user to the socialWorkspace administrators group.
boolean	addSocialWorkspaceMember(SocialWorkspace socialWorkspace, Principal principal) Adds a user to the socialWorkspace members group.
List<String>	addSocialWorkspaceMembers(SocialWorkspace socialWorkspace, List<String> emails) Add several users to the socialWorkspace members group.
List<String>	addSocialWorkspaceMembers(SocialWorkspace socialWorkspace, String groupName) Add all group's users to the socialWorkspace members groups
void	deactivate(ComponentContext context) Deactivates the component.
List<SocialWorkspace>	getDetachedPublicSocialWorkspaces(CoreSession session) Return all public Social Workspaces.
SocialWorkspace	getDetachedSocialWorkspace(CoreSession session, DocumentRef docRef) Returns the SocialWorkspace container of the given document ref if it is in a Social Workspace even if the user does not have right on it, null otherwise.
SocialWorkspace	getDetachedSocialWorkspace(DocumentModel doc) Returns the SocialWorkspace container of the given document if it is in a Social Workspace even if the user does not have right on it, null otherwise.
SocialWorkspace	getSocialWorkspace(DocumentModel doc) Returns the SocialWorkspace container of the given document if it is part of a Social Workspace, null otherwise.
DocumentModel	getSocialWorkspaceContainer(CoreSession session) Returns Social Workspace Container and create it if needed.
SocialWorkspaceContainerDescriptor	getSocialWorkspaceContainerDescriptor() Returns the configured SocialWorkspaceContainerDescriptor that contains the path, title and description of the container.
int	getValidationDays() Gets the number of days before a social workspace expires without validation.
void	handleSocialWorkspaceCreation(SocialWorkspace socialWorkspace, Principal principal) Handles a Social Workspace creation: create related groups put specific ACLs
void	handleSocialWorkspaceDeletion(SocialWorkspace socialWorkspace) Handles a Social Workspace deletion: remove related groups
void	handleSubscriptionRequest(SocialWorkspace socialWorkspace, Principal principal) Handles a Subscription Request on socialWorkspace for the given principal.
boolean	isSubscriptionRequestPending(SocialWorkspace socialWorkspace, Principal principal) Returns true if there is a pending Subscription Request for the given principal, false otherwise.
void	makeSocialWorkspacePrivate(SocialWorkspace socialWorkspace) Makes the given socialWorkspace private.
void	makeSocialWorkspacePublic(SocialWorkspace socialWorkspace) Makes the given socialWorkspace public.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	rejectSubscriptionRequest(SocialWorkspace socialWorkspace, SubscriptionRequest subscriptionRequest) Rejects the subscriptionRequest for socialWorkspace.
void	removeSocialWorkspaceAdministrator(SocialWorkspace socialWorkspace, Principal principal) Removes a user from the @{code socialWorkspace} administrators group.
void	removeSocialWorkspaceMember(SocialWorkspace socialWorkspace, Principal principal) Removes a user from the @{code socialWorkspace} members group.
List<String>	searchAdministrators(SocialWorkspace socialWorkspace, String pattern) Returns all matching administrators from a Social Workspace, or an empty list.
List<SocialWorkspace>	searchDetachedPublicSocialWorkspaces(CoreSession session, String pattern) Return matching public social workspace according the given pattern.
List<String>	searchMembers(SocialWorkspace socialWorkspace, String pattern) Returns all matching members from a Social Workspace, or an empty list.
List<String>	searchUsers(SocialWorkspace socialWorkspace, RelationshipKind kind, String pattern) Returns all matching users from a Social Workspace, or an empty list.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, registerExtension, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_EP

public static final String CONFIGURATION_EP

See Also:

Constant Field Values

SOCIAL_WORKSPACE_CONTAINER_EP

public static final String SOCIAL_WORKSPACE_CONTAINER_EP

See Also:

Constant Field Values

SOCIAL_WORKSPACE_ACL_NAME

public static final String SOCIAL_WORKSPACE_ACL_NAME

See Also:

Constant Field Values

NEWS_ITEMS_ROOT_ACL_NAME

public static final String NEWS_ITEMS_ROOT_ACL_NAME

See Also:

Constant Field Values

PUBLIC_SOCIAL_WORKSPACE_ACL_NAME

public static final String PUBLIC_SOCIAL_WORKSPACE_ACL_NAME

See Also:

Constant Field Values

Constructor Detail

SocialWorkspaceServiceImpl

public SocialWorkspaceServiceImpl()

Method Detail

getDetachedPublicSocialWorkspaces

public List<SocialWorkspace> getDetachedPublicSocialWorkspaces(CoreSession session)

Description copied from interface: SocialWorkspaceService

Return all public Social Workspaces.

Specified by:

getDetachedPublicSocialWorkspaces in interface SocialWorkspaceService

searchDetachedPublicSocialWorkspaces

public List<SocialWorkspace> searchDetachedPublicSocialWorkspaces(CoreSession session,
                                                         String pattern)

Description copied from interface: SocialWorkspaceService

Return matching public social workspace according the given pattern.

Specified by:

searchDetachedPublicSocialWorkspaces in interface SocialWorkspaceService

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

getDetachedSocialWorkspace

public SocialWorkspace getDetachedSocialWorkspace(DocumentModel doc)

Description copied from interface: SocialWorkspaceService

Returns the SocialWorkspace container of the given document if it is in a Social Workspace even if the user does not have right on it, null otherwise.

The underlying DocumentModel is detached.

Specified by:

getDetachedSocialWorkspace in interface SocialWorkspaceService

getDetachedSocialWorkspace

public SocialWorkspace getDetachedSocialWorkspace(CoreSession session,
                                         DocumentRef docRef)

Description copied from interface: SocialWorkspaceService

Returns the SocialWorkspace container of the given document ref if it is in a Social Workspace even if the user does not have right on it, null otherwise.

The underlying DocumentModel is detached.

Specified by:

getDetachedSocialWorkspace in interface SocialWorkspaceService

getSocialWorkspace

public SocialWorkspace getSocialWorkspace(DocumentModel doc)

Description copied from interface: SocialWorkspaceService

Returns the SocialWorkspace container of the given document if it is part of a Social Workspace, null otherwise.

Specified by:

getSocialWorkspace in interface SocialWorkspaceService

getValidationDays

public int getValidationDays()

Description copied from interface: SocialWorkspaceService

Gets the number of days before a social workspace expires without validation.

Specified by:

getValidationDays in interface SocialWorkspaceService

Returns:

number of days

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

getSocialWorkspaceContainerDescriptor

public SocialWorkspaceContainerDescriptor getSocialWorkspaceContainerDescriptor()

Description copied from interface: SocialWorkspaceService

Returns the configured SocialWorkspaceContainerDescriptor that contains the path, title and description of the container.

Specified by:

getSocialWorkspaceContainerDescriptor in interface SocialWorkspaceService

getSocialWorkspaceContainer

public DocumentModel getSocialWorkspaceContainer(CoreSession session)

Description copied from interface: SocialWorkspaceService

Returns Social Workspace Container and create it if needed.

Specified by:

getSocialWorkspaceContainer in interface SocialWorkspaceService

handleSocialWorkspaceCreation

public void handleSocialWorkspaceCreation(SocialWorkspace socialWorkspace,
                                 Principal principal)

Description copied from interface: SocialWorkspaceService

Handles a Social Workspace creation:

• create related groups
• put specific ACLs

Specified by:

handleSocialWorkspaceCreation in interface SocialWorkspaceService

principal - the Principal initializing the Social Workspace

handleSocialWorkspaceDeletion

public void handleSocialWorkspaceDeletion(SocialWorkspace socialWorkspace)

Description copied from interface: SocialWorkspaceService

Handles a Social Workspace deletion:

• remove related groups

Specified by:

handleSocialWorkspaceDeletion in interface SocialWorkspaceService

addSocialWorkspaceAdministrator

public boolean addSocialWorkspaceAdministrator(SocialWorkspace socialWorkspace,
                                      Principal principal)

Description copied from interface: SocialWorkspaceService

Adds a user to the socialWorkspace administrators group.

Specified by:

addSocialWorkspaceAdministrator in interface SocialWorkspaceService

Returns:

true if the user was successfully added to the administrators group, false otherwise.

addSocialWorkspaceMember

public boolean addSocialWorkspaceMember(SocialWorkspace socialWorkspace,
                               Principal principal)

Description copied from interface: SocialWorkspaceService

Adds a user to the socialWorkspace members group.

Specified by:

addSocialWorkspaceMember in interface SocialWorkspaceService

Returns:

true if the user was successfully added to the members group, false otherwise.

addSocialWorkspaceMembers

public List<String> addSocialWorkspaceMembers(SocialWorkspace socialWorkspace,
                                     String groupName)
                                       throws ClientException

Description copied from interface: SocialWorkspaceService

Add all group's users to the socialWorkspace members groups

Specified by:

addSocialWorkspaceMembers in interface SocialWorkspaceService

groupName - of an existing group.

Returns:

List<String> containing imported users, or an empty one.

Throws:

ClientException - when groupName doesn't exist

addSocialWorkspaceMembers

public List<String> addSocialWorkspaceMembers(SocialWorkspace socialWorkspace,
                                     List<String> emails)
                                       throws ClientException

Description copied from interface: SocialWorkspaceService

Add several users to the socialWorkspace members group.

Specified by:

addSocialWorkspaceMembers in interface SocialWorkspaceService

Returns:

List<String> contains the email of user added, or an empty one.

Throws:

ClientException

removeSocialWorkspaceAdministrator

public void removeSocialWorkspaceAdministrator(SocialWorkspace socialWorkspace,
                                      Principal principal)

Description copied from interface: SocialWorkspaceService

Removes a user from the @{code socialWorkspace} administrators group.

Specified by:

removeSocialWorkspaceAdministrator in interface SocialWorkspaceService

removeSocialWorkspaceMember

public void removeSocialWorkspaceMember(SocialWorkspace socialWorkspace,
                               Principal principal)

Description copied from interface: SocialWorkspaceService

Removes a user from the @{code socialWorkspace} members group.

Specified by:

removeSocialWorkspaceMember in interface SocialWorkspaceService

makeSocialWorkspacePublic

public void makeSocialWorkspacePublic(SocialWorkspace socialWorkspace)

Description copied from interface: SocialWorkspaceService

Makes the given socialWorkspace public.

Puts the correct rights so that non-members can view public documents and public dashboard.

Specified by:

makeSocialWorkspacePublic in interface SocialWorkspaceService

makeSocialWorkspacePrivate

public void makeSocialWorkspacePrivate(SocialWorkspace socialWorkspace)

Description copied from interface: SocialWorkspaceService

Makes the given socialWorkspace private.

Restricts rights for non-members users.

Specified by:

makeSocialWorkspacePrivate in interface SocialWorkspaceService

handleSubscriptionRequest

public void handleSubscriptionRequest(SocialWorkspace socialWorkspace,
                             Principal principal)

Description copied from interface: SocialWorkspaceService

Handles a Subscription Request on socialWorkspace for the given principal.

Specified by:

handleSubscriptionRequest in interface SocialWorkspaceService

isSubscriptionRequestPending

public boolean isSubscriptionRequestPending(SocialWorkspace socialWorkspace,
                                   Principal principal)

Description copied from interface: SocialWorkspaceService

Returns true if there is a pending Subscription Request for the given principal, false otherwise.

Specified by:

isSubscriptionRequestPending in interface SocialWorkspaceService

acceptSubscriptionRequest

public void acceptSubscriptionRequest(SocialWorkspace socialWorkspace,
                             SubscriptionRequest subscriptionRequest)

Description copied from interface: SocialWorkspaceService

Accepts the subscriptionRequest for socialWorkspace.

Specified by:

acceptSubscriptionRequest in interface SocialWorkspaceService

rejectSubscriptionRequest

public void rejectSubscriptionRequest(SocialWorkspace socialWorkspace,
                             SubscriptionRequest subscriptionRequest)

Description copied from interface: SocialWorkspaceService

Rejects the subscriptionRequest for socialWorkspace.

Specified by:

rejectSubscriptionRequest in interface SocialWorkspaceService

searchUsers

public List<String> searchUsers(SocialWorkspace socialWorkspace,
                       RelationshipKind kind,
                       String pattern)

Description copied from interface: SocialWorkspaceService

Returns all matching users from a Social Workspace, or an empty list.

Specified by:

searchUsers in interface SocialWorkspaceService

kind - can be null or empty to search through all users.

pattern - can be blank.

searchMembers

public List<String> searchMembers(SocialWorkspace socialWorkspace,
                         String pattern)

Description copied from interface: SocialWorkspaceService

Returns all matching members from a Social Workspace, or an empty list.

Specified by:

searchMembers in interface SocialWorkspaceService

pattern - can be blank.

searchAdministrators

public List<String> searchAdministrators(SocialWorkspace socialWorkspace,
                                String pattern)

Description copied from interface: SocialWorkspaceService

Returns all matching administrators from a Social Workspace, or an empty list.

Specified by:

searchAdministrators in interface SocialWorkspaceService

pattern - can be blank.