org.alfresco.module.vti.handler.alfresco

Class AlfrescoVersionsServiceHandler

java.lang.Object

org.alfresco.module.vti.handler.alfresco.AlfrescoVersionsServiceHandler

All Implemented Interfaces:

VersionsServiceHandler

public class AlfrescoVersionsServiceHandler
extends Object
implements VersionsServiceHandler

Alfresco implementation of VersionsServiceHandler interface

Author:

PavelYur

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.service.cmr.model.FileFolderService	fileFolderService
protected static org.apache.commons.logging.Log	logger
protected org.alfresco.service.cmr.repository.NodeService	nodeService
protected VtiPathHelper	pathHelper
protected org.alfresco.service.transaction.TransactionService	transactionService
protected org.alfresco.service.cmr.version.VersionService	versionService

Constructor Summary

Constructors

Constructor and Description
AlfrescoVersionsServiceHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertDocument(org.alfresco.service.cmr.model.FileInfo documentFileInfo) Asserts file info for existent document
List<DocumentVersionBean>	deleteAllVersions(String fileName) Do a "SharePoint Delete All Versions", which isn't the same as a normal Alfresco delete version history
List<DocumentVersionBean>	deleteVersion(String fileName, String fileVersion) Deletes the specified file version
protected DocumentVersionBean	getDocumentVersionInfo(org.alfresco.service.cmr.model.FileInfo documentFileInfo) Get document version bean for document without version history
protected DocumentVersionBean	getDocumentVersionInfo(org.alfresco.service.cmr.version.Version version, String id) Get document version bean by version
protected List<DocumentVersionBean>	getVersions(org.alfresco.service.cmr.model.FileInfo documentFileInfo) Returns DocumentVersionBean list for file info
List<DocumentVersionBean>	getVersions(String fileName) Returns information about the versions of the specified file
boolean	isVersionable(String fileName) Is the specified file name a versioned file?
String	makeCurrentVersionURL(String host, String context, String dws, String fileName)
String	makeDocumentDetailsURL(String host, String context, String dws, String fileName)
String	makeVersionURL(String host, String context, String dws, DocumentVersionBean version)
List<DocumentVersionBean>	restoreVersion(String fileName, String fileVersion) Restores the specified file version
void	setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService) Set file folder service
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set node service
void	setPathHelper(VtiPathHelper pathHelper) Set path helper
void	setTransactionService(org.alfresco.service.transaction.TransactionService transactionService) Set transaction service
void	setVersionService(org.alfresco.service.cmr.version.VersionService versionService) Set version service

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.apache.commons.logging.Log logger

nodeService

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

fileFolderService

protected org.alfresco.service.cmr.model.FileFolderService fileFolderService

versionService

protected org.alfresco.service.cmr.version.VersionService versionService

transactionService

protected org.alfresco.service.transaction.TransactionService transactionService

pathHelper

protected VtiPathHelper pathHelper

Constructor Detail

AlfrescoVersionsServiceHandler

public AlfrescoVersionsServiceHandler()

Method Detail

setNodeService

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

Set node service

Parameters:

nodeService - the node service to set (NodeService)

setFileFolderService

public void setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)

Set file folder service

Parameters:

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

setVersionService

public void setVersionService(org.alfresco.service.cmr.version.VersionService versionService)

Set version service

Parameters:

versionService - the version service to set (VersionService)

setTransactionService

public void setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)

Set transaction service

Parameters:

transactionService - the transaction service to set (TransactionService)

setPathHelper

public void setPathHelper(VtiPathHelper pathHelper)

Set path helper

Parameters:

pathHelper - the path helper to set (VtiPathHelper)

getVersions

public List<DocumentVersionBean> getVersions(String fileName)
                                      throws org.alfresco.service.cmr.model.FileNotFoundException

Description copied from interface: VersionsServiceHandler

Returns information about the versions of the specified file

Specified by:

getVersions in interface VersionsServiceHandler

Parameters:

