org.alfresco.module.vti.handler.alfresco

Class AbstractAlfrescoMethodHandler

java.lang.Object

org.alfresco.module.vti.handler.alfresco.AbstractAlfrescoMethodHandler

All Implemented Interfaces:

MethodHandler

Direct Known Subclasses:

AlfrescoMethodHandler

public abstract class AbstractAlfrescoMethodHandler
extends Object
implements MethodHandler

Alfresco implementation of MethodHandler interface

Author:

EugeneZh

Constructor Summary

Constructors

Constructor and Description
AbstractAlfrescoMethodHandler()

Method Summary

Modifier and Type	Method and Description
static void	assertFile(FileInfo fileFileInfo) Asserts "this file info of content node reference"
static void	assertFolder(FileInfo folderFileInfo) Asserts "this file info of folder node reference"
static void	assertRemovableDocument(DocumentStatus documentStatus) Asserts "document with this status is removable"
static void	assertValidFileInfo(FileInfo fileInfo) Asserts "this file info isn't null"
DocMetaInfo	checkInDocument(String serviceName, String documentName, String comment, boolean keepCheckedOut, Date timeCheckedout, boolean validateWelcomeNames) Check in document method
FileInfo	checkout(FileInfo documentFileInfo, int timeout) Helper method for short-term or long-term checkouts
DocMetaInfo	checkOutDocument(String serviceName, String documentName, int force, int timeout, boolean validateWelcomeNames) Check out the file from a document library.
boolean	createDirectory(String serviceName, DocMetaInfo dir) Creates a folder for the current Web site
AuthenticationService	getAuthenticationService() Get authentication service
CheckOutCheckInService	getCheckOutCheckInService() Get check out check in service
ContentService	getContentService() Get content service
protected DialogMetaInfo	getDialogMetaInfo(FileInfo fileInfo) Returns DialogMetaInfo for FileInfo
org.alfresco.service.cmr.dictionary.DictionaryService	getDictionaryService()
DocsMetaInfo	getDocsMetaInfo(String serviceName, boolean listHiddenDocs, boolean listLinkInfo, boolean validateWelcomeNames, List<String> urlList) Provides the server with the standard meta-information concerning the designated file
VtiDocumentHelper	getDocumentHelper() Get document helper
FileFolderService	getFileFolderService() Get file folder service
DialogsMetaInfo	getFileOpen(String siteUrl, String location, List<String> fileDialogFilterValue, String rootFolder, VtiSortField sortField, VtiSort sortDir, String view) Opens a view of the document libraries within a site, of a specific document library, or of a folder within a document library
WebDAVLockService	getLockService() Get lock service
org.alfresco.service.cmr.repository.MimetypeService	getMimetypeService()
org.alfresco.service.cmr.repository.NodeService	getNodeService() Get node service
VtiPathHelper	getPathHelper() Get path helper
org.alfresco.service.cmr.security.PermissionService	getPermissionService() Get permission service
String	getServertimeZone() Get server time zone
TransactionService	getTransactionService() Get transaction service
String	getUserName() Get user name
VersionService	getVersionService() Get version service
DocsMetaInfo	moveDocument(String serviceName, String oldURL, String newURL, List<String> urlList, EnumSet<RenameOption> renameOptionSet, EnumSet<PutOption> putOptionSet, boolean docopy, boolean validateWelcomeNames) Rename the selected document to the new name
DocMetaInfo	putDocument(String serviceName, Document document, EnumSet<PutOption> putOptionSet, String comment, boolean keepCheckedOut, boolean validateWelcomeNames) Writes a file to a directory in an existing Web site
DocsMetaInfo	removeDocuments(String serviceName, List<String> urlList, List<Date> timeTokens, boolean validateWelcomeNames) Deletes the specified documents or folders from the Web site
void	setAuthenticationService(AuthenticationService authenticationService) Set authentication service
void	setCheckOutCheckInService(CheckOutCheckInService checkOutCheckInService) Set checkout-checkin service
void	setContentService(ContentService contentService) Set content service
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setDocMetaInfo(FileInfo fileInfo, DocMetaInfo docMetaInfo) Sets metadata for docMetaInfo
void	setDocumentHelper(VtiDocumentHelper checkoutHelper) Set document helper
void	setFileFolderService(FileFolderService fileFolderService) Set file folder service
void	setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set node service
void	setPathHelper(VtiPathHelper pathHelper) Set path helper
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService) Set permission service
void	setTransactionService(TransactionService transactionService) Set transaction service
void	setVersionService(VersionService versionService) Set version service
void	setWebDAVLockService(WebDAVLockService webDAVLockService) Set lock service

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.MethodHandler

