org.apache.jackrabbit.webdav.version
Interface DeltaVConstants

All Known Implementing Classes:

ExpandPropertyReport, LabelInfo, LocateByHistoryReport, MergeInfo, OptionsResponse, ReportType, SupportedMethodSetProperty, UpdateInfo, VersionTreeReport

public interface DeltaVConstants

DeltaVConstants defines the following headers and properties required for any resource that is complient to RFC 3253:

Headers:

 Label
 

Properties:

 DAV:comment
 DAV:creator-displayname
 DAV:supported-method-set
 DAV:supported-live-property-set
 DAV:supported-report-set
 

Some additional resource properties are defined by the various advanced version features:

 DAV:workspace (workspace feature)
 DAV:version-controlled-configuration (baseline)
 

Field Summary

static String	ATTR_NAME 'DAV:name' attribute for the property element
static String	ATTR_NAMESPACE 'DAV:namespace' attribute for the property element
static DavPropertyName	COMMENT The "DAV:comment" property is used to track a brief comment about a resource that is suitable for presentation to a user.
static DavPropertyName	CREATOR_DISPLAYNAME The "DAV:creator-displayname" property contains a description of the creator of the resource that is suitable for presentation to a user.
static String	HEADER_LABEL For certain METHODS, if the request-URL identifies a version-controlled resource, a label can be specified in a LabelInfo request header to cause the method to be applied to the version selected by that label.
static String	HEADER_LOCATION Location header as defined by RFC 2616.
static Namespace	NAMESPACE The DAV: namespace.
static DavPropertyName	SUPPORTED_LIVE_PROPERTY_SET Required protected live property for any resources being complient with RFC 3253.
static DavPropertyName	SUPPORTED_METHOD_SET Required protected live property for any resources being complient with RFC 3253.
static DavPropertyName	SUPPORTED_REPORT_SET Protected "supported-report-set" property identifies the reports that are supported by the resource.
static DavPropertyName	VERSION_CONTROLLED_CONFIGURATION The Baseline feature introduces the computed DAV:version-controlled-configuration property for all resources that are member of a version-controlled configuration.
static DavPropertyName	WORKSPACE Protected "workspace" property indicating the workspace of a resource.
static String	XML_ACTIVITY Xml elements
static String	XML_ACTIVITY_COLLECTION_SET A DAV:workspace-collection-set element may be included in the OPTIONS request body to identify collections that may contain activity resources.
static String	XML_BASELINE
static String	XML_CHECKOUT Value for the DAV:auto-version property indicating that any modification (such as PUT/PROPPATCH) applied to a checked-in version-controlled resource will automatically be preceded by a checkout operation.
static String	XML_CHECKOUT_CHECKIN Value for the DAV:auto-version property indicating that any modification (such as PUT/PROPPATCH) applied to a checked-in version-controlled resource will automatically be preceded by a checkout and followed by a checkin operation.
static String	XML_CHECKOUT_UNLOCK_CHECKIN Value for the DAV:auto-version property indicating that any modification (such as PUT/PROPPATCH) applied to a checked-in version-controlled resource will automatically be preceded by a checkout operation.
static String	XML_EXPAND_PROPERTY Top element for the 'DAV:expand-property' report
static String	XML_LABEL Xml element representing the mandatory root element of a LABEL request body.
static String	XML_LABEL_ADD
static String	XML_LABEL_NAME
static String	XML_LABEL_REMOVE
static String	XML_LABEL_SET
static String	XML_LOCATE_BY_HISTORY Top element for the 'DAV:locate-by-history' report
static String	XML_LOCKED_CHECKIN Value for the DAV:auto-version property indicating that any modification (such as PUT/PROPPATCH) applied to a write-locked checked-in version-controlled resource will automatically be preceded by a checkout operation.
static String	XML_MERGE
static String	XML_N0_AUTO_MERGE
static String	XML_N0_CHECKOUT
static String	XML_OPTIONS If the OPTIONS request contains a body, i must start with an DAV:options element.
static String	XML_OPTIONS_RESPONSE If an XML response body for a successful request is included, it must be a DAV:options-response XML element.
static String	XML_PROPERTY 'DAV:property' element to be used inside the 'DAV:expand-property' element.
static String	XML_REPORT Name of Xml child elements of XML_SUPPORTED_REPORT.
static String	XML_SUPPORTED_METHOD
static String	XML_SUPPORTED_REPORT Name of Xml element contained in the SUPPORTED_REPORT_SET property.
static String	XML_UPDATE Xml element defining the top element in the UPDATE request body.
static String	XML_VERSION
static String	XML_VERSION_HISTORY
static String	XML_VERSION_HISTORY_SET 'DAV:version-history-set' to be used inside the 'DAV:locate-by-history' element
static String	XML_VERSION_TREE Top element for the 'DAV:version-tree' report
static String	XML_VH_COLLECTION_SET A DAV:version-history-collection-set element may be included in the OPTIONS request body to identify collections that may contain version history resources.
static String	XML_WORKSPACE
static String	XML_WSP_COLLECTION_SET A DAV:workspace-collection-set element may be included in the OPTIONS request body to identify collections that may contain workspace resources.

