org.apache.wvcm
Class ProviderImpl

java.lang.Object
  extended by org.apache.wvcm.ProviderImpl
All Implemented Interfaces:
Provider

public class ProviderImpl
extends java.lang.Object
implements Provider

Implementation of Provider.

Version:
$Revision: 1.1.1.1.2.5 $

Constructor Summary
ProviderImpl(ProviderFactory.Callback callback)
          Constructor called by ProviderFactory
ProviderImpl(ProviderFactory.Callback callback, java.util.Hashtable h)
          Constructor called by ProviderFactory
 
Method Summary
 ProviderFactory.Callback callback()
          Get the callback of this provider.
 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)
          Return a Location whose string value is the specified location.
 Location contextLocation(java.lang.String location, boolean escaped)
          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
static org.jdom.input.SAXBuilder getSAXBuilder()
           
 java.lang.Object initParameter(java.lang.String name)
          Get the specified init parameter.
 Location location(java.lang.String location)
          Return a Location whose string value is the specified location.
 Location location(java.lang.String location, boolean escaped)
          Return a Location whose string value is the specified location.
 ResourceList resourceList()
          Return an empty ResourceList.
 Location serverPrivilegesLocation()
           
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProviderImpl

public ProviderImpl(ProviderFactory.Callback callback)
Constructor called by ProviderFactory

Parameters:
callback - The object containing the getAuthentication method that the Provider will call whenever it needs to authenticate the current user.

ProviderImpl

public ProviderImpl(ProviderFactory.Callback callback,
                    java.util.Hashtable h)
Constructor called by ProviderFactory

Parameters:
callback - The object containing the getAuthentication method that the Provider will call whenever it needs to authenticate the current user.
h - A hashtable containing provider-specific initialization values.
Method Detail

serverSharedWorkspaceList

public 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.

Specified by:
serverSharedWorkspaceList in interface Provider
Parameters:
wantedPropertyList - The properties available in the returned proxies.
Throws:
WvcmException

location

public 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.

Specified by:
location in interface Provider
Throws:
WvcmException - with ILLEGAL_LOCATION_SYNTAX if the String is not a valid location.

location

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

Specified by:
location in interface Provider
Parameters:
escaped - is the location escaped?
Throws:
WvcmException - with ILLEGAL_LOCATION_SYNTAX if the location is not a valid location.

contextLocation

public Location contextLocation(java.lang.String location)
                         throws WvcmException
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.

Specified by:
contextLocation in interface Provider
Throws:
WvcmException - with ILLEGAL_LOCATION_SYNTAX if the location is not a valid location.

contextLocation

public Location contextLocation(java.lang.String location,
                                boolean escaped)
                         throws WvcmException
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.

Specified by:
contextLocation in interface Provider
Parameters:
escaped - is the location escaped?
Throws:
WvcmException - with ILLEGAL_LOCATION_SYNTAX if the location is not a valid location.

resourceList

public ResourceList resourceList()
Return an empty ResourceList.

Specified by:
resourceList in interface Provider

clientWorkspaceFolderList

public 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.

Specified by:
clientWorkspaceFolderList in interface Provider
Parameters:
wantedPropertyList - The properties available in the returned proxies.
Throws:
WvcmException

serverWorkspaceFolderList

public 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.

Specified by:
serverWorkspaceFolderList in interface Provider
Parameters:
wantedPropertyList - The properties available in the returned proxies.
Throws:
WvcmException

getGenericPrivilegeList

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

Specified by:
getGenericPrivilegeList in interface Provider
Returns:
a List

getGenericPrincipalList

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

Specified by:
getGenericPrincipalList in interface Provider
Returns:
a List

initParameter

public java.lang.Object initParameter(java.lang.String name)
Get the specified init parameter.

Parameters:
name - the parameter name
Returns:
the value

callback

public ProviderFactory.Callback callback()
Get the callback of this provider.

Returns:
the callback

serverPrivilegesLocation

public Location serverPrivilegesLocation()
                                  throws WvcmException
Throws:
WvcmException

getSAXBuilder

public static org.jdom.input.SAXBuilder getSAXBuilder()


Copyright (c) 2003 - Apache Software Foundation