org.sakaiproject.service.framework.config
Interface ServerConfigurationService

All Known Implementing Classes:
BasicConfigurationService

public interface ServerConfigurationService

ServerConfigurationService provides information about how the server is configured.

Version:
$Revision: 5222 $
Author:
University of Michigan, Sakai Software Development Team

Field Summary
static String SERVICE_NAME
          This string can be used to find the service in the service manager.
 
Method Summary
 String getAccessUrl()
          Access the URL to the access service on the server - append any additional path to the end.
 boolean getBoolean(String name, boolean dflt)
          Access some named configuration value as a boolean.
 List getDefaultTools(String category)
          Access the list of tool ids that are selected by default for this category.
 String getGatewaySiteId()
          Access the site id for the gateway (public) site.
 String getHelpUrl(String helpContext)
          Access the URL to the help service on the server - append in the path the tool well known id for context sensitive help.
 int getInt(String name, int dflt)
          Access some named configuration value as an int.
 List getLocks()
          Access the list of security locks in use on this server.
 String getLoggedOutUrl()
          Access the URL to use as a redirect when the user has logged out.
 String getPortalUrl()
          Access the URL to the portal service on the server - append any additional path to the end.
 String getSakaiHomePath()
          Access the file path to the "sakai home" on the app server.
 String getServerId()
          Access the unique (to the cluster) id of the server.
 String getServerIdInstance()
          Access the combined server / instance id.
 String getServerInstance()
          Access the unique (to the cluster) instance id of the server.
 String getServerName()
          Access the server DNS name.
 String getServerUrl()
          Access the URL to the root of the server - append any additional path to the end.
 String getString(String name)
          Access some named configuration value as a string.
 String getString(String name, String dflt)
          Access some named configuration value as a string.
 String[] getStrings(String name)
          Access some named configuration values as an array of strings.
 List getToolOrder(String category)
          Access the list of tool ids in order for this category, to impose on the displays of many tools
 List getToolsRequired(String category)
          Access the list of tool ids that are required for this category.
 String getUserHomeUrl()
          Access the URL to the user's "home" (My Workspace) in the service.
 

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME
This string can be used to find the service in the service manager.

Method Detail

getServerId

public String getServerId()
Access the unique (to the cluster) id of the server.

Returns:
The unique (to the cluster) id of the server.

getServerInstance

public String getServerInstance()
Access the unique (to the cluster) instance id of the server.

Returns:
The unique (to the cluster) instance id of the server.

getServerIdInstance

public String getServerIdInstance()
Access the combined server / instance id.

Returns:
The combined server / instance id.

getServerName

public String getServerName()
Access the server DNS name.

Returns:
The server DNS name.

getServerUrl

public String getServerUrl()
Access the URL to the root of the server - append any additional path to the end.

Returns:
The URL to the root of the server.

getHelpUrl

public String getHelpUrl(String helpContext)
Access the URL to the help service on the server - append in the path the tool well known id for context sensitive help.

Parameters:
helpContext - The context string.
Returns:
The URL to the help service on the server.

getAccessUrl

public String getAccessUrl()
Access the URL to the access service on the server - append any additional path to the end.

Returns:
The URL to the access service on the server.

getPortalUrl

public String getPortalUrl()
Access the URL to the portal service on the server - append any additional path to the end.

Returns:
The URL to the portal service on the server.

getGatewaySiteId

public String getGatewaySiteId()
Access the site id for the gateway (public) site.

Returns:
The site id for the gateway (public) site.

getLoggedOutUrl

public String getLoggedOutUrl()
Access the URL to use as a redirect when the user has logged out.

Returns:
The URL to use as a redirect when the user has logged out.

getUserHomeUrl

public String getUserHomeUrl()
Access the URL to the user's "home" (My Workspace) in the service.

Returns:
The URL to the user's "home" (My Workspace) in the service.

getSakaiHomePath

public String getSakaiHomePath()
Access the file path to the "sakai home" on the app server.

Returns:
The file path to the "sakai home" on the app server.

getString

public String getString(String name)
Access some named configuration value as a string.

Parameters:
name - The configuration value name.
Returns:
The configuration value with this name, or "" if not found.

getString

public String getString(String name,
                        String dflt)
Access some named configuration value as a string.

Parameters:
name - The configuration value name.
dflt - The value to return if not found.
Returns:
The configuration value with this name, or the default value if not found.

getStrings

public String[] getStrings(String name)
Access some named configuration values as an array of strings. The name is the base name. name + ".count" must be defined to be a positive integer - how many are defined. name + "." + i (1..count) must be defined to be the values.

Parameters:
name - The configuration value name base.
Returns:
The configuration value with this name, or the null if not found.

getInt

public int getInt(String name,
                  int dflt)
Access some named configuration value as an int.

Parameters:
name - The configuration value name.
dflt - The value to return if not found.
Returns:
The configuration value with this name, or the default value if not found.

getBoolean

public boolean getBoolean(String name,
                          boolean dflt)
Access some named configuration value as a boolean.

Parameters:
name - The configuration value name.
dflt - The value to return if not found.
Returns:
The configuration value with this name, or the default value if not found.

getLocks

public List getLocks()
Access the list of security locks in use on this server.

Returns:
List (String) of security locks in use on this server.

getToolOrder

public List getToolOrder(String category)
Access the list of tool ids in order for this category, to impose on the displays of many tools

Parameters:
category - The tool category
Returns:
An ordered list of tool ids (String) indicating the desired tool display order, or an empty list if there are none for this category.

getToolsRequired

public List getToolsRequired(String category)
Access the list of tool ids that are required for this category.

Parameters:
category - The tool category.
Returns:
A list of tool ids (String) that are required for this category, or an empty list if there are none for this category.

getDefaultTools

public List getDefaultTools(String category)
Access the list of tool ids that are selected by default for this category.

Parameters:
category - The tool category.
Returns:
A list of tool ids (String) for this category to use by default, or an empty list if there are none for this category.