Field Detail

NAMESPACE

static final Namespace NAMESPACE

The DAV: namespace.

HEADER_LABEL

static final String HEADER_LABEL

For certain METHODS, if the request-URL identifies a version-controlled resource, a label can be specified in a LabelInfo request header to cause the method to be applied to the version selected by that label.
LabelInfo header MUST have no effect on a request whose request-URL does not identify a version-controlled resource. In particular, it MUST have no effect on a request whose request-URL identifies a version or a version history.

See Also:

Constant Field Values

HEADER_LOCATION

static final String HEADER_LOCATION

Location header as defined by RFC 2616. In the versioning context it is used to indicate the location of the new version created by a successful checkin in the response.

From RFC 2616:
The Location response-header field is used to redirect the recipient to a location other than the Request-URI for completion of the request or identification of a new resource.
For 201 (Created) responses, the Location is that of the new resource which was created by the request.

See Also:

Constant Field Values

COMMENT

static final DavPropertyName COMMENT

The "DAV:comment" property is used to track a brief comment about a resource that is suitable for presentation to a user. The DAV:comment of a version can be used to indicate why that version was created.

CREATOR_DISPLAYNAME

static final DavPropertyName CREATOR_DISPLAYNAME

The "DAV:creator-displayname" property contains a description of the creator of the resource that is suitable for presentation to a user. The DAV:creator-displayname of a version can be used to indicate who created that version.

SUPPORTED_METHOD_SET

static final DavPropertyName SUPPORTED_METHOD_SET

Required protected live property for any resources being complient with RFC 3253. Clients should classify a resource by examing the values of the DAV:supported-method-set and DAV:supported-live-property-set properties of that resource.
Property structure:

 <!ELEMENT supported-method-set (supported-method*)>
 <!ELEMENT supported-method ANY>
 <!ATTLIST supported-method name NMTOKEN #REQUIRED>
 name value: a method name
 

See Also:

SUPPORTED_LIVE_PROPERTY_SET

SUPPORTED_LIVE_PROPERTY_SET

static final DavPropertyName SUPPORTED_LIVE_PROPERTY_SET

Required protected live property for any resources being complient with RFC 3253. Clients should classify a resource by examing the values of the DAV:supported-method-set and DAV:supported-live-property-set properties of that resource.
Property structure:

 <!ELEMENT supported-live-property-set (supported-live-property*)>
 <!ELEMENT supported-live-property name>
 <!ELEMENT prop ANY>
 ANY value: a property element type
 

See Also:

SUPPORTED_METHOD_SET

SUPPORTED_REPORT_SET

static final DavPropertyName SUPPORTED_REPORT_SET

Protected "supported-report-set" property identifies the reports that are supported by the resource.

See Also:

SUPPORTED_REPORT_SET

WORKSPACE

