|
Project: stp | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Provider
A WVCM provider. A WVCM provider is a factory for creating new locations, resource lists and the generic Resource proxy.
Method Summary | ||
---|---|---|
|
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. |
|
|
resourceList(T... resources)
Construct a new ResourceList . |
|
Location |
rootLocation()
A valid folder location for this provider. |
Method Detail |
---|
<T extends Resource> T buildProxy(Class<T> type, Location loc) throws WvcmException
type
- the type of the proxy.loc
- the location of the resource.
WvcmException
ProviderFactory.Callback callback()
Folder folder(Location loc)
loc
- the location of the folder.
Map<String,String> initArgs()
void initialize(Map<String,String> initArgs, ProviderFactory.Callback callback) throws WvcmException
initArgs
- arguments used to customize the behavior of the provider.callback
- allows the provider to call back to the client for additional information.
WvcmException
- if the initArgs are invalid.Location location(String string) throws WvcmException
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.
WvcmException
- ReasonCode:
WvcmException.ReasonCode.ILLEGAL_LOCATION_SYNTAX
:
String is not a valid location.Location relativeRootLocation()
Resource resource(Location loc)
loc
- the location of the resource.
<T extends Resource> ResourceList<T> resourceList(T... resources)
ResourceList
.
resources
- An array of resource proxies from which the list
is to be initialized.
Location rootLocation()
|
Generated Fri 14-Dec-2012 12:56 AM | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |