org.apache.jackrabbit.webdav.version

Interface VersionResource

All Superinterfaces:

DavResource, DeltaVResource

All Known Subinterfaces:

BaselineResource

All Known Implementing Classes:

VersionItemCollection, VersionResourceImpl

public interface VersionResource
extends DeltaVResource

VersionResource is a resource that contains a copy of a particular state of a version-controlled resource. A new version resource is created whenever a checked-out version-controlled resource is checked-in. The server allocates a distinct new URL for each new version, and this URL will never be used to identify any resource other than that version. The content and dead properties of a version never change.

RFC 3253 defines the following required properties for a version resource:

• DAV:predecessor-set (protected)
• DAV:successor-set (computed)
• DAV:checkout-set
• DAV:version-name
• DAV:checkout-fork (in-place-checkout or working resource)
• DAV:checkin-fork (in-place-checkout or working resource)
• DAV:version-history (version-history)
• DAV:label-name-set (label)
• DAV:activity-set (activity)
• all DeltaV-compliant resource properties.

If the 'Version-Controlled-Collection Feature' is supported (see section 14 of RFC 3253) the following protected property is defined for a version resource associated with a version-controlled collection.

• DAV:version-controlled-binding-set

In addition a version resource must support the following METHODS:

• LABEL (label)
• CHECKOUT (working-resource)
• all DeltaV-compliant resource METHODS.

See Also:

DeltaVResource

Field Summary

Fields

Modifier and Type	Field and Description
static DavPropertyName	ACTIVITY_SET DAV:activity-set is a required property for a version resource, if the server supports the activity feature. It identifies the activities that determine to which logical changes this version contributes, and on which lines of descent this version appears.
static DavPropertyName	CHECKIN_FORK This property controls the behavior of CHECKIN when a version already has a successor.
static DavPropertyName	CHECKOUT_FORK This property controls the behavior of CHECKOUT when a version already is checked out or has a successor.
static DavPropertyName	CHECKOUT_SET The computed property DAV:checkout-set identifies each checked-out resource whose DAV:checked-out property identifies this version. The property is defined to have the following format:
static DavPropertyName	LABEL_NAME_SET Required protected property 'DAV:label-name-set' for a version of a webdav resource introduced with the 'LabelInfo' feature.
static String	METHODS The version resource defines one additional method LABEL.
static DavPropertyName	PREDECESSOR_SET The protected DAV:predecessor property identifies each predecessor of this version.
static DavPropertyName	SUCCESSOR_SET The computed property DAV:successor-set identifies each version whose DAV:predecessor-set identifies this version. The property is defined to have the following format:
static DavPropertyName	VERSION_CONTROLLED_BINDING_SET If the 'Version-Controlled-Collection Feature' is supported the DAV:version-controlled-binding-set property identifies the name and the version history of all version-controlled internal members of the collection this version resource belongs to.
static DavPropertyName	VERSION_HISTORY The computed property DAV:version-history identifies the version history that contains this version. The property is defined to have the following format:
static DavPropertyName	VERSION_NAME The protected property DAV:version-name defines a human readable id for this version.

Fields inherited from interface org.apache.jackrabbit.webdav.version.DeltaVResource

METHODS_INCL_MKWORKSPACE

Method Summary

Methods

Modifier and Type	Method and Description
VersionHistoryResource	getVersionHistory() Returns the VersionHistoryResource, that is referenced in the DAV:version-history property.
void	label(LabelInfo labelInfo) Modify the labels of this version resource.

Methods inherited from interface org.apache.jackrabbit.webdav.version.DeltaVResource

addWorkspace, getOptionResponse, getReferenceResources, getReport

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 version resource defines one additional method LABEL.

See Also:

DeltaVResource.METHODS, DavResource.METHODS, Constant Field Values

LABEL_NAME_SET

static final DavPropertyName LABEL_NAME_SET

