javax.wvcm
Interface Provider

All Known Implementing Classes:
ProviderImpl

public interface Provider

A WVCM provider.


Method Summary
 java.util.List clientWorkspaceFolderList(PropertyNameList wantedPropertyList)
          Return a list of Folder objects that identify folders on the client that contain workspaces for this Provider.
 Location contextLocation(java.lang.String location)
          NOT YET STANDARD Return a Location whose string value is the specified location.
 Location contextLocation(java.lang.String location, boolean escaped)
          NOT YET STANDARD Return a Location whose string value is the specified location.
 java.util.List getGenericPrincipalList()
          NOT YET STANDARD Get the list of generic Principal instances
 java.util.List getGenericPrivilegeList()
          NOT YET STANDARD Get the list of generic Privilege instances
 Location location(java.lang.String location)
          Return a Location whose string value is the specified location.
 Location location(java.lang.String location, boolean escaped)
          NOT YET STANDARD Return a Location whose string value is the specified location.
 ResourceList resourceList()
          Return an empty ResourceList.
 java.util.List serverSharedWorkspaceList(PropertyNameList wantedPropertyList)
          Return a list of Workspace objects which can be used as the argument of the Workspace.setServerState(javax.wvcm.Workspace) routine for more than one Workspace.
 java.util.List serverWorkspaceFolderList(PropertyNameList wantedPropertyList)
          Return a list of Folder objects that identify folders on the server that contain workspaces for this Provider.
 

Method Detail

serverWorkspaceFolderList

java.util.List serverWorkspaceFolderList(PropertyNameList wantedPropertyList)
                                         throws WvcmException
Return a list of Folder objects that identify folders on the server that contain workspaces for this Provider. If this Provider does not allow the client to create new workspaces on the server, an empty List is returned.

Parameters:
wantedPropertyList - The properties available in the returned proxies.
Throws:
WvcmException

clientWorkspaceFolderList

java.util.List clientWorkspaceFolderList(PropertyNameList wantedPropertyList)
                                         throws WvcmException
Return a list of Folder objects that identify folders on the client that contain workspaces for this Provider. If this Provider does not support workspaces on the client, an empty List is returned.

Parameters:
wantedPropertyList - The properties available in the returned proxies.
Throws:
WvcmException

serverSharedWorkspaceList

java.util.List serverSharedWorkspaceList(PropertyNameList wantedPropertyList)
                                         throws WvcmException
Return a list of Workspace objects which can be used as the argument of the Workspace.setServerState(javax.wvcm.Workspace) routine for more than one Workspace. If this Provider does not allow multiple workspaces to share the same ServerState, an empty List is returned.

Parameters:
wantedPropertyList - The properties available in the returned proxies.
Throws:
WvcmException

location

Location location(java.lang.String location)
                  throws WvcmException
Return a Location whose string value is the specified location. The location string is checked for the character '%' to see if it is escaped or not.

Throws:
WvcmException - with ILLEGAL_LOCATION_SYNTAX if the location is not a valid location.

location

Location location(java.lang.String location,
                  boolean escaped)
                  throws WvcmException
NOT YET STANDARD Return a Location whose string value is the specified location.

Parameters:
escaped - is the location escaped?
Throws:
WvcmException - with ILLEGAL_LOCATION_SYNTAX if the location is not a valid location.

contextLocation

Location contextLocation(java.lang.String location)
                         throws WvcmException
NOT YET STANDARD Return a Location whose string value is the specified location. The location string is assumed to be unescaped. The context is prepended if one has been specified and the location does not already start with the context.

Throws:
WvcmException - with ILLEGAL_LOCATION_SYNTAX if the location is not a valid location.

contextLocation

Location contextLocation(java.lang.String location,
                         boolean escaped)
                         throws WvcmException
NOT YET STANDARD Return a Location whose string value is the specified location. The context is prepended if one has been specified and the location does not already start with the context.

Parameters:
escaped - is the location escaped?
Throws:
WvcmException - with ILLEGAL_LOCATION_SYNTAX if the location is not a valid location.

resourceList

ResourceList resourceList()
Return an empty ResourceList.


getGenericPrincipalList

java.util.List getGenericPrincipalList()
NOT YET STANDARD Get the list of generic Principal instances

Returns:
a List

getGenericPrivilegeList

java.util.List getGenericPrivilegeList()
NOT YET STANDARD Get the list of generic Privilege instances

Returns:
a List


Copyright (c) 2003 - Apache Software Foundation