org.alfresco.module.vti.handler.alfresco

Class AlfrescoDwsServiceHandler

java.lang.Object

org.alfresco.module.vti.handler.alfresco.AbstractAlfrescoDwsServiceHandler

org.alfresco.module.vti.handler.alfresco.AlfrescoDwsServiceHandler

All Implemented Interfaces:

DwsServiceHandler

public class AlfrescoDwsServiceHandler
extends AbstractAlfrescoDwsServiceHandler

Alfresco implementation of DwsServiceHandler and AbstractAlfrescoDwsServiceHandler

Author:

PavelYur

Field Summary

Fields inherited from class org.alfresco.module.vti.handler.alfresco.AbstractAlfrescoDwsServiceHandler

authenticationService, contentService, fileFolderService, nodeService, pagesMap, pathHelper, permissionService, personService, transactionService

Constructor Summary

Constructors

Constructor and Description
AlfrescoDwsServiceHandler()

Method Summary

Modifier and Type	Method and Description
boolean	canCreateDwsUrl(String url) Indicates whether the document workspace specified by the given url can be created.
protected SchemaBean	doCreateDocumentSchemaBean(FileInfo dwsFileInfo, List<SchemaFieldBean> fields) Create document schema
protected String	doCreateDws(String dwsName, String title, SessionUser user) Creates a document workspace site
protected SchemaBean	doCreateLinkSchemaBean(FileInfo dwsFileInfo, List<SchemaFieldBean> fields) Create link schema
protected SchemaBean	doCreateTasksSchemaBean(FileInfo dwsFileInfo, List<SchemaFieldBean> fields) Create tasks schema
protected void	doDeleteDws(FileInfo dwsFileInfo, SessionUser user) Deletes the current document workspace site and its contents
void	doGetDwsContentRecursive(FileInfo fileInfo, List<DocumentBean> dwsContent) Get document workspace site content
protected String	doGetDwsCreationUrl(String parentUrl, String title) Get a new document workspace site creation url
protected List<DocumentBean>	doGetDwsDocuments(FileInfo fileInfo) Get the document list
List<LinkBean>	doGetDwsLinks(FileInfo fileInfo) Get document workspace site links
protected String	doGetLastUpdate(FileInfo dwsFileInfo) Resolves site's last update time as string
protected org.alfresco.service.namespace.QName	doGetModelType() Get type of alfresco document workspace site (Folder or Site)
protected DwsBean	doGetResultBean(String parentUrl, String dwsUrl, String host, String context) Get new document workspace site description
protected List<Permission>	doGetUsersPermissions(FileInfo dwsFileInfo) Get users permissions
List<MemberBean>	doListDwsMembers(FileInfo dwsFileInfo) Get document workspace site users
void	doRemoveDwsUser(FileInfo dwsFileInfo, String authority) Removes the specified user from the list of users for the current document workspace site
protected void	doUpdateDwsDataDelete(LinkBean linkBean, String dws) Deletes link in site links container
protected LinkBean	doUpdateDwsDataNew(LinkBean linkBean, String dws) Creates new link in site links container
protected void	doUpdateDwsDataUpdate(LinkBean linkBean, String dws) Updates given link in site links container
protected boolean	dwsExists(String name)
WorkspaceType	getWorkspaceType(FileInfo dwsNode)
void	handleRedirect(HttpServletRequest req, HttpServletResponse resp) Redirect request to the appropriate page
protected String	sanitizeShortName(String dwsName) For a given Document Workspace name, sanitizes it such that: the name is all lower case it does not contain spaces - they are replaced with hyphens
void	setAuthenticationComponent(AuthenticationComponent authenticationComponent) Set authentication component
void	setAuthorityService(AuthorityService authorityService) Set authority service
void	setShareUtils(ShareUtils shareUtils) Set share utils
void	setSiteService(SiteService siteService) Set site service

