org.apache.jackrabbit.webdav.jcr
Class VersionControlledItemCollection

java.lang.Object
  org.apache.jackrabbit.webdav.jcr.AbstractResource
      org.apache.jackrabbit.webdav.jcr.AbstractItemResource
          org.apache.jackrabbit.webdav.jcr.DefaultItemCollection
              org.apache.jackrabbit.webdav.jcr.VersionControlledItemCollection

All Implemented Interfaces:

org.apache.jackrabbit.webdav.DavResource, org.apache.jackrabbit.webdav.version.DeltaVResource, ItemResourceConstants, org.apache.jackrabbit.webdav.observation.ObservationResource, org.apache.jackrabbit.webdav.ordering.OrderingResource, org.apache.jackrabbit.webdav.search.SearchResource, org.apache.jackrabbit.webdav.transaction.TransactionResource, org.apache.jackrabbit.webdav.version.VersionableResource, org.apache.jackrabbit.webdav.version.VersionControlledResource

Direct Known Subclasses:

RootItemCollection

public class VersionControlledItemCollection

extends DefaultItemCollection

implements org.apache.jackrabbit.webdav.version.VersionControlledResource

VersionControlledItemCollection represents a JCR node item and covers all functionality related to versioning of Nodes.

See Also:

Node

Field Summary

Fields inherited from class org.apache.jackrabbit.webdav.jcr.DefaultItemCollection

initedProps, item, properties, supportedLock, supportedReports

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

AUTO_MERGE_SET, AUTO_VERSION, CHECKED_IN, CHECKED_OUT, CHECKIN_FORK, CHECKOUT_FORK, MERGE_SET, methods_checkedIn, methods_checkedOut, PREDECESSOR_SET, VERSION_HISTORY

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

COMPLIANCE_CLASS, METHODS

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

METHODS_INCL_MKWORKSPACE

Fields inherited from interface org.apache.jackrabbit.webdav.ordering.OrderingResource

COMPLIANCE_CLASS, METHODS

Fields inherited from interface org.apache.jackrabbit.webdav.jcr.ItemResourceConstants

ATTR_VALUE_TYPE, COMPLIANCE_CLASS, EXCLUSIVE_SESSION, JCR_DEFINITION, JCR_DEPTH, JCR_INDEX, JCR_ISMODIFIED, JCR_ISNEW, JCR_LENGTH, JCR_LENGTHS, JCR_MIXINNODETYPES, JCR_NAME, JCR_NAMESPACES, JCR_PARENT, JCR_PATH, JCR_PRIMARYITEM, JCR_PRIMARYNODETYPE, JCR_REFERENCES, JCR_TYPE, JCR_UUID, JCR_VALUE, JCR_VALUES, JCR_VERSIONABLEUUID, METHODS, NAMESPACE, ROOT_ITEM_PATH, VERSIONSTORAGE_PATH, XML_DESCRIPTOR, XML_DESCRIPTORKEY, XML_DESCRIPTORVALUE, XML_EXCLUSIVE_SESSION_SCOPED, XML_LENGTH, XML_NAMESPACE, XML_PREFIX, XML_PRIMARYNODETYPE, XML_RELPATH, XML_REMOVEEXISTING, XML_URI, XML_VALUE

Fields inherited from interface org.apache.jackrabbit.webdav.observation.ObservationResource

COMPLIANCE_CLASS, METHODS

Fields inherited from interface org.apache.jackrabbit.webdav.transaction.TransactionResource

COMPLIANCE_CLASS, METHODS

Fields inherited from interface org.apache.jackrabbit.webdav.search.SearchResource

COMPLIANCE_CLASS, METHODS

Constructor Summary

VersionControlledItemCollection(org.apache.jackrabbit.webdav.DavResourceLocator locator, JcrDavSession session, org.apache.jackrabbit.webdav.DavResourceFactory factory, Item item)
Create a new VersionControlledItemCollection.

Method Summary

