org.alfresco.repo.webdav

Class PropPatchMethod

java.lang.Object

org.alfresco.repo.webdav.WebDAVMethod

org.alfresco.repo.webdav.PropFindMethod

org.alfresco.repo.webdav.PropPatchMethod

Direct Known Subclasses:

PropPatchMethod

public class PropPatchMethod
extends PropFindMethod

Implements the WebDAV PROPPATCH method

Author:

Ivan Rybnikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PropPatchMethod.PropertyAction Stores information about PROPPATCH action(set or remove) an according property.

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

WebDAVMethod.Condition

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<PropPatchMethod.PropertyAction>	m_propertyActions

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

FIND_PROPS, GET_ALL_PROPS, GET_NAMED_PROPS, m_mode, m_namespaces, m_properties

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

logger, 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
PropPatchMethod()

Method Summary

Modifier and Type	Method and Description
protected WebDAVProperty	createProperty(Node node) Creates a WebDAVProperty from the given XML node
protected void	executeImpl() Execute the main WebDAV request processing
protected void	generateError(org.dom4j.io.XMLWriter xml) Generates the error tag
protected void	generatePropertyResponse(org.dom4j.io.XMLWriter xml, WebDAVProperty property, int status, String description) Generates the XML response for a PROPFIND request that asks for a list of all known properties
protected void	generateResponseImpl() Does nothing unless overridden - for reasons of backwards compatibility.
protected boolean	isReadOnly() Override and return true if the method is a query method only.
protected void	parseRequestBody() Parse the request body
protected void	parseRequestHeaders() Parse the request headers
protected void	patchProperties(FileInfo nodeInfo, String path)

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

generateAllPropertiesResponse, generateFindPropertiesResponse, generateLockDiscoveryResponse, generateResponseForNode, getMode, getXMLOutputFormat, loadDeadProperties, persistDeadProperties, writeLockTypes

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

checkNode, checkNode, createXMLWriter, execute, flushXML, generateLockDiscoveryXML, generateLockDiscoveryXML, generateNamespaceDeclarations, 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, parseDepthHeader, parseIfHeader, setDetails, shouldFlushXMLWriter, toString

Methods inherited from class java.lang.Object

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

Field Detail

m_propertyActions

protected ArrayList<PropPatchMethod.PropertyAction> m_propertyActions

Constructor Detail

PropPatchMethod

public PropPatchMethod()

Method Detail

isReadOnly

protected boolean isReadOnly()

Description copied from class: WebDAVMethod

Override and return true if the method is a query method only. The default implementation returns false.

Overrides:

isReadOnly in class PropFindMethod

Returns:

Returns false always

executeImpl

protected void executeImpl()
                    throws WebDAVServerException,
                           Exception

Description copied from class: PropFindMethod

Execute the main WebDAV request processing

Overrides:

executeImpl in class PropFindMethod

Throws:

WebDAVServerException - a general server exception

Exception - any unhandled exception

generateResponseImpl

protected void generateResponseImpl()
                             throws Exception

Description copied from class: WebDAVMethod

Does nothing unless overridden - for reasons of backwards compatibility. Subclasses implementing this method should separate the WebDAV method execution logic from response generation logic. Execution logic should be contained in the WebDAVMethod.executeImpl() method and should NOT contain any code that writes to the response. Conversely response generation logic should NOT contain any code relating to the desired effect of the WebDAV method (e.g. setting properties on a node) and should be contained purely within this method.

Older methods, until refactored will not override this method, relying only on WebDAVMethod.executeImpl().

Overrides:

generateResponseImpl in class WebDAVMethod

Throws:

Exception

parseRequestBody

protected void parseRequestBody()
                         throws WebDAVServerException

Parse the request body

Overrides:

parseRequestBody in class PropFindMethod

Throws:

WebDAVServerException

parseRequestHeaders

protected void parseRequestHeaders()
                            throws WebDAVServerException

Parse the request headers

Overrides:

parseRequestHeaders in class PropFindMethod

Throws:

WebDAVServerException

createProperty

protected WebDAVProperty createProperty(Node node)

Creates a WebDAVProperty from the given XML node

Overrides:

createProperty in class PropFindMethod

patchProperties

protected void patchProperties(FileInfo nodeInfo,
                               String path)
                        throws WebDAVServerException

Throws:

WebDAVServerException

generatePropertyResponse

protected void generatePropertyResponse(org.dom4j.io.XMLWriter xml,
                                        WebDAVProperty property,
                                        int status,
                                        String description)

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

Parameters:

xml - XMLWriter

property - WebDAVProperty

status - int

description - String

generateError

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

Generates the error tag

Parameters:

xml - XMLWriter