static final DavPropertyName WORKSPACE

Protected "workspace" property indicating the workspace of a resource. This property is required for all resources if (but only if) the workspace feature is supported.

Note that the DAV:activity-version-set represents a HrefProperty. It is defined to have the following format:

 <!ELEMENT workspace (href)>
 

See Also:

WorkspaceResource

VERSION_CONTROLLED_CONFIGURATION

static final DavPropertyName VERSION_CONTROLLED_CONFIGURATION

The Baseline feature introduces the computed DAV:version-controlled-configuration property for all resources that are member of a version-controlled configuration. This may be the case if the resource is a collection under baseline control or is a member of a collection under baseline control.

Note that the DAV:activity-version-set represents a HrefProperty. It is defined to have the following format:

 <!ELEMENT version-controlled-configuration (href)>
 

XML_ACTIVITY

static final String XML_ACTIVITY

Xml elements

See Also:

Constant Field Values

XML_BASELINE

static final String XML_BASELINE

See Also:

Constant Field Values

XML_SUPPORTED_METHOD

static final String XML_SUPPORTED_METHOD

See Also:

Constant Field Values

XML_VERSION_HISTORY

static final String XML_VERSION_HISTORY

See Also:

Constant Field Values

XML_VERSION

static final String XML_VERSION

See Also:

Constant Field Values

XML_WORKSPACE

static final String XML_WORKSPACE

See Also:

Constant Field Values

XML_OPTIONS

static final String XML_OPTIONS

If the OPTIONS request contains a body, i must start with an DAV:options element.

See Also:

OptionsInfo, XML_VH_COLLECTION_SET, XML_WSP_COLLECTION_SET, XML_ACTIVITY_COLLECTION_SET, Constant Field Values

XML_OPTIONS_RESPONSE

static final String XML_OPTIONS_RESPONSE

If an XML response body for a successful request is included, it must be a DAV:options-response XML element.

See Also:

OptionsResponse, Constant Field Values

XML_VH_COLLECTION_SET

static final String XML_VH_COLLECTION_SET

A DAV:version-history-collection-set element may be included in the OPTIONS request body to identify collections that may contain version history resources.
The response body for a successful request must in consequence contain a DAV:version-history-collection-set element identifying collections that may contain version histories. An identified collection may be the root collection of a tree of collections, all of which may contain version histories.

 <!ELEMENT version-history-collection-set (href*)>
 

See Also:

Constant Field Values

XML_WSP_COLLECTION_SET

static final String XML_WSP_COLLECTION_SET

A DAV:workspace-collection-set element may be included in the OPTIONS request body to identify collections that may contain workspace resources.
The response body for a successful request must contain a DAV:workspace-collection-set element identifying collections that may contain workspaces. An identified collection may be the root collection of a tree of collections, all of which may contain workspaces.

 <!ELEMENT workspace-collection-set (href*)>
 

See Also:

Constant Field Values

XML_ACTIVITY_COLLECTION_SET

static final String XML_ACTIVITY_COLLECTION_SET

A DAV:workspace-collection-set element may be included in the OPTIONS request body to identify collections that may contain activity resources.
The response body for a successful request must contain a DAV:workspace-collection-set element identifying collections that may contain activity resources. An identified collection may be the root collection of a tree of collections, all of which may contain activity resources.

 <!ELEMENT activity-collection-set (href*)>
 

See Also:

Constant Field Values

XML_SUPPORTED_REPORT

static final String XML_SUPPORTED_REPORT

Name of Xml element contained in the SUPPORTED_REPORT_SET property.

See Also:

SUPPORTED_REPORT_SET, SupportedReportSetProperty, Constant Field Values

XML_REPORT

static final String XML_REPORT

Name of Xml child elements of XML_SUPPORTED_REPORT.

See Also:

SupportedReportSetProperty, Constant Field Values

XML_VERSION_TREE

static final String XML_VERSION_TREE

Top element for the 'DAV:version-tree' report

See Also:

Constant Field Values