Methods inherited from class org.alfresco.module.vti.handler.alfresco.AbstractAlfrescoDwsServiceHandler

addDwsContentRecursive, createDws, createFolder, deleteDws, deleteFolder, getCurrentUser, getDwsData, getDWSMetaData, getDwsPermissionsUrl, getPagesMap, removeDwsUser, removeIllegalCharacters, renameDws, setAuthenticationService, setContentService, setFileFolderService, setNodeService, setPagesMap, setPathHelper, setPermissionService, setPersonService, setTransactionService, updateDwsData

Methods inherited from class java.lang.Object

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

Constructor Detail

AlfrescoDwsServiceHandler

public AlfrescoDwsServiceHandler()

Method Detail

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

Set authority service

Parameters:

authorityService - the authority service to set (AuthorityService)

setAuthenticationComponent

public void setAuthenticationComponent(AuthenticationComponent authenticationComponent)

Set authentication component

Parameters:

authenticationComponent - the authentication component to set (AuthenticationComponent)

setSiteService

public void setSiteService(SiteService siteService)

Set site service

Parameters:

siteService - the site service to set (SiteService)

setShareUtils

public void setShareUtils(ShareUtils shareUtils)

Set share utils

Parameters:

shareUtils - the share utils to set (ShareUtils)

handleRedirect

public void handleRedirect(HttpServletRequest req,
                           HttpServletResponse resp)
                    throws org.apache.commons.httpclient.HttpException,
                           IOException

Description copied from interface: DwsServiceHandler

Redirect request to the appropriate page

Parameters:

req - HTTP request

resp - HTTP response

Throws:

org.apache.commons.httpclient.HttpException

IOException

See Also:

DwsServiceHandler.handleRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

canCreateDwsUrl

public boolean canCreateDwsUrl(String url)

Indicates whether the document workspace specified by the given url can be created.

Parameters:

url - Specifies the document workspace to be created.

Returns:

boolean

doRemoveDwsUser

public void doRemoveDwsUser(FileInfo dwsFileInfo,
                            String authority)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Removes the specified user from the list of users for the current document workspace site

Specified by:

doRemoveDwsUser in class AbstractAlfrescoDwsServiceHandler

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

authority - name of the user to be removed from the list of users

See Also:

AbstractAlfrescoDwsServiceHandler.doRemoveDwsUser(org.alfresco.service.cmr.model.FileInfo, java.lang.String)

doGetDwsContentRecursive

public void doGetDwsContentRecursive(FileInfo fileInfo,
                                     List<DocumentBean> dwsContent)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Get document workspace site content

Specified by:

doGetDwsContentRecursive in class AbstractAlfrescoDwsServiceHandler

Parameters:

fileInfo - document workspace site file info (FileInfo)

dwsContent - list of beans with document workspace site content informations (DocumentBean)

See Also:

AbstractAlfrescoDwsServiceHandler.doGetDwsContentRecursive(org.alfresco.service.cmr.model.FileInfo, java.util.List)

doGetDwsLinks

public List<LinkBean> doGetDwsLinks(FileInfo fileInfo)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Get document workspace site links

Specified by:

doGetDwsLinks in class AbstractAlfrescoDwsServiceHandler

Parameters:

fileInfo - document workspace site file info (FileInfo)

Returns:

linksList list of beans with document workspace site links (LinkBean)

See Also:

AbstractAlfrescoDwsServiceHandler.doGetDwsLinks(org.alfresco.service.cmr.model.FileInfo)

doGetDwsDocuments

protected List<DocumentBean> doGetDwsDocuments(FileInfo fileInfo)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Get the document list

Specified by:

doGetDwsDocuments in class AbstractAlfrescoDwsServiceHandler

Parameters:

fileInfo - document workspace site file info (FileInfo)

Returns:

list of DocumentBean objects

See Also:

AbstractAlfrescoDwsServiceHandler.doGetDwsDocuments(FileInfo)