decomposeURL, existResource, getDocument, getListDocuments, putResource, uncheckOutDocument

Constructor Detail

AbstractAlfrescoMethodHandler

public AbstractAlfrescoMethodHandler()

Method Detail

setTransactionService

public void setTransactionService(TransactionService transactionService)

Set transaction service

Parameters:

transactionService - the transaction service to set (TransactionService)

setContentService

public void setContentService(ContentService contentService)

Set content service

Parameters:

contentService - the content service to set (ContentService)

setWebDAVLockService

public void setWebDAVLockService(WebDAVLockService webDAVLockService)

Set lock service

Parameters:

webDAVLockService - the lock service to set

setNodeService

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

Set node service

Parameters:

nodeService - the node service to set (NodeService)

setCheckOutCheckInService

public void setCheckOutCheckInService(CheckOutCheckInService checkOutCheckInService)

Set checkout-checkin service

Parameters:

checkOutCheckInService - the checkout-checkin service to set (CheckOutCheckInService)

setFileFolderService

public void setFileFolderService(FileFolderService fileFolderService)

Set file folder service

Parameters:

fileFolderService - the file folder service to set (FileFolderService)

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)

setVersionService

public void setVersionService(VersionService versionService)

Set version service

Parameters:

versionService - the version service to set (VersionService)

setMimetypeService

public void setMimetypeService(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)

getMimetypeService

public org.alfresco.service.cmr.repository.MimetypeService getMimetypeService()

getDictionaryService

public org.alfresco.service.cmr.dictionary.DictionaryService getDictionaryService()

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setDocumentHelper

public void setDocumentHelper(VtiDocumentHelper checkoutHelper)

Set document helper

Parameters:

checkoutHelper - the document helper to set (VtiDocumentHelper)

setPathHelper

public void setPathHelper(VtiPathHelper pathHelper)

Set path helper

Parameters:

pathHelper - the path helper to set (VtiPathHelper)

getNodeService

public org.alfresco.service.cmr.repository.NodeService getNodeService()

Get node service

Returns:

NodeService node service

getCheckOutCheckInService

public CheckOutCheckInService getCheckOutCheckInService()

Get check out check in service

Returns:

CheckOutCheckInService check out check in service

getFileFolderService

public FileFolderService getFileFolderService()

Get file folder service

Returns:

FileFolderService file folder service

getPermissionService

public org.alfresco.service.cmr.security.PermissionService getPermissionService()

Get permission service

Returns:

PermissionService permission service

getAuthenticationService

public AuthenticationService getAuthenticationService()

Get authentication service

Returns:

AuthenticationService authentication service

getVersionService

public VersionService getVersionService()

Get version service

Returns:

VersionService version service

getLockService

public WebDAVLockService getLockService()

Get lock service

Returns:

LockService lock service

getContentService

public ContentService getContentService()

Get content service

Returns:

ContentService content service

getTransactionService

public TransactionService getTransactionService()

Get transaction service

Returns:

TransactionService transaction service

getDocumentHelper

public VtiDocumentHelper getDocumentHelper()

Get document helper

Returns:

VtiDocumentHelper document helper

getPathHelper

public VtiPathHelper getPathHelper()

Get path helper

Returns:

VtiPathHelper path helper

checkInDocument

public DocMetaInfo checkInDocument(String serviceName,
                                   String documentName,
                                   String comment,
                                   boolean keepCheckedOut,
                                   Date timeCheckedout,
                                   boolean validateWelcomeNames)

Description copied from interface: MethodHandler

Check in document method

Specified by:

checkInDocument in interface MethodHandler

Parameters:

serviceName - specifies the URL of the Web site that a method should act upon

documentName - the site-relative URL of the current document relative to the root directory of the Web site

comment - check-in comments

keepCheckedOut - used when source control is in use. true to check in the specified document to source control and immediately check it back out. false to only check the document in to source control.

timeCheckedout - the time and date at which the current object was last checked out

Returns:

DocMetaInfo a DocMetaInfo to source control

See Also:

MethodHandler.checkInDocument(java.lang.String, java.lang.String, java.lang.String, boolean, java.util.Date, boolean)

checkOutDocument

public DocMetaInfo checkOutDocument(String serviceName,
                                    String documentName,
                                    int force,
                                    int timeout,
                                    boolean validateWelcomeNames)

Description copied from interface: MethodHandler

Check out the file from a document library.

Specified by:

checkOutDocument in interface MethodHandler

Parameters:

serviceName - specifies the URL of the Web site that a method should act upon

documentName - the site-relative URL of the current document relative to the root directory of the Web site

force - parameter used with source control to undo check-out of a file that is checked out by some other user

timeout - Provides the number of seconds a short-term lock is reserved

Returns:

DocMetaInfo

See Also:

MethodHandler.checkOutDocument(java.lang.String, java.lang.String, int, int, boolean)

createDirectory

public boolean createDirectory(String serviceName,
                               DocMetaInfo dir)

Description copied from interface: MethodHandler

Creates a folder for the current Web site

Specified by:

createDirectory in interface MethodHandler

Parameters:

serviceName - specifies the URL of the Web site that a method should act upon

dir - url of the directory to created (DocMetaInfo)

Returns:

true if directory was created successfully, false otherwise

See Also:

MethodHandler.createDirectory(java.lang.String, org.alfresco.module.vti.metadata.model.DocMetaInfo)

getDocsMetaInfo

public DocsMetaInfo getDocsMetaInfo(String serviceName,
                                    boolean listHiddenDocs,
                                    boolean listLinkInfo,
                                    boolean validateWelcomeNames,
                                    List<String> urlList)

Description copied from interface: MethodHandler

Provides the server with the standard meta-information concerning the designated file

Specified by:

getDocsMetaInfo in interface MethodHandler

Parameters:

serviceName - specifies the URL of the Web site that a method should act upon

listHiddenDocs - true to list hidden documents in a Web site; otherwise, false

listLinkInfo - Specifies whether or not the return value of the method contains information about the links from the current page

urlList - the list of site-relative URLs

Returns:

DocMetaInfo

See Also:

MethodHandler.getDocsMetaInfo(java.lang.String, boolean, boolean, boolean, java.util.List)

getFileOpen

public DialogsMetaInfo getFileOpen(String siteUrl,
                                   String location,
                                   List<String> fileDialogFilterValue,
                                   String rootFolder,
                                   VtiSortField sortField,
                                   VtiSort sortDir,
                                   String view)

Description copied from interface: MethodHandler

Opens a view of the document libraries within a site, of a specific document library, or of a folder within a document library

Specified by:

getFileOpen in interface MethodHandler

Parameters:

siteUrl - specifies the server-relative URL of a site

location - specifies the site-relative URL of a document library or of a folder or file within a document library

fileDialogFilterValue - specifies the file type extension by which to filter the view in the file dialog box. For example, *.doc, *.txt, or *.htm

rootFolder - String

sortField - specify the name of the field on which to sort (VtiSortField)

sortDir - indicate an ascending (asc) or descending (desc) sort order (VtiSort)

view - String

Returns:

DialogsMetaInfo

See Also:

MethodHandler.getFileOpen(java.lang.String, java.lang.String, java.util.List, java.lang.String, org.alfresco.module.vti.metadata.dic.VtiSortField, org.alfresco.module.vti.metadata.dic.VtiSort, java.lang.String)

getServertimeZone

public String getServertimeZone()

Description copied from interface: MethodHandler

Get server time zone

Specified by:

getServertimeZone in interface MethodHandler

Returns:

server time zone

See Also:

MethodHandler.getServertimeZone()

getUserName

public String getUserName()

Description copied from interface: MethodHandler

Get user name

Specified by:

getUserName in interface MethodHandler

Returns:

user name

See Also:

MethodHandler.getUserName()

moveDocument

public DocsMetaInfo moveDocument(String serviceName,
                                 String oldURL,
                                 String newURL,
                                 List<String> urlList,
                                 EnumSet<RenameOption> renameOptionSet,
                                 EnumSet<PutOption> putOptionSet,
                                 boolean docopy,
                                 boolean validateWelcomeNames)

Description copied from interface: MethodHandler

Rename the selected document to the new name