XML_EXPAND_PROPERTY

static final String XML_EXPAND_PROPERTY

Top element for the 'DAV:expand-property' report

See Also:

Constant Field Values

XML_PROPERTY

static final String XML_PROPERTY

'DAV:property' element to be used inside the 'DAV:expand-property' element.

See Also:

XML_EXPAND_PROPERTY, Constant Field Values

ATTR_NAME

static final String ATTR_NAME

'DAV:name' attribute for the property element

See Also:

XML_PROPERTY, Constant Field Values

ATTR_NAMESPACE

static final String ATTR_NAMESPACE

'DAV:namespace' attribute for the property element

See Also:

XML_PROPERTY, Constant Field Values

XML_LOCATE_BY_HISTORY

static final String XML_LOCATE_BY_HISTORY

Top element for the 'DAV:locate-by-history' report

See Also:

Constant Field Values

XML_VERSION_HISTORY_SET

static final String XML_VERSION_HISTORY_SET

'DAV:version-history-set' to be used inside the 'DAV:locate-by-history' element

See Also:

XML_LOCATE_BY_HISTORY, Constant Field Values

XML_LABEL

static final String XML_LABEL

Xml element representing the mandatory root element of a LABEL request body.

See Also:

XML_LABEL_NAME, XML_LABEL_ADD, XML_LABEL_REMOVE, XML_LABEL_SET, LabelInfo, Constant Field Values

XML_LABEL_NAME

static final String XML_LABEL_NAME

See Also:

Constant Field Values

XML_LABEL_ADD

static final String XML_LABEL_ADD

See Also:

Constant Field Values

XML_LABEL_REMOVE

static final String XML_LABEL_REMOVE

See Also:

Constant Field Values

XML_LABEL_SET

static final String XML_LABEL_SET

See Also:

Constant Field Values

XML_UPDATE

static final String XML_UPDATE

Xml element defining the top element in the UPDATE request body. RFC 3253 defines the following structure for the 'update' element.

 <!ELEMENT update ANY>
 ANY value: A sequence of elements with at most one DAV:version element
 and at most one DAV:prop element.
 <!ELEMENT version (href)>
 prop: see RFC 2518, Section 12.11
 

See Also:

Constant Field Values

XML_CHECKOUT_CHECKIN

static final String XML_CHECKOUT_CHECKIN

Value for the DAV:auto-version property indicating that any modification (such as PUT/PROPPATCH) applied to a checked-in version-controlled resource will automatically be preceded by a checkout and followed by a checkin operation.
See also RFC 3253 DAV:auto-version

See Also:

Constant Field Values

XML_CHECKOUT_UNLOCK_CHECKIN

static final String XML_CHECKOUT_UNLOCK_CHECKIN

Value for the DAV:auto-version property indicating that any modification (such as PUT/PROPPATCH) applied to a checked-in version-controlled resource will automatically be preceded by a checkout operation. If the resource is not write-locked, the request is automatically followed by a checkin operation.
See also RFC 3253 DAV:auto-version

See Also:

Constant Field Values

XML_CHECKOUT

static final String XML_CHECKOUT

Value for the DAV:auto-version property indicating that any modification (such as PUT/PROPPATCH) applied to a checked-in version-controlled resource will automatically be preceded by a checkout operation.
See also RFC 3253 DAV:auto-version

See Also:

Constant Field Values

XML_LOCKED_CHECKIN

static final String XML_LOCKED_CHECKIN

Value for the DAV:auto-version property indicating that any modification (such as PUT/PROPPATCH) applied to a write-locked checked-in version-controlled resource will automatically be preceded by a checkout operation.
See also RFC 3253 DAV:auto-version

See Also:

Constant Field Values

XML_MERGE

static final String XML_MERGE

See Also:

Constant Field Values

XML_N0_AUTO_MERGE

static final String XML_N0_AUTO_MERGE

See Also:

Constant Field Values

XML_N0_CHECKOUT

static final String XML_N0_CHECKOUT

See Also:

Constant Field Values