Java Doc for ServerConfigurationService.java in » ERP-CRM-Financial » sakai » org » sakaiproject » component » api » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » ERP CRM Financial » sakai » org.sakaiproject.component.api

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.sakaiproject.component.api .ServerConfigurationService

All known Subclasses:   org.sakaiproject.component.impl .BasicConfigurationService,
ServerConfigurationService
public interface ServerConfigurationService (Code)

ServerConfigurationService provides information about how the server is configured.

Field Summary
final static String CURRENT_PORTAL_PATH
     Key in the ThreadLocalManager for the path based on the current request.
final static String CURRENT_SERVER_URL
     Key in the ThreadLocalManager for the serverUrl based on the current request.
final public static String SERVICE_NAME
     This string can be used to find the service in the service manager.

Method Summary
String getAccessPath()
     Access the path to the access service on the server relative to the base URL for the server.
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.
Parameters:
  name - The configuration value name.
Parameters:
  dflt - The value to return if not found.
List getDefaultTools(String category)
     Access the list of tool ids that are selected by default for this category.
Parameters:
  category - The tool 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.
Parameters:
  helpContext - The context string.
int getInt(String name, int dflt)
     Access some named configuration value as an int.
Parameters:
  name - The configuration value name.
Parameters:
  dflt - The value to return if not found.
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.
Parameters:
  name - The configuration value name.
String getString(String name, String dflt)
     Access some named configuration value as a string.
Parameters:
  name - The configuration value name.
Parameters:
  dflt - The value to return if not found.
String[] getStrings(String name)
     Access some named configuration values as an array of strings.
List getToolOrder(String category)

String getToolUrl()
     Access the URL to the tool dispatcher service on the server - append any additional path to the end.
List getToolsRequired(String category)
     Access the list of tool ids that are required for this category.
Parameters:
  category - The tool category.
String getUserHomeUrl()
     Access the URL to the user's "home" (My Workspace) in the service.

Field Detail
CURRENT_PORTAL_PATH
final static String CURRENT_PORTAL_PATH(Code)
Key in the ThreadLocalManager for the path based on the current request.

CURRENT_SERVER_URL
final static String CURRENT_SERVER_URL(Code)
Key in the ThreadLocalManager for the serverUrl based on the current request.

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

Method Detail
getAccessPath
String getAccessPath()(Code)
Access the path to the access service on the server relative to the base URL for the server. The path to the access service on the server.

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

getBoolean
boolean getBoolean(String name, boolean dflt)(Code)
Access some named configuration value as a boolean.
Parameters:
  name - The configuration value name.
Parameters:
  dflt - The value to return if not found. The configuration value with this name, or the default value if not found.

getDefaultTools
List getDefaultTools(String category)(Code)
Access the list of tool ids that are selected by default for this category.
Parameters:
  category - The tool category. A list of tool ids (String) for this category to use by default, or an empty list if there are none for this category.

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

getHelpUrl
String getHelpUrl(String helpContext)(Code)
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. The URL to the help service on the server.

getInt
int getInt(String name, int dflt)(Code)
Access some named configuration value as an int.
Parameters:
  name - The configuration value name.
Parameters:
  dflt - The value to return if not found. The configuration value with this name, or the default value if not found.

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

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

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

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

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

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

getServerName
String getServerName()(Code)
Access the server DNS name. The server DNS name.

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

getString
String getString(String name)(Code)
Access some named configuration value as a string.
Parameters:
  name - The configuration value name. The configuration value with this name, or "" if not found.

getString
String getString(String name, String dflt)(Code)
Access some named configuration value as a string.
Parameters:
  name - The configuration value name.
Parameters:
  dflt - The value to return if not found. The configuration value with this name, or the default value if not found.

getStrings
String[] getStrings(String name)(Code)
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. The configuration value with this name, or the null if not found.

getToolOrder
List getToolOrder(String category)(Code)
Access the list of tool ids in order for this category, to impose on the displays of many tools
Parameters:
  category - The tool category An ordered list of tool ids (String) indicating the desired tool display order, or an empty list if there are none for this category.

getToolUrl
String getToolUrl()(Code)
Access the URL to the tool dispatcher service on the server - append any additional path to the end. The URL to the tool dispatcher service on the server.

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

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

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.