org.alfresco.module.vti.handler.alfresco

Class AbstractAlfrescoDwsServiceHandler

java.lang.Object

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

All Implemented Interfaces:

DwsServiceHandler

Direct Known Subclasses:

AlfrescoDwsServiceHandler

public abstract class AbstractAlfrescoDwsServiceHandler
extends Object
implements DwsServiceHandler

Alfresco implementation of DwsServiceHandler interface

Author:

EugeneZh

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticationService	authenticationService
protected ContentService	contentService
protected FileFolderService	fileFolderService
protected org.alfresco.service.cmr.repository.NodeService	nodeService
protected Map<String,String>	pagesMap
protected VtiPathHelper	pathHelper
protected org.alfresco.service.cmr.security.PermissionService	permissionService
protected PersonService	personService
protected TransactionService	transactionService

Constructor Summary

Constructors

Constructor and Description
AbstractAlfrescoDwsServiceHandler()

Method Summary

Modifier and Type	Method and Description
protected void	addDwsContentRecursive(FileInfo dwsInfo, List<DocumentBean> result, String documetnLibraryURL) Collect information about files and folders in current document workspace site
DwsBean	createDws(String parentDwsUrl, String name, List<UserBean> users, String title, List<DocumentBean> documents, String host, String context, SessionUser user) Creates a document workspace site
void	createFolder(String url) Creates a subfolder in a document library of the current document workspace site
void	deleteDws(String dwsUrl, SessionUser user) Deletes the current document workspace site and its contents
void	deleteFolder(String url) Deletes a subfolder from a document library of the current document workspace site
protected abstract SchemaBean	doCreateDocumentSchemaBean(FileInfo dwsFileInfo, List<SchemaFieldBean> fields) Create document schema
protected abstract String	doCreateDws(String dwsName, String title, SessionUser user) Creates a document workspace site
protected abstract SchemaBean	doCreateLinkSchemaBean(FileInfo dwsFileInfo, List<SchemaFieldBean> fields) Create link schema
protected abstract SchemaBean	doCreateTasksSchemaBean(FileInfo dwsFileInfo, List<SchemaFieldBean> fields) Create tasks schema
protected abstract void	doDeleteDws(FileInfo dwsFileInfo, SessionUser user) Deletes the current document workspace site and its contents
protected abstract void	doGetDwsContentRecursive(FileInfo fileInfo, List<DocumentBean> dwsContent) Get document workspace site content
protected abstract String	doGetDwsCreationUrl(String parentUrl, String title) Get a new document workspace site creation url
protected abstract List<DocumentBean>	doGetDwsDocuments(FileInfo fileInfo) Get the document list
protected abstract List<LinkBean>	doGetDwsLinks(FileInfo fileInfo) Get document workspace site links
protected abstract String	doGetLastUpdate(FileInfo dwsFileInfo) Resolves site's last update time as string
protected abstract org.alfresco.service.namespace.QName	doGetModelType() Get type of alfresco document workspace site (Folder or Site)
protected abstract DwsBean	doGetResultBean(String parentUrl, String dwsUrl, String host, String context) Get new document workspace site description
protected abstract List<Permission>	doGetUsersPermissions(FileInfo dwsFileInfo) Get users permissions
protected abstract List<MemberBean>	doListDwsMembers(FileInfo dwsFileInfo) Get document workspace site users
protected abstract void	doRemoveDwsUser(FileInfo dwsFileInfo, String authority) Removes the specified user from the list of users for the current document workspace site
protected abstract void	doUpdateDwsDataDelete(LinkBean linkBean, String dws) Deletes link in site links container
protected abstract LinkBean	doUpdateDwsDataNew(LinkBean linkBean, String dws) Creates new link in site links container
protected abstract void	doUpdateDwsDataUpdate(LinkBean linkBean, String dws) Updates given link in site links container
protected abstract boolean	dwsExists(String name)
protected UserBean	getCurrentUser() Get current user
DwsData	getDwsData(String document, String lastUpdate) Returns information about a document workspace site and the lists it contains
DwsMetadata	getDWSMetaData(String document, String id, boolean minimal) Returns information about a document workspace site and the lists it contains
protected String	getDwsPermissionsUrl(String dwsUrl)
Map<String,String>	getPagesMap() Get pages map
abstract WorkspaceType	getWorkspaceType(FileInfo dwsNode)
void	removeDwsUser(String dwsUrl, String id) Removes the specified user from the list of users for the current document workspace site
protected String	removeIllegalCharacters(String value) Remove illegal characters from string
void	renameDws(String oldDwsUrl, String title) Changes the title of the current document workspace site
void	setAuthenticationService(AuthenticationService authenticationService) Set authentication service
void	setContentService(ContentService contentService) Set content service
void	setFileFolderService(FileFolderService fileFolderService) Set file-folder service
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set node service
void	setPagesMap(Map<String,String> pagesMap) Set pages map
void	setPathHelper(VtiPathHelper pathHelper) Set path helper
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService) Set permission service
void	setPersonService(PersonService personService) Set person service
void	setTransactionService(TransactionService transactionService) Set transaction service
LinkBean	updateDwsData(LinkBean linkBean, CAMLMethod method, String dws) Update document workspace site data such as links

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.module.vti.handler.DwsServiceHandler

