org.eclipse.webdav
Interface ILocatorFactory

All Known Implementing Classes:
LocatorFactory, WebDAVFactory

public interface ILocatorFactory

Factory for constructing resource locators.

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.

See Also:
ILocator

Method Summary
 ILocator newLocator(String resourceURL)
          Returns a locator with the given resource URL that (implicitly) uses the standard way of resolving resource URLs.
 ILocator newLocator(String requestURL, String label)
          Returns a locator with the given resource URL and label.
 ILocator newStableLocator(String resourceURL)
          Returns a locator given a stable resource URL.
 

Method Detail

newLocator

ILocator newLocator(String resourceURL)
Returns a locator with the given resource URL that (implicitly) uses the standard way of resolving resource URLs.

Version-unaware clients use this kind of locator exclusively.

Parameters:
resourceURL - the URL identifier of the resource as a String.

newLocator

ILocator newLocator(String requestURL,
                    String label)
Returns a locator with the given resource URL and label.

This kind of locator is used only by version-aware clients. It allows a versioning client to specify a version-controlled resource URL and the label of a version in the corresponding history. The resulting locator identifies the version.

The resource URL MUST NOT be a stable URL.

Parameters:
requestURL - the String representation of the version-controlled resource URL.
label - the label of the version to select from the corresponding history.

newStableLocator

ILocator newStableLocator(String resourceURL)
Returns a locator given a stable resource URL.

This kind of locator is used only by version-aware clients. The stable URL is generated by the server. Clients may reliably store the URL and use it to identify the same resource in subsequent operations. Resources identified by a stable URL cannot be moved but they may be deleted. The stable URL cannot be bound to a different resource by the client or server).

Note that locators with stable URLs cannot have also have a label.

Parameters:
resourceURL - the stable URL to a versioning resource as a String.


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