doListDwsMembers

public List<MemberBean> doListDwsMembers(FileInfo dwsFileInfo)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Get document workspace site users

Specified by:

doListDwsMembers in class AbstractAlfrescoDwsServiceHandler

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

Returns:

list of document workspace site users

See Also:

AbstractAlfrescoDwsServiceHandler.doListDwsMembers(org.alfresco.service.cmr.model.FileInfo)

doGetModelType

protected org.alfresco.service.namespace.QName doGetModelType()

Description copied from class: AbstractAlfrescoDwsServiceHandler

Get type of alfresco document workspace site (Folder or Site)

Specified by:

doGetModelType in class AbstractAlfrescoDwsServiceHandler

Returns:

QName type of alfresco document workspace site

See Also:

AbstractAlfrescoDwsServiceHandler.doGetModelType()

doGetUsersPermissions

protected List<Permission> doGetUsersPermissions(FileInfo dwsFileInfo)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Get users permissions

Specified by:

doGetUsersPermissions in class AbstractAlfrescoDwsServiceHandler

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

Returns:

list of permissions

See Also:

AbstractAlfrescoDwsServiceHandler.doGetUsersPermissions(org.alfresco.service.cmr.model.FileInfo)

doCreateDocumentSchemaBean

protected SchemaBean doCreateDocumentSchemaBean(FileInfo dwsFileInfo,
                                                List<SchemaFieldBean> fields)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Create document schema

Specified by:

doCreateDocumentSchemaBean in class AbstractAlfrescoDwsServiceHandler

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

fields - system fields of the document (SchemaFieldBean)

Returns:

SchemaBean document schema

See Also:

AbstractAlfrescoDwsServiceHandler.doCreateDocumentSchemaBean(org.alfresco.service.cmr.model.FileInfo, java.util.List)

doCreateLinkSchemaBean

protected SchemaBean doCreateLinkSchemaBean(FileInfo dwsFileInfo,
                                            List<SchemaFieldBean> fields)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Create link schema

Specified by:

doCreateLinkSchemaBean in class AbstractAlfrescoDwsServiceHandler

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

fields - system fields of the link (SchemaFieldBean)

Returns:

SchemaBean link schema

See Also:

AbstractAlfrescoDwsServiceHandler.doCreateLinkSchemaBean(org.alfresco.service.cmr.model.FileInfo, java.util.List)

doCreateTasksSchemaBean

protected SchemaBean doCreateTasksSchemaBean(FileInfo dwsFileInfo,
                                             List<SchemaFieldBean> fields)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Create tasks schema

Specified by:

doCreateTasksSchemaBean in class AbstractAlfrescoDwsServiceHandler

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

fields - system fields of the link (SchemaFieldBean)

Returns:

SchemaBean link schema

See Also:

AbstractAlfrescoDwsServiceHandler.doCreateTasksSchemaBean(org.alfresco.service.cmr.model.FileInfo, java.util.List)

doDeleteDws

protected void doDeleteDws(FileInfo dwsFileInfo,
                           SessionUser user)
                    throws org.apache.commons.httpclient.HttpException,
                           IOException

Description copied from class: AbstractAlfrescoDwsServiceHandler

Deletes the current document workspace site and its contents

Specified by:

doDeleteDws in class AbstractAlfrescoDwsServiceHandler

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

user - current user

Throws:

org.apache.commons.httpclient.HttpException

IOException

See Also:

AbstractAlfrescoDwsServiceHandler.doDeleteDws(org.alfresco.service.cmr.model.FileInfo, org.alfresco.repo.SessionUser)

doCreateDws

protected String doCreateDws(String dwsName,
                             String title,
                             SessionUser user)
                      throws org.apache.commons.httpclient.HttpException,
                             IOException

Creates a document workspace site

Specified by:

doCreateDws in class AbstractAlfrescoDwsServiceHandler