canCreateDwsUrl, handleRedirect

Field Detail

fileFolderService

protected FileFolderService fileFolderService

nodeService

protected org.alfresco.service.cmr.repository.NodeService nodeService

transactionService

protected TransactionService transactionService

permissionService

protected org.alfresco.service.cmr.security.PermissionService permissionService

authenticationService

protected AuthenticationService authenticationService

personService

protected PersonService personService

contentService

protected ContentService contentService

pathHelper

protected VtiPathHelper pathHelper

pagesMap

protected Map<String,String> pagesMap

Constructor Detail

AbstractAlfrescoDwsServiceHandler

public AbstractAlfrescoDwsServiceHandler()

Method Detail

getPagesMap

public Map<String,String> getPagesMap()

Get pages map

Returns:

pages map

setPagesMap

public void setPagesMap(Map<String,String> pagesMap)

Set pages map

Parameters:

pagesMap - the pages map to set

setPathHelper

public void setPathHelper(VtiPathHelper pathHelper)

Set path helper

Parameters:

pathHelper - the path helper to set (VtiPathHelper)

setFileFolderService

public void setFileFolderService(FileFolderService fileFolderService)

Set file-folder service

Parameters:

fileFolderService - the file-folder service to set (FileFolderService)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Set node service

Parameters:

nodeService - the node service to set (NodeService)

setTransactionService

public void setTransactionService(TransactionService transactionService)

Set transaction service

Parameters:

transactionService - the transaction service to set (TransactionService)

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

Set permission service

Parameters:

permissionService - the permission service to set (PermissionService)

setAuthenticationService

public void setAuthenticationService(AuthenticationService authenticationService)

Set authentication service

Parameters:

authenticationService - the authentication service to set (AuthenticationService)

setPersonService

public void setPersonService(PersonService personService)

Set person service

Parameters:

personService - the person service to set (PersonService)

setContentService

public void setContentService(ContentService contentService)

Set content service

Parameters:

contentService - the content service to set (ContentService)

getDWSMetaData

public DwsMetadata getDWSMetaData(String document,
                                  String id,
                                  boolean minimal)
                           throws Exception

Description copied from interface: DwsServiceHandler

Returns information about a document workspace site and the lists it contains

Specified by:

getDWSMetaData in interface DwsServiceHandler

Parameters:

document - the site-based URL of a document in a document library in the document workspace site

id - an optional document globally unique identifier (GUID)

minimal - determines whether the output includes information about the schemas, lists, documents, links, and tasks lists of a document workspace site

Returns:

DwsMetadata information about a document workspace site and the lists it contains (DwsMetadata)

Throws:

Exception

See Also:

DwsServiceHandler.getDWSMetaData(java.lang.String, java.lang.String, boolean)

getDwsPermissionsUrl

protected String getDwsPermissionsUrl(String dwsUrl)

getWorkspaceType