void	addVersionControl() Adds version control to this resource.
org.apache.jackrabbit.webdav.MultiStatusResponse	alterProperties(org.apache.jackrabbit.webdav.property.DavPropertySet setProperties, org.apache.jackrabbit.webdav.property.DavPropertyNameSet removePropertyNames) Loops over the given Sets and alters the properties accordingly.
String	checkin() Calls Node.checkin() on the underlying repository node.
void	checkout() Calls Node.checkout() on the underlying repository node.
String	getSupportedMethods() Return a comma separated string listing the supported method names.
org.apache.jackrabbit.webdav.version.VersionHistoryResource	getVersionHistory() Returns the VersionHistory associated with the repository node.
protected void	initProperties() Fill the property set for this resource.
protected void	initSupportedReports() Define the set of reports supported by this resource.
void	label(org.apache.jackrabbit.webdav.version.LabelInfo labelInfo) Modify the labels present with the versions of this resource.
org.apache.jackrabbit.webdav.MultiStatus	merge(org.apache.jackrabbit.webdav.version.MergeInfo mergeInfo) Merge the repository node represented by this resource according to the information present in the given MergeInfo object.
void	uncheckout() Not implemented.
org.apache.jackrabbit.webdav.MultiStatus	update(org.apache.jackrabbit.webdav.version.UpdateInfo updateInfo) Perform an update on this resource.

Methods inherited from class org.apache.jackrabbit.webdav.jcr.DefaultItemCollection

addHrefProperty, addHrefProperty, addLockManager, addMember, addWorkspace, copy, createResourceFromLocator, exists, getCollection, getComplianceClass, getDisplayName, getFactory, getHref, getItemName, getLocator, getLocatorFromItem, getLocatorFromItemPath, getLock, getLocks, getMembers, getModificationTime, getOptionResponse, getProperties, getProperty, getPropertyNames, getQueryGrammerSet, getReferenceResources, getReport, getRepositorySession, getResourcePath, getSession, getStream, getTransactionId, getWorkspaceHref, hasLock, init, init, initLockSupport, isCollection, isLockable, isOrderable, lock, move, orderMembers, poll, refreshLock, removeMember, removeProperty, search, setProperty, spool, subscribe, unlock, unlock, unsubscribe

Methods inherited from class java.lang.Object

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

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, hasLock, isCollection, isLockable, lock, move, refreshLock, removeMember, removeProperty, setProperty, spool, unlock

Constructor Detail

VersionControlledItemCollection

public VersionControlledItemCollection(org.apache.jackrabbit.webdav.DavResourceLocator locator,
                                       JcrDavSession session,
                                       org.apache.jackrabbit.webdav.DavResourceFactory factory,
                                       Item item)

Create a new VersionControlledItemCollection.

Parameters:

locator -

session -

Method Detail

getSupportedMethods

public String getSupportedMethods()

Return a comma separated string listing the supported method names.

Specified by:

getSupportedMethods in interface org.apache.jackrabbit.webdav.DavResource

Overrides:

getSupportedMethods in class DefaultItemCollection

Returns:

the supported method names.

See Also:

DavResource.getSupportedMethods()

alterProperties

public org.apache.jackrabbit.webdav.MultiStatusResponse alterProperties(org.apache.jackrabbit.webdav.property.DavPropertySet setProperties,
                                                                        org.apache.jackrabbit.webdav.property.DavPropertyNameSet removePropertyNames)
                                                                 throws org.apache.jackrabbit.webdav.DavException

Description copied from class: DefaultItemCollection

Loops over the given Sets and alters the properties accordingly. Changes are persisted at the end according to the rules defined with the #complete() method.

