Package org.apache.jackrabbit.webdav.jcr

Class VersionControlledItemCollection

  • All Implemented Interfaces:
    org.apache.jackrabbit.commons.webdav.JcrRemotingConstants, org.apache.jackrabbit.webdav.DavResource, 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.DeltaVResource, org.apache.jackrabbit.webdav.version.VersionableResource, org.apache.jackrabbit.webdav.version.VersionControlledResource
    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 
      Modifier and Type Field Description
      protected boolean initedProps  
      protected Item item  
      protected org.apache.jackrabbit.webdav.property.DavPropertyNameSet names  
      protected org.apache.jackrabbit.webdav.property.DavPropertySet properties  
      protected org.apache.jackrabbit.webdav.lock.SupportedLock supportedLock  
      protected org.apache.jackrabbit.webdav.version.report.SupportedReportSetProperty supportedReports  

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

        METHODS

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

        METHODS, METHODS_INCL_MKWORKSPACE

      • Fields inherited from interface org.apache.jackrabbit.commons.webdav.JcrRemotingConstants

        ATTR_VALUE_TYPE, IMPORT_UUID_BEHAVIOR, JCR_DEFINITION_LN, JCR_DEPTH_LN, JCR_GET_STRING_LN, JCR_INDEX_LN, JCR_ISMODIFIED_LN, JCR_ISNEW_LN, JCR_LENGTH_LN, JCR_LENGTHS_LN, JCR_MIXINNODETYPES_LN, JCR_NAME_LN, JCR_NAMESPACES_LN, JCR_NODETYPES_CND_LN, JCR_PARENT_LN, JCR_PATH_LN, JCR_PRIMARYITEM_LN, JCR_PRIMARYNODETYPE_LN, JCR_QUERY_RESULT_LN, JCR_REFERENCES_LN, JCR_SELECTOR_NAME_LN, JCR_TYPE_LN, JCR_UUID_LN, JCR_VALUE_LN, JCR_VALUES_LN, JCR_VERSIONABLEUUID_LN, JCR_WEAK_REFERENCES_LN, JCR_WORKSPACE_NAME_LN, NS_PREFIX, NS_URI, RELATION_REMOTE_SESSION_ID, RELATION_USER_DATA, REPORT_EXPORT_VIEW, REPORT_LOCATE_BY_UUID, REPORT_LOCATE_CORRESPONDING_NODE, REPORT_NODETYPES, REPORT_PRIVILEGES, REPORT_REGISTERED_NAMESPACES, REPORT_REPOSITORY_DESCRIPTORS, ROOT_ITEM_PATH, ROOT_ITEM_RESOURCEPATH, VERSIONSTORAGE_PATH, XML_ALLOWUPDATE, XML_CND, XML_DESCRIPTOR, XML_DESCRIPTORKEY, XML_DESCRIPTORVALUE, XML_EXCLUSIVE_SESSION_SCOPED, XML_LENGTH, XML_NAMESPACE, XML_NODETYPENAME, XML_PREFIX, XML_PRIMARYNODETYPE, XML_QUERY_RESULT_COLUMN, XML_RELPATH, XML_REMOVEEXISTING, XML_URI, XML_VALUE

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

        METHODS

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

        METHODS

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

        METHODS

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

        METHODS

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

        METHODS

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

        ACTIVITY_SET, AUTO_MERGE_SET, AUTO_VERSION, BASELINE_CONTROLLED_COLLECTION, CHECKED_IN, CHECKED_OUT, CHECKIN_FORK, CHECKOUT_FORK, ECLIPSED_SET, MERGE_SET, methods_checkedIn, methods_checkedOut, PREDECESSOR_SET, SUBBASELINE_SET, UNRESERVED, VERSION_HISTORY

    • Constructor Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addLockManager​(org.apache.jackrabbit.webdav.lock.LockManager lockMgr)  
      void addVersionControl()
      Adds version control to this resource.
      void addWorkspace​(org.apache.jackrabbit.webdav.DavResource workspace)
      The JCR api does not provide methods to create new workspaces.
      org.apache.jackrabbit.webdav.MultiStatusResponse alterProperties​(List<? extends org.apache.jackrabbit.webdav.property.PropEntry> changeList)
      Loops over the given Lists 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.
      void copy​(org.apache.jackrabbit.webdav.DavResource destination, boolean shallow)
      Copies the underlying repository item to the indicated destination.
      protected org.apache.jackrabbit.webdav.DavResource createResourceFromLocator​(org.apache.jackrabbit.webdav.DavResourceLocator loc)
      Create a new DavResource from the given locator.
      boolean exists()
      Returns true if there exists a repository item with the given resource path, false otherwise.
      org.apache.jackrabbit.webdav.DavResource getCollection()
      Returns the resource representing the parent item of the repository item represented by this resource.
      String getDisplayName()
      Retrieves the last segment of the item path (or the resource path if this resource does not exist).
      org.apache.jackrabbit.webdav.DavResourceFactory getFactory()  
      String getHref()  
      protected static String getItemName​(String itemPath)
      Retrieves the last segment of the given path and removes the index if present.
      org.apache.jackrabbit.webdav.DavResourceLocator getLocator()  
      protected org.apache.jackrabbit.webdav.DavResourceLocator getLocatorFromItem​(Item repositoryItem)
      Build a new DavResourceLocator from the given repository item.
      protected org.apache.jackrabbit.webdav.DavResourceLocator getLocatorFromItemPath​(String itemPath)
      Build a DavResourceLocator from the given itemPath path.
      org.apache.jackrabbit.webdav.lock.ActiveLock[] getLocks()  
      org.apache.jackrabbit.webdav.version.OptionsResponse getOptionResponse​(org.apache.jackrabbit.webdav.version.OptionsInfo optionsInfo)  
      org.apache.jackrabbit.webdav.property.DavPropertySet getProperties()  
      org.apache.jackrabbit.webdav.property.DavProperty<?> getProperty​(org.apache.jackrabbit.webdav.property.DavPropertyName name)  
      org.apache.jackrabbit.webdav.property.DavPropertyName[] getPropertyNames()  
      org.apache.jackrabbit.webdav.search.QueryGrammerSet getQueryGrammerSet()  
      org.apache.jackrabbit.webdav.DavResource[] getReferenceResources​(org.apache.jackrabbit.webdav.property.DavPropertyName hrefPropertyName)
      Return an array of DavResource objects that are referenced by the property with the specified name.
      org.apache.jackrabbit.webdav.version.report.Report getReport​(org.apache.jackrabbit.webdav.version.report.ReportInfo reportInfo)  
      protected Session getRepositorySession()
      Shortcut for getSession().getRepositorySession()
      String getResourcePath()
      Returns the path of the underlying repository item or the item to be created (PUT/MKCOL).
      org.apache.jackrabbit.webdav.DavSession getSession()  
      String getSupportedMethods()
      Return a comma separated string listing the supported method names.
      String getTransactionId()  
      org.apache.jackrabbit.webdav.version.VersionHistoryResource getVersionHistory()
      Returns the VersionHistory associated with the repository node.
      protected String getWorkspaceHref()
      Retrieve the href of the workspace the current session belongs to.
      void init​(org.apache.jackrabbit.webdav.observation.SubscriptionManager subsMgr)  
      void init​(org.apache.jackrabbit.webdav.transaction.TxLockManager txMgr, String transactionId)  
      protected void initProperties()
      Fill the property set for this resource.
      protected void initPropertyNames()
      Property names common to all resources.
      protected void initSupportedReports()
      Define the set of reports supported by this resource.
      boolean isLockable​(org.apache.jackrabbit.webdav.lock.Type type, org.apache.jackrabbit.webdav.lock.Scope scope)
      Returns true, if the SupportedLock property contains an entry with the given type and scope.
      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 move​(org.apache.jackrabbit.webdav.DavResource destination)
      Moves the underlying repository item to the indicated destination.
      protected String normalizeResourceHref​(String href)
      Normalize the resource href.
      org.apache.jackrabbit.webdav.observation.EventDiscovery poll​(String subscriptionId, long timeout)  
      org.apache.jackrabbit.webdav.MultiStatus search​(org.apache.jackrabbit.webdav.search.SearchInfo sInfo)  
      org.apache.jackrabbit.webdav.observation.Subscription subscribe​(org.apache.jackrabbit.webdav.observation.SubscriptionInfo info, String subscriptionId)  
      void uncheckout()
      Not implemented.
      void unlock​(String lockToken, org.apache.jackrabbit.webdav.transaction.TransactionInfo tInfo)  
      void unsubscribe​(String subscriptionId)  
      org.apache.jackrabbit.webdav.MultiStatus update​(org.apache.jackrabbit.webdav.version.UpdateInfo updateInfo)
      Perform an update on this resource.

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

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

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

        addWorkspace, getOptionResponse, getReferenceResources, getReport

    • Field Detail

      • item

        protected final Item item

      • initedProps

        protected boolean initedProps

      • properties

        protected org.apache.jackrabbit.webdav.property.DavPropertySet properties

      • names

        protected org.apache.jackrabbit.webdav.property.DavPropertyNameSet names

      • supportedLock

        protected org.apache.jackrabbit.webdav.lock.SupportedLock supportedLock

      • supportedReports

        protected org.apache.jackrabbit.webdav.version.report.SupportedReportSetProperty supportedReports

    • 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 -
        factory -
        item -

    • 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()

      • getProperty

        public org.apache.jackrabbit.webdav.property.DavProperty<?> getProperty​(org.apache.jackrabbit.webdav.property.DavPropertyName name)
        Specified by:
        getProperty in interface org.apache.jackrabbit.webdav.DavResource
        Overrides:
        getProperty in class DefaultItemCollection
        See Also:
        DavResource.getProperty(org.apache.jackrabbit.webdav.property.DavPropertyName)

      • alterProperties

        public org.apache.jackrabbit.webdav.MultiStatusResponse alterProperties​(List<? extends org.apache.jackrabbit.webdav.property.PropEntry> changeList)
                                                                 throws org.apache.jackrabbit.webdav.DavException
        Description copied from class: DefaultItemCollection
        Loops over the given Lists and alters the properties accordingly. Changes are persisted at the end according to the rules defined with the AbstractItemResource.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:
        changeList -
        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:

        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

      • exists

        public boolean exists()
        Returns true if there exists a repository item with the given resource path, false otherwise.
        Specified by:
        exists in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        DavResource.exists()

      • getDisplayName

        public String getDisplayName()
        Retrieves the last segment of the item path (or the resource path if this resource does not exist). An item path is in addition first translated to the corresponding resource path.
        NOTE: the display name is not equivalent to item name which is exposed with the {http://www.day.com/jcr/webdav/1.0}name property.
        Specified by:
        getDisplayName in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        DavResource.getDisplayName()

      • getCollection

        public org.apache.jackrabbit.webdav.DavResource getCollection()
        Returns the resource representing the parent item of the repository item represented by this resource. If this resoure represents the root item a RootCollection is returned.
        Specified by:
        getCollection in interface org.apache.jackrabbit.webdav.DavResource
        Returns:
        the collection this resource is internal member of. Except for the repository root, the returned collection always represent the parent repository node.
        See Also:
        DavResource.getCollection()

      • move

        public void move​(org.apache.jackrabbit.webdav.DavResource destination)
          throws org.apache.jackrabbit.webdav.DavException
        Moves the underlying repository item to the indicated destination.
        Specified by:
        move in interface org.apache.jackrabbit.webdav.DavResource
        Parameters:
        destination -
        Throws:
        org.apache.jackrabbit.webdav.DavException
        See Also:
        DavResource.move(DavResource), Session.move(String, String)

      • copy

        public void copy​(org.apache.jackrabbit.webdav.DavResource destination,
                 boolean shallow)
          throws org.apache.jackrabbit.webdav.DavException
        Copies the underlying repository item to the indicated destination. If the locator of the specified destination resource indicates a different workspace, Workspace.copy(String, String, String) is used to perform the copy operation, Workspace.copy(String, String) otherwise.

        Note, that this implementation does not support shallow copy.

        Specified by:
        copy in interface org.apache.jackrabbit.webdav.DavResource
        Parameters:
        destination -
        shallow -
        Throws:
        org.apache.jackrabbit.webdav.DavException
        See Also:
        DavResource.copy(DavResource, boolean), Workspace.copy(String, String), Workspace.copy(String, String, String)

      • init

        public void init​(org.apache.jackrabbit.webdav.observation.SubscriptionManager subsMgr)
        Specified by:
        init in interface org.apache.jackrabbit.webdav.observation.ObservationResource
        See Also:
        ObservationResource.init(SubscriptionManager)

      • subscribe

        public org.apache.jackrabbit.webdav.observation.Subscription subscribe​(org.apache.jackrabbit.webdav.observation.SubscriptionInfo info,
                                                                       String subscriptionId)
                                                                throws org.apache.jackrabbit.webdav.DavException
        Specified by:
        subscribe in interface org.apache.jackrabbit.webdav.observation.ObservationResource
        Throws:
        org.apache.jackrabbit.webdav.DavException
        See Also:
        ObservationResource.subscribe(org.apache.jackrabbit.webdav.observation.SubscriptionInfo, String), SubscriptionManager.subscribe(org.apache.jackrabbit.webdav.observation.SubscriptionInfo, String, org.apache.jackrabbit.webdav.observation.ObservationResource)

      • unsubscribe

        public void unsubscribe​(String subscriptionId)
                 throws org.apache.jackrabbit.webdav.DavException
        Specified by:
        unsubscribe in interface org.apache.jackrabbit.webdav.observation.ObservationResource
        Throws:
        org.apache.jackrabbit.webdav.DavException
        See Also:
        ObservationResource.unsubscribe(String), SubscriptionManager.unsubscribe(String, org.apache.jackrabbit.webdav.observation.ObservationResource)

      • poll

        public org.apache.jackrabbit.webdav.observation.EventDiscovery poll​(String subscriptionId,
                                                                    long timeout)
                                                             throws org.apache.jackrabbit.webdav.DavException
        Specified by:
        poll in interface org.apache.jackrabbit.webdav.observation.ObservationResource
        Throws:
        org.apache.jackrabbit.webdav.DavException
        See Also:
        ObservationResource.poll(String, long), SubscriptionManager.poll(String, long, org.apache.jackrabbit.webdav.observation.ObservationResource)

      • getWorkspaceHref

        protected String getWorkspaceHref()
        Retrieve the href of the workspace the current session belongs to.
        Returns:
        href of the workspace or null if this resource does not represent a repository item.
        See Also:
        AbstractResource.getWorkspaceHref()

      • getItemName

        protected static String getItemName​(String itemPath)
        Retrieves the last segment of the given path and removes the index if present.
        Parameters:
        itemPath -
        Returns:
        valid jcr item name

      • getLocator

        public org.apache.jackrabbit.webdav.DavResourceLocator getLocator()
        Specified by:
        getLocator in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        DavResource.getLocator()

      • getResourcePath

        public String getResourcePath()
        Returns the path of the underlying repository item or the item to be created (PUT/MKCOL). If the resource exists but does not represent a repository item null is returned.
        Specified by:
        getResourcePath in interface org.apache.jackrabbit.webdav.DavResource
        Returns:
        path of the underlying repository item.
        See Also:
        DavResource.getResourcePath(), DavResourceLocator.getResourcePath()

      • getHref

        public String getHref()
        Specified by:
        getHref in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        DavResource.getHref(), DavResourceLocator.getHref(boolean)

      • getPropertyNames

        public org.apache.jackrabbit.webdav.property.DavPropertyName[] getPropertyNames()
        Specified by:
        getPropertyNames in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        DavResource.getPropertyNames()

      • getProperties

        public org.apache.jackrabbit.webdav.property.DavPropertySet getProperties()
        Specified by:
        getProperties in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        DavResource.getProperties()

      • isLockable

        public boolean isLockable​(org.apache.jackrabbit.webdav.lock.Type type,
                          org.apache.jackrabbit.webdav.lock.Scope scope)
        Returns true, if the SupportedLock property contains an entry with the given type and scope. By default resources allow for transaction lock only.
        Specified by:
        isLockable in interface org.apache.jackrabbit.webdav.DavResource
        Parameters:
        type -
        scope -
        Returns:
        true if this resource may be locked by the given type and scope.
        See Also:
        DavResource.isLockable(org.apache.jackrabbit.webdav.lock.Type, org.apache.jackrabbit.webdav.lock.Scope)

      • getLocks

        public org.apache.jackrabbit.webdav.lock.ActiveLock[] getLocks()
        Specified by:
        getLocks in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        todo improve....

      • addLockManager

        public void addLockManager​(org.apache.jackrabbit.webdav.lock.LockManager lockMgr)
        Specified by:
        addLockManager in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        DavResource.addLockManager(org.apache.jackrabbit.webdav.lock.LockManager)

      • getFactory

        public org.apache.jackrabbit.webdav.DavResourceFactory getFactory()
        Specified by:
        getFactory in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        DavResource.getFactory()

      • getSession

        public org.apache.jackrabbit.webdav.DavSession getSession()
        Specified by:
        getSession in interface org.apache.jackrabbit.webdav.DavResource
        See Also:
        DavResource.getSession(), DavResource.getSession()

      • init

        public void init​(org.apache.jackrabbit.webdav.transaction.TxLockManager txMgr,
                 String transactionId)
        Specified by:
        init in interface org.apache.jackrabbit.webdav.transaction.TransactionResource
        See Also:
        TransactionResource.init(TxLockManager, String)

      • unlock

        public void unlock​(String lockToken,
                   org.apache.jackrabbit.webdav.transaction.TransactionInfo tInfo)
            throws org.apache.jackrabbit.webdav.DavException
        Specified by:
        unlock in interface org.apache.jackrabbit.webdav.transaction.TransactionResource
        Throws:
        org.apache.jackrabbit.webdav.DavException
        See Also:
        TransactionResource.unlock(String, org.apache.jackrabbit.webdav.transaction.TransactionInfo)

      • getTransactionId

        public String getTransactionId()
        Specified by:
        getTransactionId in interface org.apache.jackrabbit.webdav.transaction.TransactionResource
        See Also:
        TransactionResource.getTransactionId()

      • getOptionResponse

        public org.apache.jackrabbit.webdav.version.OptionsResponse getOptionResponse​(org.apache.jackrabbit.webdav.version.OptionsInfo optionsInfo)
        Specified by:
        getOptionResponse in interface org.apache.jackrabbit.webdav.version.DeltaVResource
        Parameters:
        optionsInfo -
        Returns:
        object to be used in the OPTIONS response body or null
        See Also:
        DeltaVResource.getOptionResponse(org.apache.jackrabbit.webdav.version.OptionsInfo)

      • getReport

        public org.apache.jackrabbit.webdav.version.report.Report getReport​(org.apache.jackrabbit.webdav.version.report.ReportInfo reportInfo)
                                                             throws org.apache.jackrabbit.webdav.DavException
        Specified by:
        getReport in interface org.apache.jackrabbit.webdav.version.DeltaVResource
        Parameters:
        reportInfo -
        Returns:
        the requested report
        Throws:
        org.apache.jackrabbit.webdav.DavException
        See Also:
        DeltaVResource.getReport(org.apache.jackrabbit.webdav.version.report.ReportInfo)

      • addWorkspace

        public void addWorkspace​(org.apache.jackrabbit.webdav.DavResource workspace)
                  throws org.apache.jackrabbit.webdav.DavException
        The JCR api does not provide methods to create new workspaces. Calling addWorkspace on this resource will always fail.
        Specified by:
        addWorkspace in interface org.apache.jackrabbit.webdav.version.DeltaVResource
        Parameters:
        workspace -
        Throws:
        org.apache.jackrabbit.webdav.DavException - Always throws.
        See Also:
        DeltaVResource.addWorkspace(org.apache.jackrabbit.webdav.DavResource)

      • getReferenceResources

        public org.apache.jackrabbit.webdav.DavResource[] getReferenceResources​(org.apache.jackrabbit.webdav.property.DavPropertyName hrefPropertyName)
                                                                 throws org.apache.jackrabbit.webdav.DavException
        Return an array of DavResource objects that are referenced by the property with the specified name.
        Specified by:
        getReferenceResources in interface org.apache.jackrabbit.webdav.version.DeltaVResource
        Parameters:
        hrefPropertyName -
        Returns:
        array of DavResources
        Throws:
        org.apache.jackrabbit.webdav.DavException
        See Also:
        DeltaVResource.getReferenceResources(org.apache.jackrabbit.webdav.property.DavPropertyName)

      • getQueryGrammerSet

        public org.apache.jackrabbit.webdav.search.QueryGrammerSet getQueryGrammerSet()
        Specified by:
        getQueryGrammerSet in interface org.apache.jackrabbit.webdav.search.SearchResource
        Returns:
        See Also:
        SearchResource.getQueryGrammerSet()

      • search

        public org.apache.jackrabbit.webdav.MultiStatus search​(org.apache.jackrabbit.webdav.search.SearchInfo sInfo)
                                                throws org.apache.jackrabbit.webdav.DavException
        Specified by:
        search in interface org.apache.jackrabbit.webdav.search.SearchResource
        Parameters:
        sInfo -
        Returns:
        Throws:
        org.apache.jackrabbit.webdav.DavException
        See Also:
        SearchResource.search(org.apache.jackrabbit.webdav.search.SearchInfo)

      • createResourceFromLocator

        protected org.apache.jackrabbit.webdav.DavResource createResourceFromLocator​(org.apache.jackrabbit.webdav.DavResourceLocator loc)
                                                                      throws org.apache.jackrabbit.webdav.DavException
        Create a new DavResource from the given locator.
        Parameters:
        loc -
        Returns:
        new DavResource
        Throws:
        org.apache.jackrabbit.webdav.DavException

      • getLocatorFromItemPath

        protected org.apache.jackrabbit.webdav.DavResourceLocator getLocatorFromItemPath​(String itemPath)
        Build a DavResourceLocator from the given itemPath path.
        Parameters:
        itemPath -
        Returns:
        a new DavResourceLocator
        See Also:
        DavLocatorFactory.createResourceLocator(String, String, String)

      • getLocatorFromItem

        protected org.apache.jackrabbit.webdav.DavResourceLocator getLocatorFromItem​(Item repositoryItem)
        Build a new DavResourceLocator from the given repository item.
        Parameters:
        repositoryItem -
        Returns:
        a new locator for the specified item.
        See Also:
        getLocatorFromItemPath(String)

      • getRepositorySession

        protected Session getRepositorySession()
        Shortcut for getSession().getRepositorySession()
        Returns:
        repository session present in the AbstractResource.session.

      • normalizeResourceHref

        protected String normalizeResourceHref​(String href)
        Normalize the resource href. For example, remove contextPath prefix if found.
        Parameters:
        href - resource href
        Returns:
        normalized resource href