org.eclipse.webdav
Interface ILocator

All Known Implementing Classes:
Locator

public interface ILocator

Locators encapsulate a resource URL, whether it is a stable URL (such as a version URL) or a dynamic URL, and optional label selector.

The locator 'knows' if the resource URL is stable or not. Note that a stable URL cannot also have a label selector.

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Method Summary
 String getLabel()
          Returns the label selector value of this locator, or null if there is no label selector.
 String getResourceURL()
          Returns a resource URL.
 boolean isStable()
          Returns whether the resource URL of this locator is stable.
 

Method Detail

getLabel

String getLabel()
Returns the label selector value of this locator, or null if there is no label selector.

For certain methods (e.g. GET, PROPFIND), if the request-URL identifies a version-controlled resource, a label can be specified in a Label request header to cause the method to be applied to the version selected by that label from the version history of that version-controlled resource.

Note that a stable URL must not have a locator label.

Returns:
the label as a String or null if there is no label specified.

getResourceURL

String getResourceURL()
Returns a resource URL.

If there is no label specified, the URL properly identifies the resource. However, if there is a label, the resource URL identiifes a version-controlled resource whose history contains the version whose label is the target of this locator.

In typical usage, and with no label header, this URL may be the HTTP request URI or the destination header URI.

Returns:
the String representation of the resource URL.

isStable

boolean isStable()
Returns whether the resource URL of this locator is stable.

A stable URL is a server-generated URL that cannot be moved and do not mecessarily conform to the DAV namespace. For example, version URLs are server generated and do not have to appear in any DAV collection. Version URLs and version history URLs are stable URLs.

Returns:
true if the resource URL is stable, and false otherwise.


Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.