Parameters:

dwsName - TODO

title - the title of the new document workspace site

user - current user

Throws:

org.apache.commons.httpclient.HttpException

IOException

sanitizeShortName

protected String sanitizeShortName(String dwsName)

For a given Document Workspace name, sanitizes it such that:

• the name is all lower case
• it does not contain spaces - they are replaced with hyphens

Parameters:

dwsName -

Returns:

sanitized short site name

dwsExists

protected boolean dwsExists(String name)

Specified by:

dwsExists in class AbstractAlfrescoDwsServiceHandler

Returns:

Returns true if the specified DWS exists.

doGetDwsCreationUrl

protected String doGetDwsCreationUrl(String parentUrl,
                                     String title)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Get a new document workspace site creation url

Specified by:

doGetDwsCreationUrl in class AbstractAlfrescoDwsServiceHandler

Parameters:

parentUrl - url of the parent dws

title - the title of the new document workspace site

Returns:

document workspace site url

See Also:

AbstractAlfrescoDwsServiceHandler.doGetDwsCreationUrl(java.lang.String, java.lang.String)

doGetResultBean

protected DwsBean doGetResultBean(String parentUrl,
                                  String dwsUrl,
                                  String host,
                                  String context)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Get new document workspace site description

Specified by:

doGetResultBean in class AbstractAlfrescoDwsServiceHandler

Parameters:

parentUrl - url of the parent document workspace site

dwsUrl - url of the document workspace site

host - application host

context - application context

Returns:

DwsBean new document workspace site description

See Also:

AbstractAlfrescoDwsServiceHandler.doGetResultBean(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

doUpdateDwsDataDelete

protected void doUpdateDwsDataDelete(LinkBean linkBean,
                                     String dws)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Deletes link in site links container

Specified by:

doUpdateDwsDataDelete in class AbstractAlfrescoDwsServiceHandler

Parameters:

linkBean - linkBean that should be deleted

dws - site name

See Also:

AbstractAlfrescoDwsServiceHandler.doUpdateDwsDataDelete(org.alfresco.module.vti.metadata.model.LinkBean, java.lang.String)

doUpdateDwsDataNew

protected LinkBean doUpdateDwsDataNew(LinkBean linkBean,
                                      String dws)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Creates new link in site links container

Specified by:

doUpdateDwsDataNew in class AbstractAlfrescoDwsServiceHandler

Parameters:

linkBean - linkBean that should be created

dws - site name

Returns:

linkBean that was created

See Also:

AbstractAlfrescoDwsServiceHandler.doUpdateDwsDataNew(org.alfresco.module.vti.metadata.model.LinkBean, java.lang.String)

doUpdateDwsDataUpdate

protected void doUpdateDwsDataUpdate(LinkBean linkBean,
                                     String dws)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Updates given link in site links container

Specified by:

doUpdateDwsDataUpdate in class AbstractAlfrescoDwsServiceHandler

Parameters:

linkBean - linkBean that should be updated

dws - site name

See Also:

AbstractAlfrescoDwsServiceHandler.doUpdateDwsDataUpdate(org.alfresco.module.vti.metadata.model.LinkBean, java.lang.String)

getWorkspaceType

public WorkspaceType getWorkspaceType(FileInfo dwsNode)

Specified by:

getWorkspaceType in class AbstractAlfrescoDwsServiceHandler

doGetLastUpdate

protected String doGetLastUpdate(FileInfo dwsFileInfo)

Description copied from class: AbstractAlfrescoDwsServiceHandler

Resolves site's last update time as string

Specified by:

doGetLastUpdate in class AbstractAlfrescoDwsServiceHandler

Parameters:

dwsFileInfo - fileInfo of site

Returns:

last update time as string

See Also:

AbstractAlfrescoDwsServiceHandler.doGetLastUpdate(org.alfresco.service.cmr.model.FileInfo dwsFileInfo)