org.alfresco.module.vti.web.fp

Class PropfindMethod

java.lang.Object

org.alfresco.repo.webdav.WebDAVMethod

org.alfresco.module.vti.web.fp.PropfindMethod

public class PropfindMethod
extends WebDAVMethod

Class for handling PROPFIND method of the MS-WDVME protocol.

MS Office client may send 3 variant of the PROPFIND method.

• 1. 'MS-Doclib' header with value '1' presents in request.
• 2. 'Depth' header with value '0' presents in request.
• 3. 'Depth' header with value 'infinity' presents in request.

All this possible situations are handled by this class.

Author:

PavelYur

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.repo.webdav.WebDAVMethod

WebDAVMethod.Condition

Field Summary

Fields inherited from class org.alfresco.repo.webdav.WebDAVMethod

m_childToParent, m_conditions, m_davHelper, m_depth, m_parentLockInfo, m_request, m_resourceTag, m_response, m_rootNodeRef, m_strPath, m_userAgent

Constructor Summary

Constructors

Constructor and Description
PropfindMethod(VtiPathHelper pathHelper, UrlHelper urlHelper)

Method Summary

Modifier and Type	Method and Description
protected void	executeImpl() Handle PROPFIND method of the MS-WDVME protocol.
protected void	generateAllPropertiesResponse(org.dom4j.io.XMLWriter xml, FileInfo nodeInfo, boolean isDir) Generates the XML response for a PROPFIND request that asks for all known properties
protected void	generateFakeLockDiscoveryResponseForWorkingCopy(org.dom4j.io.XMLWriter xml, org.alfresco.service.cmr.repository.NodeRef node, boolean isDir) Generates the XML response snippet showing the fake lock information for the given path
protected void	generateLockDiscoveryResponse(org.dom4j.io.XMLWriter xml, FileInfo nodeInfo, boolean isDir) Generates the XML response snippet showing the lock information for the given path
protected void	generateResponseForNode(org.dom4j.io.XMLWriter xml, FileInfo nodeInfo, String path) Generates the required response XML for the current node
protected org.dom4j.io.OutputFormat	getXMLOutputFormat() Returns the format required for an XML response.
protected void	parseRequestBody() Parse the request body
protected void	parseRequestHeaders() Parse the request headers
protected void	writeLockTypes(org.dom4j.io.XMLWriter xml) Output the supported lock types XML element

Methods inherited from class org.alfresco.repo.webdav.WebDAVMethod

checkNode, checkNode, createXMLWriter, execute, flushXML, generateLockDiscoveryXML, generateLockDiscoveryXML, generateNamespaceDeclarations, generateResponseImpl, getActionService, getAuthenticationService, getContentService, getContextPath, getDAVHelper, getDAVLockService, getDepth, getFileFolderService, getMimetypeService, getNamespaceService, getNodeForPath, getNodeLockInfo, getNodeService, getPath, getPermissionService, getRequestBodyAsDocument, getRootNodeRef, getSearchService, getServiceRegistry, getServletPath, getSiteId, getStatusForAccessDeniedException, getTenantDomain, getTransactionService, getURLForPath, getWorkingCopy, isReadOnly, parseDepthHeader, parseIfHeader, setDetails, shouldFlushXMLWriter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PropfindMethod

public PropfindMethod(VtiPathHelper pathHelper,
                      UrlHelper urlHelper)

Method Detail

executeImpl

protected void executeImpl()
                    throws WebDAVServerException,
                           Exception

Handle PROPFIND method of the MS-WDVME protocol.

• 1. If MS-Doclib header with value '1' presents in request it check for library existing and return the MS-Doclib header in response with value of the valid URL that is point to the library that resource belongs to.
• 2. If Depth header in request has a value '0' returns properties for the requested resource.
• 3. If Depth header in request has a value 'infinity' (requested resources should be collection) returns properties for the requested resource and all resources that are stored in requested collection.

In case if requested resource was not found then HTTP 404 status is sent to the client.

Specified by:

executeImpl in class WebDAVMethod

Throws:

WebDAVServerException - a general server exception

Exception - any unhandled exception

generateResponseForNode

protected void generateResponseForNode(org.dom4j.io.XMLWriter xml,
                                       FileInfo nodeInfo,
                                       String path)
                                throws Exception

Generates the required response XML for the current node

Parameters:

xml - XMLWriter

nodeInfo - FileInfo

path - String

Throws:

Exception

generateAllPropertiesResponse

protected void generateAllPropertiesResponse(org.dom4j.io.XMLWriter xml,
                                             FileInfo nodeInfo,
                                             boolean isDir)
                                      throws Exception

Generates the XML response for a PROPFIND request that asks for all known properties

Parameters:

xml - XMLWriter

nodeInfo - FileInfo

isDir - boolean

Throws:

Exception

generateLockDiscoveryResponse

protected void generateLockDiscoveryResponse(org.dom4j.io.XMLWriter xml,
                                             FileInfo nodeInfo,
                                             boolean isDir)
                                      throws Exception

Generates the XML response snippet showing the lock information for the given path

Parameters:

xml - XMLWriter

nodeInfo - FileInfo

isDir - boolean

Throws:

Exception

generateFakeLockDiscoveryResponseForWorkingCopy

protected void generateFakeLockDiscoveryResponseForWorkingCopy(org.dom4j.io.XMLWriter xml,
                                                               org.alfresco.service.cmr.repository.NodeRef node,
                                                               boolean isDir)
                                                        throws Exception

Generates the XML response snippet showing the fake lock information for the given path

Parameters:

xml - XMLWriter

node - NodeRef

isDir - boolean

Throws:

Exception

writeLockTypes

protected void writeLockTypes(org.dom4j.io.XMLWriter xml)

Output the supported lock types XML element

Parameters:

xml - XMLWriter

parseRequestHeaders

protected void parseRequestHeaders()
                            throws WebDAVServerException

Parse the request headers

Specified by:

parseRequestHeaders in class WebDAVMethod

Throws:

WebDAVServerException

parseRequestBody

protected void parseRequestBody()
                         throws WebDAVServerException

Parse the request body

Specified by:

parseRequestBody in class WebDAVMethod

Throws:

WebDAVServerException

getXMLOutputFormat

protected org.dom4j.io.OutputFormat getXMLOutputFormat()

Description copied from class: WebDAVMethod

Returns the format required for an XML response. This may vary per method.

Overrides:

getXMLOutputFormat in class WebDAVMethod