Package org.apache.jackrabbit.webdav

Interface DavResourceLocator

  • public interface DavResourceLocator
    DavResourceLocator...

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      DavLocatorFactory getFactory()
      Return the locator factory that created this locator.
      java.lang.String getHref​(boolean isCollection)
      Return the 'href' representation of this locator object.
      java.lang.String getPrefix()
      Return the prefix used to build the complete href of the resource as required for the href Xml element.
      java.lang.String getRepositoryPath()
      An implementation may choose to circumvent the incompatibility of a repository path with the URI path by applying an appropriate conversion.
      java.lang.String getResourcePath()
      Return the resource path.
      java.lang.String getWorkspaceName()
      Return the name of the workspace the resource identified by this locator is member of.
      java.lang.String getWorkspacePath()
      Return the path of the workspace the resource identified by this locator is member of.
      boolean isRootLocation()
      Returns true if this DavResourceLocator represents the root locator that would be requested with 'hrefPrefix'+'pathPrefix' with or without a trailing '/'.
      boolean isSameWorkspace​(java.lang.String workspaceName)
      Returns true if the specified workspace name equals to the workspace name defined with this locator.
      boolean isSameWorkspace​(DavResourceLocator locator)
      Returns true if the specified locator refers to a resource within the same workspace.

    • Method Detail

      • getPrefix

        java.lang.String getPrefix()
        Return the prefix used to build the complete href of the resource as required for the href Xml element. This includes scheme and host information as well as constant prefixes. However, this must not include workspace prefix.
        Returns:
        prefix needed in order to build the href from a resource path.
        See Also:
        getResourcePath()

      • getResourcePath

        java.lang.String getResourcePath()
        Return the resource path.
        Returns:
        resource path

      • getWorkspacePath

        java.lang.String getWorkspacePath()
        Return the path of the workspace the resource identified by this locator is member of.
        Returns:
        path of the workspace

      • getWorkspaceName

        java.lang.String getWorkspaceName()
        Return the name of the workspace the resource identified by this locator is member of.
        Returns:
        workspace name

      • isSameWorkspace

        boolean isSameWorkspace​(DavResourceLocator locator)
        Returns true if the specified locator refers to a resource within the same workspace.
        Parameters:
        locator -
        Returns:
        true if both paths are in the same workspace.

      • isSameWorkspace

        boolean isSameWorkspace​(java.lang.String workspaceName)
        Returns true if the specified workspace name equals to the workspace name defined with this locator.
        Parameters:
        workspaceName -
        Returns:
        true if workspace names are equal.

      • getHref

        java.lang.String getHref​(boolean isCollection)
        Return the 'href' representation of this locator object. The implementation should perform an URL encoding of the resource path.
        Parameters:
        isCollection -
        Returns:
        'href' representation of this path
        See Also:
        DavConstants.XML_HREF, DavResource.getHref()

      • isRootLocation

        boolean isRootLocation()
        Returns true if this DavResourceLocator represents the root locator that would be requested with 'hrefPrefix'+'pathPrefix' with or without a trailing '/'.
        Returns:
        true if this locator object belongs to the root resource.

      • getFactory

        DavLocatorFactory getFactory()
        Return the locator factory that created this locator.
        Returns:
        the locator factory

      • getRepositoryPath

        java.lang.String getRepositoryPath()
        An implementation may choose to circumvent the incompatibility of a repository path with the URI path by applying an appropriate conversion. This utility method allows to retrieve this transformed repository path. By default this method should return the same as getResourcePath()
        Returns:
        a repository compatible form if the resource path.
        See Also:
        that allows to build a valid DavResourceLocator from a given repository path.