Please note: since there is only a single property (ItemResourceConstants.JCR_MIXINNODETYPES that can be set or removed with PROPPATCH, this method either succeeds or throws an exception, even if this violates RFC 2518. Thus no property specific multistatus will be created in case of an error.

Specified by:

alterProperties in interface org.apache.jackrabbit.webdav.DavResource

Overrides:

alterProperties in class DefaultItemCollection

Parameters:

setProperties -

removePropertyNames -

Returns:

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

for additional description of non-compliant behaviour.

addVersionControl

public void addVersionControl()
                       throws org.apache.jackrabbit.webdav.DavException

Adds version control to this resource. If the resource is already under version control, this method has no effect.

Specified by:

addVersionControl in interface org.apache.jackrabbit.webdav.version.VersionableResource

Throws:

org.apache.jackrabbit.webdav.DavException - if this resource does not exist yet or if an error occurs while making the underlying node versionable.

See Also:

VersionableResource.addVersionControl()

checkin

public String checkin()
               throws org.apache.jackrabbit.webdav.DavException

Calls Node.checkin() on the underlying repository node.

Specified by:

checkin in interface org.apache.jackrabbit.webdav.version.VersionControlledResource

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

VersionControlledResource.checkin()

checkout

public void checkout()
              throws org.apache.jackrabbit.webdav.DavException

Calls Node.checkout() on the underlying repository node.

Specified by:

checkout in interface org.apache.jackrabbit.webdav.version.VersionControlledResource

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

VersionControlledResource.checkout()

uncheckout

public void uncheckout()
                throws org.apache.jackrabbit.webdav.DavException

Not implemented. Always throws a DavException with error code HttpServletResponse.SC_NOT_IMPLEMENTED.

Specified by:

uncheckout in interface org.apache.jackrabbit.webdav.version.VersionControlledResource

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

VersionControlledResource.uncheckout()

update

public org.apache.jackrabbit.webdav.MultiStatus update(org.apache.jackrabbit.webdav.version.UpdateInfo updateInfo)
                                                throws org.apache.jackrabbit.webdav.DavException

Perform an update on this resource. Depending on the format of the updateInfo this is translated to one of the following methods defined by the JCR API:

• Node.restore(javax.jcr.version.Version, boolean)
• Node.restore(javax.jcr.version.Version, String, boolean)
• Node.restoreByLabel(String, boolean)
• Workspace.restore(javax.jcr.version.Version[], boolean)
• Node.update(String)

Limitation: note that the MultiStatus returned by this method will not list any nodes that have been removed due to an Uuid conflict.

Specified by:

update in interface org.apache.jackrabbit.webdav.version.VersionControlledResource

Parameters:

updateInfo -

Returns:

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

VersionControlledResource.update(org.apache.jackrabbit.webdav.version.UpdateInfo)

merge

public org.apache.jackrabbit.webdav.MultiStatus merge(org.apache.jackrabbit.webdav.version.MergeInfo mergeInfo)
                                               throws org.apache.jackrabbit.webdav.DavException

Merge the repository node represented by this resource according to the information present in the given MergeInfo object.

Specified by:

merge in interface org.apache.jackrabbit.webdav.version.VersionControlledResource

Parameters:

mergeInfo -

Returns:

MultiStatus recording all repository items modified by this merge call as well as the resources that a client must modify to complete the merge (see RFC 3253)

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

VersionControlledResource.merge(org.apache.jackrabbit.webdav.version.MergeInfo), Node.merge(String, boolean)

label

public void label(org.apache.jackrabbit.webdav.version.LabelInfo labelInfo)
           throws org.apache.jackrabbit.webdav.DavException

Modify the labels present with the versions of this resource.

Specified by:

label in interface org.apache.jackrabbit.webdav.version.VersionControlledResource

Parameters:

labelInfo -

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

VersionHistory.addVersionLabel(String, String, boolean), VersionHistory.removeVersionLabel(String)

getVersionHistory

public org.apache.jackrabbit.webdav.version.VersionHistoryResource getVersionHistory()
                                                                              throws org.apache.jackrabbit.webdav.DavException

Returns the VersionHistory associated with the repository node. If the node is not versionable an exception is thrown.

Specified by:

getVersionHistory in interface org.apache.jackrabbit.webdav.version.VersionControlledResource

Returns:

the VersionHistoryResource associated with this resource.

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

VersionControlledResource.getVersionHistory(), Node.getVersionHistory()

initSupportedReports

protected void initSupportedReports()

Define the set of reports supported by this resource.

Overrides:

initSupportedReports in class DefaultItemCollection

See Also:

SupportedReportSetProperty

initProperties

protected void initProperties()

Fill the property set for this resource.

Overrides:

initProperties in class DefaultItemCollection