fileName - A string that contains the site-relative URL of the file in the form Folder_Name/File_Name

Returns:

List information about the versions of the specified file

Throws:

org.alfresco.service.cmr.model.FileNotFoundException

See Also:

VersionsServiceHandler.getVersions(java.lang.String)

restoreVersion

public List<DocumentVersionBean> restoreVersion(String fileName,
                                       String fileVersion)

Description copied from interface: VersionsServiceHandler

Restores the specified file version

Specified by:

restoreVersion in interface VersionsServiceHandler

Parameters:

fileName - site relative url to the file

fileVersion - file version to restore

Returns:

List list of DocumentVersion beans

See Also:

VersionsServiceHandler.restoreVersion(java.lang.String, java.lang.String)

deleteVersion

public List<DocumentVersionBean> deleteVersion(String fileName,
                                      String fileVersion)
                                        throws org.alfresco.service.cmr.model.FileNotFoundException,
                                               org.alfresco.service.cmr.version.VersionDoesNotExistException

Description copied from interface: VersionsServiceHandler

Deletes the specified file version

Specified by:

deleteVersion in interface VersionsServiceHandler

Parameters:

fileName - site relative url to the file

fileVersion - file version to restore

Returns:

List list of DocumentVersion beans

Throws:

org.alfresco.service.cmr.model.FileNotFoundException

org.alfresco.service.cmr.version.VersionDoesNotExistException

See Also:

VersionsServiceHandler.deleteVersion(java.lang.String, java.lang.String)

deleteAllVersions

public List<DocumentVersionBean> deleteAllVersions(String fileName)
                                            throws org.alfresco.service.cmr.model.FileNotFoundException

Do a "SharePoint Delete All Versions", which isn't the same as a normal Alfresco delete version history

Specified by:

deleteAllVersions in interface VersionsServiceHandler

Returns:

DocumentVersionBean current document

Throws:

org.alfresco.service.cmr.model.FileNotFoundException

See Also:

VersionsServiceHandler.deleteAllVersions(java.lang.String)

assertDocument

protected void assertDocument(org.alfresco.service.cmr.model.FileInfo documentFileInfo)

Asserts file info for existent document

Parameters:

documentFileInfo - document file info (FileInfo)

getVersions

protected List<DocumentVersionBean> getVersions(org.alfresco.service.cmr.model.FileInfo documentFileInfo)

Returns DocumentVersionBean list for file info

Parameters:

documentFileInfo - file info (FileInfo)

Returns:

List list of DocumentVersionBean

getDocumentVersionInfo

protected DocumentVersionBean getDocumentVersionInfo(org.alfresco.service.cmr.version.Version version,
                                         String id)

Get document version bean by version

Parameters:

version - version (Version)

id - the file id

Returns:

DocumentVersionBean version bean

getDocumentVersionInfo

protected DocumentVersionBean getDocumentVersionInfo(org.alfresco.service.cmr.model.FileInfo documentFileInfo)

Get document version bean for document without version history

Parameters:

documentFileInfo - document file info (FileInfo)

Returns:

DocumentVersionBean document version bean

isVersionable

public boolean isVersionable(String fileName)

Description copied from interface: VersionsServiceHandler

Is the specified file name a versioned file?

Specified by:

isVersionable in interface VersionsServiceHandler

Returns:

true if versionable, false otherwise.

makeCurrentVersionURL

public String makeCurrentVersionURL(String host,
                           String context,
                           String dws,
                           String fileName)

Specified by:

makeCurrentVersionURL in interface VersionsServiceHandler

makeVersionURL

public String makeVersionURL(String host,
                    String context,
                    String dws,
                    DocumentVersionBean version)

Specified by:

makeVersionURL in interface VersionsServiceHandler

makeDocumentDetailsURL

public String makeDocumentDetailsURL(String host,
                            String context,
                            String dws,
                            String fileName)

Specified by:

makeDocumentDetailsURL in interface VersionsServiceHandler