public abstract WorkspaceType getWorkspaceType(FileInfo dwsNode)

getDwsData

public DwsData getDwsData(String document,
                          String lastUpdate)
                   throws SiteDoesNotExistException

Description copied from interface: DwsServiceHandler

Returns information about a document workspace site and the lists it contains

Specified by:

getDwsData in interface DwsServiceHandler

Parameters:

document - the site-based URL of a document in a document library in the document workspace site

lastUpdate - returned in the results of a previous call to the GetDwsData or GetDwsMetadata method

Returns:

DwsData information about a document workspace site (DwsData)

Throws:

SiteDoesNotExistException

See Also:

DwsServiceHandler.getDwsData(java.lang.String, java.lang.String)

createDws

public DwsBean createDws(String parentDwsUrl,
                         String name,
                         List<UserBean> users,
                         String title,
                         List<DocumentBean> documents,
                         String host,
                         String context,
                         SessionUser user)

Description copied from interface: DwsServiceHandler

Creates a document workspace site

Specified by:

createDws in interface DwsServiceHandler

Parameters:

parentDwsUrl - url of the parent dws

name - the optional URL of the new document workspace site. If an empty string is passed, the URL of the new SharePoint site is based on the title

users - an optional list of users to add to the new SharePoint site

title - the title of the new document workspace site

documents - an optional list of documents. Used by Microsoft Office Outlook 2003 when adding shared attachments to a new document workspace site

host - application host

context - application context

user - current user

Returns:

DwsBean information about a new document workspace site DwsData (DwsBean)

See Also:

DwsServiceHandler.createDws(java.lang.String, java.lang.String, java.util.List, java.lang.String, java.util.List, java.lang.String, java.lang.String, org.alfresco.repo.SessionUser)

deleteDws

public void deleteDws(String dwsUrl,
                      SessionUser user)

Description copied from interface: DwsServiceHandler

Deletes the current document workspace site and its contents

Specified by:

deleteDws in interface DwsServiceHandler

Parameters:

dwsUrl - url of dws to delete

user - current user

See Also:

DwsServiceHandler.deleteDws(java.lang.String, org.alfresco.repo.SessionUser)

createFolder

public void createFolder(String url)

Description copied from interface: DwsServiceHandler

Creates a subfolder in a document library of the current document workspace site

Specified by:

createFolder in interface DwsServiceHandler

Parameters:

url - the proposed site-based URL of the folder to create

See Also:

DwsServiceHandler.createFolder(java.lang.String)

deleteFolder

public void deleteFolder(String url)

Description copied from interface: DwsServiceHandler

Deletes a subfolder from a document library of the current document workspace site

Specified by:

deleteFolder in interface DwsServiceHandler

Parameters:

url - The site-based URL of the folder to delete

See Also:

DwsServiceHandler.deleteFolder(java.lang.String)

renameDws

public void renameDws(String oldDwsUrl,
                      String title)

Description copied from interface: DwsServiceHandler

Changes the title of the current document workspace site

Specified by:

renameDws in interface DwsServiceHandler

Parameters:

oldDwsUrl - url of dws to rename

title - the new title for the document workspace site

See Also:

DwsServiceHandler.renameDws(java.lang.String, java.lang.String)

removeDwsUser

public void removeDwsUser(String dwsUrl,
                          String id)

Description copied from interface: DwsServiceHandler

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

Specified by:

removeDwsUser in interface DwsServiceHandler

Parameters:

dwsUrl - URL of document workspace site

id - the ID of the user to be removed from the list of users

See Also:

DwsServiceHandler.removeDwsUser(java.lang.String, java.lang.String)

doGetDwsCreationUrl

protected abstract String doGetDwsCreationUrl(String parentUrl,
                                              String title)

Get a new document workspace site creation url

Parameters:

parentUrl - url of the parent dws

title - the title of the new document workspace site

Returns:

document workspace site url

doCreateDws

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

Creates a document workspace site

Parameters:

dwsName - TODO

title - the title of the new document workspace site

user - current user

Throws:

org.apache.commons.httpclient.HttpException

IOException

dwsExists

protected abstract boolean dwsExists(String name)

