com.xpn.xwiki.plugin.webdav.resources.domain
Class DavPage

java.lang.Object
  com.xpn.xwiki.plugin.webdav.resources.partial.AbstractDavResource
      com.xpn.xwiki.plugin.webdav.resources.domain.DavPage

All Implemented Interfaces:

XWikiDavResource, org.apache.jackrabbit.webdav.DavResource

public class DavPage
extends AbstractDavResource

The collection resource which represents a page XWikiDocument of XWiki.

Version:

$Id: DavPage.java 32446 2010-11-04 08:55:46Z vmassol $

Field Summary

Fields inherited from class com.xpn.xwiki.plugin.webdav.resources.partial.AbstractDavResource

locator, name, parentResource

Fields inherited from interface com.xpn.xwiki.plugin.webdav.resources.XWikiDavResource

BASE_URI

Fields inherited from interface org.apache.jackrabbit.webdav.DavResource

COMPLIANCE_CLASS, METHODS

Constructor Summary

DavPage()

Method Summary

void	addMember(org.apache.jackrabbit.webdav.DavResource resource, org.apache.jackrabbit.webdav.io.InputContext inputContext)
boolean	createsCycle(java.lang.String childDocName) Utility method to verify that a member of this resource doesn't give rise to a cycle.
XWikiDavResource	decode(java.lang.String[] tokens, int next) The default decode implementation assumes the next resource in chain to be a temporary resource.
boolean	exists()
com.xpn.xwiki.doc.XWikiDocument	getDocument()
java.util.List<XWikiDavResource>	getInitMembers()
org.apache.jackrabbit.webdav.DavResourceIterator	getMembers()
long	getModificationTime()
void	init(XWikiDavResource parent, java.lang.String name, java.lang.String relativePath) Initializes this resource with common attributes inherited from the parent.
boolean	isCollection()
void	move(org.apache.jackrabbit.webdav.DavResource destination)
void	removeMember(org.apache.jackrabbit.webdav.DavResource member)
void	spool(org.apache.jackrabbit.webdav.io.OutputContext outputContext)

Methods inherited from class com.xpn.xwiki.plugin.webdav.resources.partial.AbstractDavResource

addLockManager, addVirtualMember, alterProperties, alterProperties, clearCache, copy, equals, getCollection, getComplianceClass, getContext, getDisplayName, getFactory, getHref, getLocator, getLock, getLocks, getProperties, getProperty, getPropertyNames, getResourcePath, getSession, getSupportedMethods, getVirtualMembers, getVirtualProperties, hashCode, hasLock, init, isLockable, isTempResource, lock, refreshLock, removeProperty, removeVirtualMember, setProperty, unlock

Methods inherited from class java.lang.Object

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

Constructor Detail

DavPage

public DavPage()

Method Detail

init

public void init(XWikiDavResource parent,
                 java.lang.String name,
                 java.lang.String relativePath)
          throws org.apache.jackrabbit.webdav.DavException

Initializes this resource with common attributes inherited from the parent.

Specified by:

init in interface XWikiDavResource

Overrides:

init in class AbstractDavResource

Parameters:

parent - Parent resource.

name - Name of this resource.

relativePath - Path relative to the parent resource.

Throws:

org.apache.jackrabbit.webdav.DavException - If the initialization fails.

decode

public XWikiDavResource decode(java.lang.String[] tokens,
                               int next)
                        throws org.apache.jackrabbit.webdav.DavException

The default decode implementation assumes the next resource in chain to be a temporary resource. Sub classes should override this method to provide their own implementation.

Specified by:

decode in interface XWikiDavResource

Overrides:

decode in class AbstractDavResource

Parameters:

tokens - segmented URL.

next - next index to be processed by this resource.

Returns:

the XWikiDavResource corresponding to the given URL.

Throws:

org.apache.jackrabbit.webdav.DavException - If it's not possible to decode the URL.

exists

public boolean exists()

getMembers

public org.apache.jackrabbit.webdav.DavResourceIterator getMembers()

addMember

public void addMember(org.apache.jackrabbit.webdav.DavResource resource,
                      org.apache.jackrabbit.webdav.io.InputContext inputContext)
               throws org.apache.jackrabbit.webdav.DavException

Throws:

org.apache.jackrabbit.webdav.DavException

removeMember

public void removeMember(org.apache.jackrabbit.webdav.DavResource member)
                  throws org.apache.jackrabbit.webdav.DavException

Throws:

org.apache.jackrabbit.webdav.DavException

move

public void move(org.apache.jackrabbit.webdav.DavResource destination)
          throws org.apache.jackrabbit.webdav.DavException

Throws:

org.apache.jackrabbit.webdav.DavException

getInitMembers

public java.util.List<XWikiDavResource> getInitMembers()

Specified by:

getInitMembers in interface XWikiDavResource

Overrides:

getInitMembers in class AbstractDavResource

Returns:

List of members that is added to the initial virtual member list.

isCollection

public boolean isCollection()

spool

public void spool(org.apache.jackrabbit.webdav.io.OutputContext outputContext)
           throws java.io.IOException

Throws:

java.io.IOException

getModificationTime

public long getModificationTime()

getDocument

public com.xpn.xwiki.doc.XWikiDocument getDocument()

Returns:

The document represented by this resource.

createsCycle

public boolean createsCycle(java.lang.String childDocName)

Utility method to verify that a member of this resource doesn't give rise to a cycle.

Parameters:

childDocName - Name of the want-to-be-member resource.

Returns:

True if the childPageName has occured before, false otherwise.