org.alfresco.module.vti.handler

Interface MethodHandler

All Known Implementing Classes:

AbstractAlfrescoMethodHandler, AlfrescoMethodHandler

public interface MethodHandler

Front Page protocol fundamental API.

Author:

andreyak

Method Summary

Modifier and Type	Method and Description
DocMetaInfo	checkInDocument(String serviceName, String documentName, String comment, boolean keepCheckedOut, Date timeCheckedout, boolean validateWelcomeNames) Check in document method
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
String[]	decomposeURL(String url, String alfrescoContext) Decompose the URL into its parts, eg /foo/bar.doc -> { "foo", "bar.doc" }
boolean	existResource(HttpServletRequest request, HttpServletResponse response) Check on existing resource
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
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.
String	getServertimeZone() Get server time zone
String	getUserName() Get user name
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
void	putResource(HttpServletRequest request, HttpServletResponse response) Update the content of existing resource or create empty locked resource if it doesn't exist
DocsMetaInfo	removeDocuments(String serviceName, List<String> urlList, List<Date> timeTokens, boolean validateWelcomeNames) Deletes the specified documents or folders from the Web site
DocMetaInfo	uncheckOutDocument(String serviceName, String documentName, boolean force, Date timeCheckedOut, boolean rlsshortterm, boolean validateWelcomeNames) Undoes a check-out of a file.

Method Detail

getServertimeZone

String getServertimeZone()

Get server time zone

Returns:

server time zone

getListDocuments

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.

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

validateWelcomeNames -

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:

VtiMethodException - (VtiMethodException)

getDocument

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

Retrieves the specified document for viewing

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

createDirectory

boolean createDirectory(String serviceName,
                        DocMetaInfo dir)

Creates a folder for the current Web site

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

getUserName

String getUserName()

Get user name

Returns:

user name

checkOutDocument

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

Check out the file from a document library.

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

validateWelcomeNames -

Returns:

DocMetaInfo

checkInDocument

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

Check in document method

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

validateWelcomeNames -

Returns:

DocMetaInfo a DocMetaInfo to source control

uncheckOutDocument

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

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

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

validateWelcomeNames -

Returns:

DocMetaInfo

getDocsMetaInfo

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

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

validateWelcomeNames -

urlList - the list of site-relative URLs

Returns:

DocMetaInfo

decomposeURL

String[] decomposeURL(String url,
                      String alfrescoContext)

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

Parameters:

url - url to decompose

alfrescoContext - Alfresco Context

Returns:

decompose URL

existResource

boolean existResource(HttpServletRequest request,
                      HttpServletResponse response)

Check on existing resource

Parameters:

request - HTTP request

response - HTTP response

Returns:

true, if resource exists; otherwise, false

putResource

void putResource(HttpServletRequest request,
                 HttpServletResponse response)

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

Parameters:

request - HTTP request

response - HTTP response

removeDocuments

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

Deletes the specified documents or folders from the Web site

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

validateWelcomeNames -

Returns:

DocsMetaInfo

moveDocument

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

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

putDocument

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

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.

validateWelcomeNames -

Returns:

DocMetaInfo

getFileOpen

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

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