org.nuxeo.ecm.platform.userworkspace.core.service

Class AbstractUserWorkspaceImpl

java.lang.Object

org.nuxeo.ecm.platform.userworkspace.core.service.AbstractUserWorkspaceImpl

All Implemented Interfaces:

Serializable, UserWorkspaceService

Direct Known Subclasses:

DefaultUserWorkspaceServiceImpl

public abstract class AbstractUserWorkspaceImpl
extends Object
implements UserWorkspaceService

Abstract class holding most of the logic for using UnrestrictedSessionRunner while creating UserWorkspaces and associated resources

Since:

5.9.5

Author:

tiry

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractUserWorkspaceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
DocumentModel	getCurrentUserPersonalWorkspace(CoreSession userCoreSession, DocumentModel context)
DocumentModel	getCurrentUserPersonalWorkspace(String userName, DocumentModel currentDocument) Gets the current user personal workspace from a lower level.
DocumentModel	getUserPersonalWorkspace(NuxeoPrincipal principal, DocumentModel context) Gets a detached user workspace of a specified user depending of the passed principal.
DocumentModel	getUserPersonalWorkspace(String userName, DocumentModel context) Gets a detached user workspace of a specified user.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUserWorkspaceImpl

public AbstractUserWorkspaceImpl()

Method Detail

getCurrentUserPersonalWorkspace

public DocumentModel getCurrentUserPersonalWorkspace(String userName,
                                            DocumentModel currentDocument)
                                              throws ClientException

Description copied from interface: UserWorkspaceService

Gets the current user personal workspace from a lower level.

If this personal workspace does not exist then a new one will be created for the user who is represented by first argument.

Specified by:

getCurrentUserPersonalWorkspace in interface UserWorkspaceService

Parameters:

userName - the current user

currentDocument - the current document on which the user was on

Returns:

the DocumentModel for the personal workspace of the current user

Throws:

ClientException

getCurrentUserPersonalWorkspace

public DocumentModel getCurrentUserPersonalWorkspace(CoreSession userCoreSession,
                                            DocumentModel context)
                                              throws ClientException

Specified by:

getCurrentUserPersonalWorkspace in interface UserWorkspaceService

Throws:

ClientException

getUserPersonalWorkspace

public DocumentModel getUserPersonalWorkspace(NuxeoPrincipal principal,
                                     DocumentModel context)
                                       throws ClientException

Description copied from interface: UserWorkspaceService

Gets a detached user workspace of a specified user depending of the passed principal.

Specified by:

getUserPersonalWorkspace in interface UserWorkspaceService

Parameters:

principal - of the wanted user's workspace owner

context - is a document to determine the domain

Returns:

the DocumentModel for the personal workspace

Throws:

ClientException

getUserPersonalWorkspace

public DocumentModel getUserPersonalWorkspace(String userName,
                                     DocumentModel context)
                                       throws ClientException

Description copied from interface: UserWorkspaceService

Gets a detached user workspace of a specified user.

Specified by:

getUserPersonalWorkspace in interface UserWorkspaceService

Parameters:

userName - is the username of the wanted user's workspace owner

context - is a document to determine the domain

Returns:

the DocumentModel for the personal workspace

Throws:

ClientException