Project: stp

javax.wvcm
Interface Provider

All Known Subinterfaces:
CcProvider, CqProvider, StpProvider, WorkspaceProvider

public interface Provider

A WVCM provider. A WVCM provider is a factory for creating new locations, resource lists and the generic Resource proxy.

Since:
1.0

Method Summary
<T extends Resource>
T
buildProxy(Class<T> type, Location loc)
          Construct a proxy of class T for the given location.
 ProviderFactory.Callback callback()
          Return the initialization arguments for this provider.
 Folder folder(Location loc)
          Construct a folder proxy for the given location.
 Map<String,String> initArgs()
          Return the initialization arguments for this provider.
 void initialize(Map<String,String> initArgs, ProviderFactory.Callback callback)
          Initialize the provider with the specified map and callback.
 Location location(String string)
          Location factory for this Provider.
 Location relativeRootLocation()
          A location used in a property of a resource to indicate that this location should be interpreted relative to the folder that contains the resource.
 Resource resource(Location loc)
          Construct a resource proxy for the given location.
<T extends Resource>
ResourceList<T>
resourceList(T... resources)
          Construct a new ResourceList.
 Location rootLocation()
          A valid folder location for this provider.
 

Method Detail

buildProxy

<T extends Resource> T buildProxy(Class<T> type,
                                  Location loc)
                              throws WvcmException
Construct a proxy of class T for the given location.

Parameters:
type - the type of the proxy.
loc - the location of the resource.
Returns:
a new proxy for a resource at this Location.
Throws:
WvcmException

callback

ProviderFactory.Callback callback()
Return the initialization arguments for this provider.

Returns:
the initialization arguments for this provider.

folder

Folder folder(Location loc)
Construct a folder proxy for the given location.

Parameters:
loc - the location of the folder.
Returns:
a new proxy for a folder at this Location.

initArgs

Map<String,String> initArgs()
Return the initialization arguments for this provider.

Returns:
the initialization arguments for this provider.

initialize

void initialize(Map<String,String> initArgs,
                ProviderFactory.Callback callback)
                throws WvcmException
Initialize the provider with the specified map and callback. This is used to initialize a provider that was created with the zero-argument constructor.

Parameters:
initArgs - arguments used to customize the behavior of the provider.
callback - allows the provider to call back to the client for additional information.
Throws:
WvcmException - if the initArgs are invalid.

location

Location location(String string)
                  throws WvcmException
Location factory for this Provider.

Parameters:
string - the format of the location string is specific to the Provider, and to the repository that stores the persistent resource. A URL, a UNC filename, and an NFS filename are examples of possible formats for a location string.
Returns:
a Location whose string value is the specified String.
Throws:
WvcmException - ReasonCode:
  • WvcmException.ReasonCode.ILLEGAL_LOCATION_SYNTAX: String is not a valid location.

  • relativeRootLocation

    Location relativeRootLocation()
    A location used in a property of a resource to indicate that this location should be interpreted relative to the folder that contains the resource.


    resource

    Resource resource(Location loc)
    Construct a resource proxy for the given location.

    Parameters:
    loc - the location of the resource.
    Returns:
    a new proxy for a resource at this Location.

    resourceList

    <T extends Resource> ResourceList<T> resourceList(T... resources)
    Construct a new ResourceList.

    Parameters:
    resources - An array of resource proxies from which the list is to be initialized.
    Returns:
    a ResourceList initialized by the specified resources.

    rootLocation

    Location rootLocation()
    A valid folder location for this provider.

    Returns:
    a valid folder location for this provider. If this provider supports access to multiple repositories, each sibling (i.e. resource with the same parent) of this folder will commonly identify a repository.

    Generated Fri 26-Feb-2010 04:01 AM

    Copyright © IBM 2010. All rights reserved.