Required protected property 'DAV:label-name-set' for a version of a webdav resource introduced with the 'LabelInfo' feature. This property contains the labels that currently select this version.
Property structure is defined as follows:

 <!ELEMENT label-name-set (label-name*)>
 <!ELEMENT label-name (#PCDATA)>
 PCDATA value: string
 

PREDECESSOR_SET

static final DavPropertyName PREDECESSOR_SET

The protected DAV:predecessor property identifies each predecessor of this version. Except for the root version, which has no predecessors, each version has at least one predecessor.
The property is defined to have the following format:

 <!ELEMENT predecessor-set (href*)>
 

SUCCESSOR_SET

static final DavPropertyName SUCCESSOR_SET

The computed property DAV:successor-set identifies each version whose DAV:predecessor-set identifies this version.
The property is defined to have the following format:

 <!ELEMENT successor-set (href*)>
 

CHECKOUT_SET

static final DavPropertyName CHECKOUT_SET

The computed property DAV:checkout-set identifies each checked-out resource whose DAV:checked-out property identifies this version.
The property is defined to have the following format:

 <!ELEMENT checkout-set (href*)>
 

See Also:

VersionControlledResource.CHECKED_OUT

VERSION_NAME

static final DavPropertyName VERSION_NAME

The protected property DAV:version-name defines a human readable id for this version. The id defined to be unique within the version-history this version belongs to.
The property is defined to have the following format:

 <!ELEMENT version-name (#PCDATA)>
 PCDATA value: string
 

VERSION_HISTORY

static final DavPropertyName VERSION_HISTORY

The computed property DAV:version-history identifies the version history that contains this version.
The property is defined to have the following format:

 <!ELEMENT version-history (href)>
 

CHECKOUT_FORK

static final DavPropertyName CHECKOUT_FORK

This property controls the behavior of CHECKOUT when a version already is checked out or has a successor.

CHECKIN_FORK

static final DavPropertyName CHECKIN_FORK

This property controls the behavior of CHECKIN when a version already has a successor.

ACTIVITY_SET

static final DavPropertyName ACTIVITY_SET

DAV:activity-set is a required property for a version resource, if the server supports the activity feature.
It identifies the activities that determine to which logical changes this version contributes, and on which lines of descent this version appears. A server MAY restrict the DAV:activity-set to identify a single activity. A server MAY refuse to allow the value of the DAV:activity-set property of a version to be modified.

The property is defined to have the following format:

 <!ELEMENT activity-set (href*)>
 

Note that the DAV:activity-set represents a HrefProperty

VERSION_CONTROLLED_BINDING_SET

static final DavPropertyName VERSION_CONTROLLED_BINDING_SET

If the 'Version-Controlled-Collection Feature' is supported the DAV:version-controlled-binding-set property identifies the name and the version history of all version-controlled internal members of the collection this version resource belongs to.

This property is defined to have the following format:

 <!ELEMENT version-controlled-binding-set (version-controlled-binding*)>
 <!ELEMENT version-controlled-binding (binding-name, version-history)>
 <!ELEMENT binding-name (#PCDATA)>
 PCDATA value: URL segment
 <!ELEMENT version-history (href)>
 

See Also:

VersionControlledResource.ECLIPSED_SET

Method Detail

label

void label(LabelInfo labelInfo)
           throws DavException

Modify the labels of this version resource. The modifications (SET, ADD or REMOVE) are listed in the specified LabelInfo object.
The case of a label name must be preserved when it is stored and retrieved.
If the type of modification is ADD, then the label must not yet occur on any other version within the same version history. In contrast a SET modification will move the indicated label to this version, if it existed with another version before. After a successful LABEL request the label must not appear with any other version in the same version history.

Parameters:

labelInfo -

Throws:

DavException

See Also:

LabelInfo

getVersionHistory

VersionHistoryResource getVersionHistory()
                                         throws DavException

Returns the VersionHistoryResource, that is referenced in the DAV:version-history property.

Returns:

Throws:

DavException