org.apache.jackrabbit.webdav.version

Interface DeltaVResource

All Superinterfaces:

DavResource

All Known Subinterfaces:

ActivityResource, BaselineResource, VersionableResource, VersionControlledResource, VersionHistoryResource, VersionResource, WorkspaceResource

All Known Implementing Classes:

DefaultItemCollection, DefaultItemResource, DeltaVResourceImpl, EventJournalResourceImpl, RootCollection, VersionControlledItemCollection, VersionControlledResourceImpl, VersionHistoryItemCollection, VersionHistoryResourceImpl, VersionItemCollection, VersionResourceImpl, WorkspaceResourceImpl

public interface DeltaVResource
extends DavResource

The DeltaVResource encapsulates the functionality common to all DeltaV compliant resources.

RFC 3253 defines the following required properties:

• DAV:comment
• DAV:creator-displayname
• DAV:supported-method-set
• DAV:supported-live-property-set
• DAV:supported-report-set
• all properties defined in WebDAV [RFC2518].

In addition a DeltaV compliant resource must support the following METHODS:

• REPORT
• all METHODS defined in WebDAV [RFC2518]
• all METHODS defined in HTTP/1.1 [RFC2616].

See Also:

DavResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHODS The generic deltaV compliant resource defines one additional method REPORT.
static String	METHODS_INCL_MKWORKSPACE If the server support the Workspace featured defined by RFC 3253 certain DeltaVResources may also support the MKWORKSPACE method.

Method Summary

Methods

Modifier and Type	Method and Description
void	addWorkspace(DavResource workspace) Add a new member to this resource, that represents a workspace. Please note that no resource must exist at the location of the new workspace.
OptionsResponse	getOptionResponse(OptionsInfo optionsInfo) Retrieves the information requested in the OPTIONS request body and returns the corresponding values.
DavResource[]	getReferenceResources(DavPropertyName hrefPropertyName) Returns an array of DavResource objects that are referenced by the HrefProperty with the specified name.
Report	getReport(ReportInfo reportInfo) Runs the report specified by the given ReportInfo.

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

addLockManager, addMember, 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

METHODS

static final String METHODS

The generic deltaV compliant resource defines one additional method REPORT.

See Also:

DavResource.METHODS, Constant Field Values

METHODS_INCL_MKWORKSPACE

static final String METHODS_INCL_MKWORKSPACE

If the server support the Workspace featured defined by RFC 3253 certain DeltaVResources may also support the MKWORKSPACE method.

See Also:

addWorkspace(DavResource), Constant Field Values

Method Detail

getOptionResponse

OptionsResponse getOptionResponse(OptionsInfo optionsInfo)

Retrieves the information requested in the OPTIONS request body and returns the corresponding values.

Parameters:

optionsInfo -

Returns:

object to be included to the OPTIONS response body or null if the specified optionsInfo was null or empty.

getReport

Report getReport(ReportInfo reportInfo)
                 throws DavException

Runs the report specified by the given ReportInfo.

Parameters:

reportInfo -

Returns:

the requested report.

Throws:

DavException - in case an error occurred or if the specified ReportInfo is either not valid or cannot be run by the given resource.

addWorkspace

void addWorkspace(DavResource workspace)
                  throws DavException

Add a new member to this resource, that represents a workspace.
Please note that no resource must exist at the location of the new workspace.

Parameters:

workspace - resource representing the new workspace to be created as member of this resource.

Throws:

DavException - if creating the new workspace fails.

getReferenceResources

DavResource[] getReferenceResources(DavPropertyName hrefPropertyName)
                                    throws DavException

Returns an array of DavResource objects that are referenced by the HrefProperty with the specified name.

Parameters:

hrefPropertyName -

Returns:

An array of DavResources

Throws:

DavException - if the given hrefPropertyName does point to an unknown property or does not represent the name of a href property. Finally the exception may be caused if the property contains the href of a non-existing resource, which cannot be resolved.

See Also:

HrefProperty