Parameters:

name -

Returns:

Returns true if the specified DWS exists.

doGetResultBean

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

Get new document workspace site description

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

doDeleteDws

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

Deletes the current document workspace site and its contents

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

user - current user

Throws:

org.apache.commons.httpclient.HttpException

IOException

doRemoveDwsUser

protected abstract void doRemoveDwsUser(FileInfo dwsFileInfo,
                                        String authority)

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

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

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

doListDwsMembers

protected abstract List<MemberBean> doListDwsMembers(FileInfo dwsFileInfo)

Get document workspace site users

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

Returns:

list of document workspace site users

doGetDwsContentRecursive

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

Get document workspace site content

Parameters:

fileInfo - document workspace site file info (FileInfo)

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

doGetDwsLinks

protected abstract List<LinkBean> doGetDwsLinks(FileInfo fileInfo)

Get document workspace site links

Parameters:

fileInfo - document workspace site file info (FileInfo)

Returns:

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

doGetDwsDocuments

protected abstract List<DocumentBean> doGetDwsDocuments(FileInfo fileInfo)

Get the document list

Parameters:

fileInfo - document workspace site file info (FileInfo)

Returns:

list of DocumentBean objects

doGetModelType

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

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

Returns:

QName type of alfresco document workspace site

doGetUsersPermissions

protected abstract List<Permission> doGetUsersPermissions(FileInfo dwsFileInfo)

Get users permissions

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

Returns:

list of permissions

doCreateDocumentSchemaBean

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

Create document schema

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

fields - system fields of the document (SchemaFieldBean)

Returns:

SchemaBean document schema

doCreateLinkSchemaBean

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

Create link schema

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

fields - system fields of the link (SchemaFieldBean)

Returns:

SchemaBean link schema

doCreateTasksSchemaBean

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

Create tasks schema

Parameters:

dwsFileInfo - document workspace site file info (FileInfo)

fields - system fields of the link (SchemaFieldBean)

Returns:

SchemaBean link schema

doGetLastUpdate

protected abstract String doGetLastUpdate(FileInfo dwsFileInfo)

Resolves site's last update time as string

Parameters:

dwsFileInfo - fileInfo of site

Returns:

last update time as string

getCurrentUser

protected UserBean getCurrentUser()

Get current user

Returns:

UserBean represent current user

addDwsContentRecursive

protected void addDwsContentRecursive(FileInfo dwsInfo,
                                      List<DocumentBean> result,
                                      String documetnLibraryURL)

Collect information about files and folders in current document workspace site

Parameters:

dwsInfo - document workspace site file info (FileInfo)

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

documetnLibraryURL - relative url on document library folder on site

removeIllegalCharacters

protected String removeIllegalCharacters(String value)

Remove illegal characters from string

Parameters:

value - input string

Returns:

output string

updateDwsData

public LinkBean updateDwsData(LinkBean linkBean,
                              CAMLMethod method,
                              String dws)

Description copied from interface: DwsServiceHandler

Update document workspace site data such as links

Specified by:

updateDwsData in interface DwsServiceHandler

Parameters:

linkBean - (LinkBean)

method - CAMLMethod

dws - document workspace site name

Returns:

linkBean that was changed

See Also:

DwsServiceHandler.updateDwsData(org.alfresco.module.vti.metadata.model.LinkBean, CAMLMethod, java.lang.String)

doUpdateDwsDataNew

protected abstract LinkBean doUpdateDwsDataNew(LinkBean linkBean,
                                               String dws)

Creates new link in site links container

Parameters:

linkBean - linkBean that should be created

dws - site name

Returns:

linkBean that was created

doUpdateDwsDataUpdate

protected abstract void doUpdateDwsDataUpdate(LinkBean linkBean,
                                              String dws)

Updates given link in site links container

Parameters:

linkBean - linkBean that should be updated

dws - site name

doUpdateDwsDataDelete

protected abstract void doUpdateDwsDataDelete(LinkBean linkBean,
                                              String dws)

Deletes link in site links container

Parameters:

linkBean - linkBean that should be deleted

dws - site name