org.alfresco.module.vti.handler.alfresco

Class AlfrescoMethodHandler

java.lang.Object

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

org.alfresco.module.vti.handler.alfresco.AlfrescoMethodHandler

All Implemented Interfaces:

MethodHandler, ActivityPostProducer

public class AlfrescoMethodHandler
extends AbstractAlfrescoMethodHandler
implements ActivityPostProducer

Alfresco implementation of MethodHandler and AbstractAlfrescoMethodHandler

Author:

PavelYur

Constructor Summary

Constructors

Constructor and Description
AlfrescoMethodHandler()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	decomposeURL(String url, String alfrescoContext) Decompose the URL into its parts, eg /foo/bar.doc -> { "foo", "bar.doc" }
boolean	existResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Check on existing resource
org.alfresco.repo.security.authentication.AuthenticationComponent	getAuthenticationComponent() Get authentication component
WebDAVHelper	getDavHelper()
Document	getDocument(String serviceName, String documentName, boolean force, String docVersion, EnumSet<GetOption> getOptionSet, int timeout) Retrieves the specified document for viewing
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
DocsMetaInfo	getListDocuments(String serviceName, boolean listHiddenDocs, boolean listExplorerDocs, String platform, String initialURL, boolean listRecurse, boolean listLinkInfo, boolean listFolders, boolean listFiles, boolean listIncludeParent, boolean listDerived, boolean listBorders, boolean validateWelcomeNames, Map<String,Object> folderList, boolean listChildWebs) Provides a list of the files, folders, and subsites complete with meta-information for each file contained in the initialUrl parameter of the specified Web site.
ShareUtils	getShareUtils() Get share utils
org.alfresco.service.cmr.site.SiteService	getSiteService() Get site service
protected void	postActivity(String path, String siteId, String tenantDomain, boolean newlyCreated) Create an activity post.
void	putResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Update the content of existing resource or create empty locked resource if it doesn't exist
protected void	reportUploadEvent(String path, String siteId, String tenantDomain, boolean newlyCreated, String mimeType, long fileSize) TODO: may be expanded to a proper event handler with listener registration.
void	setActivityPoster(ActivityPoster activityPoster)
void	setAuthenticationComponent(org.alfresco.repo.security.authentication.AuthenticationComponent authenticationComponent) Set authentication component
void	setDavHelper(WebDAVHelper davHelper)
void	setDavService(org.alfresco.service.cmr.webdav.WebDavService davService)
void	setShareUtils(ShareUtils shareUtils) Set share utils
void	setSiteService(org.alfresco.service.cmr.site.SiteService siteService) Set site service
DocMetaInfo	uncheckOutDocument(String serviceName, String documentName, boolean force, Date timeCheckedOut, boolean rlsshortterm, boolean validateWelcomeNames) Undoes a check-out of a file.

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

assertFile, assertFolder, assertRemovableDocument, assertValidFileInfo, checkInDocument, checkout, checkOutDocument, createDirectory, getAuthenticationService, getCheckOutCheckInService, getContentService, getDialogMetaInfo, getDictionaryService, getDocsMetaInfo, getDocumentHelper, getFileFolderService, getLockService, getMimetypeService, getNodeService, getPathHelper, getPermissionService, getServertimeZone, getTransactionService, getUserName, getVersionService, moveDocument, putDocument, removeDocuments, setAuthenticationService, setCheckOutCheckInService, setContentService, setDictionaryService, setDocMetaInfo, setDocumentHelper, setFileFolderService, setMimetypeService, setNodeService, setPathHelper, setPermissionService, setTransactionService, setVersionService, setWebDAVLockService

Methods inherited from class java.lang.Object

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

Constructor Detail

AlfrescoMethodHandler

public AlfrescoMethodHandler()

Method Detail

setAuthenticationComponent

public void setAuthenticationComponent(org.alfresco.repo.security.authentication.AuthenticationComponent authenticationComponent)

Set authentication component

Parameters:

authenticationComponent - the authentication component to set (AuthenticationComponent)

getAuthenticationComponent

public org.alfresco.repo.security.authentication.AuthenticationComponent getAuthenticationComponent()

Get authentication component

Returns:

AuthenticationComponent the authentication component

setShareUtils

public void setShareUtils(ShareUtils shareUtils)

Set share utils

Parameters:

shareUtils - the share utils to set (ShareUtils)

getShareUtils

public ShareUtils getShareUtils()

Get share utils

Returns:

ShareUtils the share utils

setSiteService

public void setSiteService(org.alfresco.service.cmr.site.SiteService siteService)

Set site service

Parameters:

siteService - the site service to set (SiteService)

getSiteService

public org.alfresco.service.cmr.site.SiteService getSiteService()

Get site service

Returns:

SiteService the site service

decomposeURL

public String[] decomposeURL(String url,
                    String alfrescoContext)

Description copied from interface: MethodHandler

Decompose the URL into its parts, eg /foo/bar.doc -> { "foo", "bar.doc" }

Specified by:

decomposeURL in interface MethodHandler

Parameters:

url - url to decompose

alfrescoContext - Alfresco Context

Returns:

decompose URL

See Also:

MethodHandler.decomposeURL(java.lang.String, java.lang.String)

existResource

public boolean existResource(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)

