com.xpn.xwiki.plugin.webdav.resources
Interface XWikiDavResource

All Superinterfaces:

org.apache.jackrabbit.webdav.DavResource

All Known Implementing Classes:

AbstractDavFile, AbstractDavResource, AbstractDavView, AttachmentsByFirstLettersSubView, AttachmentsBySpaceNameSubView, AttachmentsView, DavAttachment, DavPage, DavTempFile, DavWikiFile, HomeView, OrphansView, PagesByFirstLettersSubView, PagesBySpaceNameSubView, PagesView, RootView, WhatsnewView

public interface XWikiDavResource
extends org.apache.jackrabbit.webdav.DavResource

The super interface for all xwiki related dav resources. Adds extra xwiki specific methods for the basic DavResource.

Version:

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

Field Summary

static java.lang.String

BASE_URI This URI segment is used as the base workspace name.

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

COMPLIANCE_CLASS, METHODS

Method Summary

void	clearCache() Removes everything belonging to this resource from the cache.
XWikiDavResource	decode(java.lang.String[] tokens, int next) Method responsible for recursively decoding a URL which has been split into segments ("/").
XWikiDavContext	getContext()
java.util.List<XWikiDavResource>	getInitMembers()
java.util.List<XWikiDavResource>	getVirtualMembers()
org.apache.jackrabbit.webdav.property.DavPropertySet	getVirtualProperties()
void	init(java.lang.String name, org.apache.jackrabbit.webdav.DavResourceLocator locator, XWikiDavContext context) Initializes this resource with the given parameters.
void	init(XWikiDavResource parent, java.lang.String name, java.lang.String relativePath) Initializes this resource with common attributes inherited from the parent.

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

addLockManager, addMember, alterProperties, alterProperties, copy, exists, getCollection, getComplianceClass, getDisplayName, getFactory, getHref, getLocator, getLock, getLocks, getMembers, getModificationTime, getProperties, getProperty, getPropertyNames, getResourcePath, getSession, getSupportedMethods, hasLock, isCollection, isLockable, lock, move, refreshLock, removeMember, removeProperty, setProperty, spool, unlock

Field Detail

BASE_URI

static final java.lang.String BASE_URI

This URI segment is used as the base workspace name.

See Also:

Constant Field Values

Method Detail

init

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.

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.

init

void init(java.lang.String name,
          org.apache.jackrabbit.webdav.DavResourceLocator locator,
          XWikiDavContext context)
          throws org.apache.jackrabbit.webdav.DavException

Initializes this resource with the given parameters.

Parameters:

name - Name of this resource.

locator - Dav resource locator.

context - XWiki dav context.

Throws:

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

decode

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

Method responsible for recursively decoding a URL which has been split into segments ("/"). The 'next' variable points to that URL segment (within tokens array) representing the next resource in chain.

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.

getVirtualMembers

java.util.List<XWikiDavResource> getVirtualMembers()

Returns:

List of virtual members for this resource.

getVirtualProperties

org.apache.jackrabbit.webdav.property.DavPropertySet getVirtualProperties()

Returns:

Set of virtual properties for this resource.

getInitMembers

java.util.List<XWikiDavResource> getInitMembers()

Returns:

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

clearCache

void clearCache()

Removes everything belonging to this resource from the cache.

getContext

XWikiDavContext getContext()

Returns:

The XWikiDavContext for this resource.