Specified by:

moveDocument in interface MethodHandler

Parameters:

serviceName - specifies the URL of the Web site that a method should act upon

oldURL - the previous URL for a document that has changed names or directory location in the Web site

newURL - the new URL for a document that has changed names or directory locations in the Web site.

urlList - The list of site-relative URLs for the current method

renameOptionSet - parameter that specifies how links should handle to and from the new page.

putOptionSet - enables the server to overwrite an existing file if the value is set to overwrite and disallows overwrites if the value is set to edit

docopy - true to copy the file to the destination; false to move the file to the destination

validateWelcomeNames - boolean

Returns:

DocMetaInfo

See Also:

MethodHandler.moveDocument(java.lang.String, java.lang.String, java.lang.String, java.util.List, java.util.EnumSet, java.util.EnumSet, boolean, boolean)

putDocument

public DocMetaInfo putDocument(String serviceName,
                               Document document,
                               EnumSet<PutOption> putOptionSet,
                               String comment,
                               boolean keepCheckedOut,
                               boolean validateWelcomeNames)

Description copied from interface: MethodHandler

Writes a file to a directory in an existing Web site

Specified by:

putDocument in interface MethodHandler

Parameters:

serviceName - specifies the URL of the Web site that a method should act upon

document - document to create

putOptionSet - enables the server to overwrite an existing file if the value is set to overwrite and disallows overwrites if the value is set to edit

comment - provides a comment for the file being uploaded

keepCheckedOut - true to check in the specified document to source control and immediately check it back out. false to only check the document in to source control.

Returns:

DocMetaInfo

See Also:

MethodHandler.putDocument(java.lang.String, org.alfresco.module.vti.metadata.model.Document, java.util.EnumSet, java.lang.String, boolean, boolean)

removeDocuments

public DocsMetaInfo removeDocuments(String serviceName,
                                    List<String> urlList,
                                    List<Date> timeTokens,
                                    boolean validateWelcomeNames)

Description copied from interface: MethodHandler

Deletes the specified documents or folders from the Web site

Specified by:

removeDocuments in interface MethodHandler

Parameters:

serviceName - specifies the URL of the Web site that a method should act upon

urlList - the list of site-relative URLs for the current method

timeTokens - formerly contained a vector of time stamp values

Returns:

DocsMetaInfo

See Also:

MethodHandler.removeDocuments(java.lang.String, java.util.List, java.util.List, boolean)

setDocMetaInfo

public void setDocMetaInfo(FileInfo fileInfo,
                           DocMetaInfo docMetaInfo)

Sets metadata for docMetaInfo

Parameters:

fileInfo - file info for document, folder or working copy (FileInfo)

docMetaInfo - meta info (DocMetaInfo)

getDialogMetaInfo

protected DialogMetaInfo getDialogMetaInfo(FileInfo fileInfo)

Returns DialogMetaInfo for FileInfo

Parameters:

fileInfo - file info (FileInfo)

Returns:

DialogMetaInfo dialog meta info

checkout

public FileInfo checkout(FileInfo documentFileInfo,
                         int timeout)

Helper method for short-term or long-term checkouts

Parameters:

documentFileInfo - file info for document (FileInfo)

timeout - timeout in minutes for short-term checkout, if equals 0, then uses long-term checkout

Returns:

FileInfo checked out document file info

assertRemovableDocument

public static void assertRemovableDocument(DocumentStatus documentStatus)

Asserts "document with this status is removable"

Parameters:

documentStatus - document status (DocumentStatus)

assertFile

public static void assertFile(FileInfo fileFileInfo)
                       throws VtiHandlerException

Asserts "this file info of content node reference"

Parameters:

fileFileInfo - file info (FileInfo)

Throws:

VtiHandlerException - thrown if the file info isn't file file info

assertFolder

public static void assertFolder(FileInfo folderFileInfo)
                         throws VtiHandlerException

Asserts "this file info of folder node reference"

Parameters:

folderFileInfo - file info (FileInfo)

Throws:

VtiHandlerException - thrown if the file info isn't folder file info

assertValidFileInfo

public static void assertValidFileInfo(FileInfo fileInfo)
                                throws VtiHandlerException

Asserts "this file info isn't null"

Parameters:

fileInfo - file info (FileInfo)

Throws:

VtiHandlerException - thrown if the file info is null