Description copied from interface: MethodHandler

Check on existing resource

Specified by:

existResource in interface MethodHandler

Parameters:

request - HTTP request

response - HTTP response

Returns:

true, if resource exists; otherwise, false

See Also:

MethodHandler.existResource(HttpServletRequest, HttpServletResponse)

putResource

public void putResource(javax.servlet.http.HttpServletRequest request,
               javax.servlet.http.HttpServletResponse response)

Description copied from interface: MethodHandler

Update the content of existing resource or create empty locked resource if it doesn't exist

Specified by:

putResource in interface MethodHandler

Parameters:

request - HTTP request

response - HTTP response

See Also:

MethodHandler.putResource(HttpServletRequest, HttpServletResponse)

getDocument

public Document getDocument(String serviceName,
                   String documentName,
                   boolean force,
                   String docVersion,
                   EnumSet<GetOption> getOptionSet,
                   int timeout)

Description copied from interface: MethodHandler

Retrieves the specified document for viewing

Specified by:

getDocument 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

docVersion - version number other than the current version of a document

getOptionSet - specifies how documents are checked out from source control. The possible values are:

 <b>none</b>
                         Do not check out the file.
                     <b>chkoutExclusive</b>
                         Check out the file exclusively, which fails if the file is already checked out by another user.
                     <b>chkoutNonExclusive</b>
                         Check out the file non-exclusively, if the source control system in use is configured to allow non-exclusive check-outs.
 

timeout - provides the number of seconds a short-term lock is reserved. Within this time, the client computer must renew its lock to retain the lock

Returns:

Document

See Also:

MethodHandler.getDocument(java.lang.String, java.lang.String, boolean, java.lang.String, java.util.EnumSet, int)

getListDocuments

public DocsMetaInfo getListDocuments(String serviceName,
                            boolean listHiddenDocs,
                            boolean listExplorerDocs,
                            String platform,
                            String initialURL,
                            boolean listRecurse,
                            boolean listLinkInfo,
                            boolean listFolders,
                            boolean listFiles,
                            boolean listIncludeParent,
                            boolean listDerived,
                            boolean listBorders,
                            boolean validateWelcomeNames,
                            Map<String,Object> folderList,
                            boolean listChildWebs)
                              throws VtiHandlerException

Description copied from interface: MethodHandler

Provides a list of the files, folders, and subsites complete with meta-information for each file contained in the initialUrl parameter of the specified Web site.

Specified by:

getListDocuments 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

listExplorerDocs -

         <i>true</i> to generate a list of the task list files (_x_todo.xml and _x_todh.xml).
         <i>false</i>, no task list data is sent from the originating server
 

platform - identifies the operating system of the client

initialURL - URL of the folder from which to initially list documents or, if no folder is given, either "" or "/" to indicate the root folder of the Web site

listRecurse - specifies if recursively list the subfolders of the service_name Web site in the return value

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

listFolders - true to include the names and meta-information of the folders in the service_name Web site; otherwise, false

listFiles - true to list the metadata of files contained in each directory represented in the return code; otherwise, false

listIncludeParent - specifies whether or not return parent directory

listDerived - sending this parameter generates a list of files in _derived folders

listBorders - true to generate a list of contents of the _borders directory that contains shared border pages; otherwise, false

folderList - map contains folder URLs as keysr and a time stamp as values corresponding to the time the client computer last posted the list documents method to request a full list of the documents contained in that folder.

listChildWebs - true if folder represents a web site; otherwise, false

Returns:

DocsMetaInfo

Throws:

VtiHandlerException

See Also:

MethodHandler.getListDocuments(java.lang.String, boolean, boolean, java.lang.String, java.lang.String, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, java.util.Map, boolean)

uncheckOutDocument

public DocMetaInfo uncheckOutDocument(String serviceName,
                             String documentName,
                             boolean force,
                             Date timeCheckedOut,
                             boolean rlsshortterm,
                             boolean validateWelcomeNames)

Description copied from interface: MethodHandler

Undoes a check-out of a file. If the file changed since being checked out, this method causes those changes to be lost

Specified by:

uncheckOutDocument 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

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

rlsshortterm - true if there is a short-term lock on the file; otherwise, false

Returns:

DocMetaInfo

See Also:

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

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

Overrides:

getFileOpen in class AbstractAlfrescoMethodHandler

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

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

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

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)

reportUploadEvent

protected void reportUploadEvent(String path,
                     String siteId,
                     String tenantDomain,
                     boolean newlyCreated,
                     String mimeType,
                     long fileSize)
                          throws WebDAVServerException

TODO: may be expanded to a proper event handler with listener registration.

Throws:

WebDAVServerException

postActivity

protected void postActivity(String path,
                String siteId,
                String tenantDomain,
                boolean newlyCreated)
                     throws WebDAVServerException

Create an activity post.

Throws:

WebDAVServerException

setActivityPoster

public void setActivityPoster(ActivityPoster activityPoster)

Specified by:

setActivityPoster in interface ActivityPostProducer

setDavService

public void setDavService(org.alfresco.service.cmr.webdav.WebDavService davService)

setDavHelper

public void setDavHelper(WebDAVHelper davHelper)

getDavHelper

public WebDAVHelper getDavHelper()