BaseConfigurationService (sakai-citations-impl 11.4 API)

java.lang.Object
- org.sakaiproject.citation.impl.BaseConfigurationService

All Implemented Interfaces:: Observer, ConfigurationService

public class BaseConfigurationService
extends Object
implements ConfigurationService, Observer

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_SECONDS_BETWEEN_SAVECITE_REFRESHES`
`protected String`	`m_adminSiteName`
`protected boolean`	`m_allowSiteBySiteOverride`
`protected String`	`m_categoriesXml`
`protected boolean`	`m_citationsEnabledByDefault`
`protected String`	`m_configFolder`
`protected static String`	`m_configListRef`
`protected static Map<String,Map<String,String>>`	`m_configMaps`
`protected String`	`m_configXml`
`protected String`	`m_databaseXml`
`protected String`	`m_extendedRepositoryId`
`protected boolean`	`m_externalSearchEnabled`
`protected String`	`m_externalSearchUrl`
`protected String`	`m_googleBaseUrl`
`protected String`	`m_googleSearchEnabled`
`protected String`	`m_librarySearchEnabled`
`protected String`	`m_metasearchBaseUrl`
`protected String`	`m_metasearchPassword`
`protected String`	`m_metasearchUsername`
`protected String`	`m_openUrlLabel`
`protected String`	`m_openUrlResolverAddress`
`protected String`	`m_osidConfig`
`protected String`	`m_osidImpl`
`protected String`	`m_sakaiServerKey`
`protected ServerConfigurationService`	`m_serverConfigurationService`
`protected SessionManager`	`m_sessionManager`
`protected String`	`m_siteConfigXml`
`protected SortedSet<String>`	`m_updatableResources`
`static int`	`MAXIMUM_SECONDS_BETWEEN_SAVECITE_REFRESHES`
`static String`	`PARAM_SECONDS_BETWEEN_SAVECITE_REFRESHES`
`protected Map<String,List<Map<String,String>>>`	`saveciteClients`

Fields inherited from interface org.sakaiproject.citation.api.ConfigurationService
SEARCHABLE_DATABASES

Constructor Summary

Constructors
Constructor and Description

BaseConfigurationService()

Constructors
Constructor and Description
`BaseConfigurationService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addListToStringBuilder(StringBuilder buf, List list, int indent, int indentIncrement)`
`protected void`	`addMapToStringBuilder(StringBuilder buf, Map map, int indent, int indentIncrement)`
`void`	`destroy()`
`protected SecurityAdvisor`	`enableSecurityAdvisor()` Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions.
`String`	`getAdminSiteName()`
`Collection<String>`	`getAllCategoryXml()`
`String`	`getConfigFolder()`
`String`	`getConfigFolderId()`
`String`	`getConfigFolderReference()`
`SiteOsidConfiguration`	`getConfigurationHandler(String osidConfigHandler)` Return a SiteOsidConfiguration instance
`protected String`	`getConfigurationParameter(String parameter)` Get a named value from the site-specific XML configuration file
`String`	`getConfigurationXml()` Fetch the appropriate XML configuration document for this user
`String`	`getConfigXmlCache()`
`String`	`getDatabaseHierarchyXml()` Fetch the appropriate XML database hierarchy document for this user
`String`	`getDatabaseXml()`
`String`	`getDatabaseXmlCache()`
`String`	`getExtendedRepositoryId()`
`String`	`getExternalSearchUrl()`
`String`	`getGoogleBaseUrl()`
`String`	`getGoogleSearchEnabled()`
`List<String>`	`getGroupIds()` Fetch this user's group affiliations
`String`	`getLibrarySearchEnabled()`
`String`	`getMetasearchBaseUrl()`
`String`	`getMetasearchPassword()`
`String`	`getMetasearchUsername()`
`String`	`getOpenUrlLabel()`
`String`	`getOpenUrlResolverAddress()`
`String`	`getOsidConfig()`
`String`	`getOsidImpl()`
`String`	`getSakaiServerKey()`
`Map<String,List<Map<String,String>>>`	`getSaveciteClients()`
`List<Map<String,String>>`	`getSaveciteClientsForLocale(Locale locale)`
`String`	`getSecondsBetweenSaveciteRefreshes()`
`ServerConfigurationService`	`getServerConfigurationService()`
`SessionManager`	`getSessionManager()`
`String`	`getSiteConfigExtendedRepositoryId()` Fetch the site specific extended Repository ID
`String`	`getSiteConfigGoogleBaseUrl()` Fetch the Google base-URL
`int`	`getSiteConfigMaximumSearchableDBs()` Get the maximum number of databases we can search at one time
`String`	`getSiteConfigMetasearchBaseUrl()` Fetch the meta-search base-URL
`String`	`getSiteConfigMetasearchPassword()` Fetch the meta-search password
`String`	`getSiteConfigMetasearchUsername()` Fetch the meta-search username
`String`	`getSiteConfigOpenUrlLabel()` Fetch the OpenURL label
`String`	`getSiteConfigOpenUrlResolverAddress()` Fetch the OpenURL resolver address
`String`	`getSiteConfigOsidPackageName()` Fetch the site specific Repository OSID package name
`String`	`getSiteConfigPreferredUrlPrefix()` Prefix string for "preferred" URLs (when used as title or related links).
`String`	`getSiteConfigSakaiServerKey()` Fetch the Sakai server key
`String`	`getSiteConfigUsePreferredUrls()` How should we use URLs marked as "preferred" by the OSID implementation?
`String`	`getSiteConfigXml()`
`protected SiteOsidConfiguration`	`getSiteOsidConfiguration()` Load and initialize the site-specific OSID configuration code
`protected String`	`getText(Document root, String elementName)` Get the text associated with this element
`protected String`	`getText(Element root, String elementName)` Get the text associated with this element
`protected DocumentBuilder`	`getXmlDocumentBuilder()` Get a DOM Document builder.
`void`	`init()`
`boolean`	`isAllowSiteBySiteOverride()` Is the Citations Helper enabled site-by-site?
`boolean`	`isCitationsEnabledByDefault()` Is the Citations Helper [potentially] available for all sites?
`boolean`	`isConfigurationXmlAvailable()` Is the configuration XML file provided and readable
`boolean`	`isDatabaseHierarchyXmlAvailable()` Is the database hierarchy XML file provided and readable
`boolean`	`isExternalSerarchEnabled()`
`boolean`	`isGoogleScholarEnabled()` Is Google search enabled?
`boolean`	`isLibrarySearchEnabled()` Is library search enabled for any users?
`boolean`	`librarySearchEnabled()` Is library search enabled for the current user?
`protected String`	`normalizeText(String original, String update)` "Normalize" XML text node content to create a simple string
`protected Document`	`parseXmlFromStream(InputStream stream)` Parse an XML resource
`void`	`populateConfig(String configurationXml, InputStream stream)` Populate cached values from a configuration XML resource.
`protected void`	`saveParameter(Document document, Map parameterMap, String name)` Lookup and save one dynamic configuration parameter
`protected void`	`saveServletClientMappings(Document document)`
`void`	`setAdminSiteName(String adminSiteName)`
`void`	`setAllowSiteBySiteOverride(boolean allowSiteBySiteOverride)` Enable/disable site by site Citations Helper override
`void`	`setCitationsEnabledByDefault(boolean citationsEnabledByDefault)` Enable/disable Citations Helper by default
`void`	`setConfigFolder(String configFolder)`
`void`	`setConfigXmlCache(String configXml)`
`void`	`setDatabaseXml(String databaseXml)`
`void`	`setDatabaseXmlCache(String categoriesXml)`
`void`	`setExtendedRepositoryId(String extendedRepositoryId)`
`void`	`setExternalSearchEnabled(boolean state)`
`void`	`setExternalSearchUrl(String url)`
`void`	`setGoogleBaseUrl(String googleBaseUrl)`
`void`	`setGoogleScholarEnabled(boolean state)` Enable/disable Google support (no support for site specific XML configuration)
`void`	`setGoogleSearchEnabled(String googleSearchEnabled)`
`void`	`setLibrarySearchEnabled(boolean state)` Enable/disable library search support (no support for site specific XML configuration)
`void`	`setLibrarySearchEnabled(String librarySearchEnabled)`
`void`	`setMetasearchBaseUrl(String baseUrl)`
`void`	`setMetasearchPassword(String password)`
`void`	`setMetasearchUsername(String username)`
`void`	`setOpenUrlLabel(String openUrlLabel)`
`void`	`setOpenUrlResolverAddress(String openUrlResolverAddress)`
`void`	`setOsidConfig(String osidConfig)`
`void`	`setOsidImpl(String osidImpl)`
`void`	`setSakaiServerKey(String sakaiId)`
`void`	`setSaveciteClients(Map<String,List<Map<String,String>>> saveciteClients)`
`void`	`setServerConfigurationService(ServerConfigurationService serverConfigurationService)`
`void`	`setSessionManager(SessionManager sessionManager)`
`void`	`setSiteConfigXml(String siteConfigXml)`
`void`	`update(Observable arg0, Object arg1)` Called when an observed object chnages (@see java.util.Observer#update)
`protected void`	`updateConfig(String configFileRef)` Update configuration data from an XML resource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SECONDS_BETWEEN_SAVECITE_REFRESHES
```
public static final String DEFAULT_SECONDS_BETWEEN_SAVECITE_REFRESHES
```
    See Also:
    
    Constant Field Values
  - MAXIMUM_SECONDS_BETWEEN_SAVECITE_REFRESHES
```
public static final int MAXIMUM_SECONDS_BETWEEN_SAVECITE_REFRESHES
```
    See Also:
    
    Constant Field Values
  - PARAM_SECONDS_BETWEEN_SAVECITE_REFRESHES
```
public static final String PARAM_SECONDS_BETWEEN_SAVECITE_REFRESHES
```
    See Also:
    
    Constant Field Values
  - m_citationsEnabledByDefault
```
protected boolean m_citationsEnabledByDefault
```
  - m_allowSiteBySiteOverride
```
protected boolean m_allowSiteBySiteOverride
```
  - m_googleSearchEnabled
```
protected String m_googleSearchEnabled
```
  - m_librarySearchEnabled
```
protected String m_librarySearchEnabled
```
  - m_externalSearchEnabled
```
protected boolean m_externalSearchEnabled
```
  - m_adminSiteName
```
protected String m_adminSiteName
```
  - m_configFolder
```
protected String m_configFolder
```
  - m_configXml
```
protected String m_configXml
```
  - m_categoriesXml
```
protected String m_categoriesXml
```
  - m_updatableResources
```
protected SortedSet<String> m_updatableResources
```
  - m_databaseXml
```
protected String m_databaseXml
```
  - m_siteConfigXml
```
protected String m_siteConfigXml
```
  - m_metasearchUsername
```
protected String m_metasearchUsername
```
  - m_metasearchPassword
```
protected String m_metasearchPassword
```
  - m_metasearchBaseUrl
```
protected String m_metasearchBaseUrl
```
  - m_osidImpl
```
protected String m_osidImpl
```
  - m_extendedRepositoryId
```
protected String m_extendedRepositoryId
```
  - m_openUrlLabel
```
protected String m_openUrlLabel
```
  - m_openUrlResolverAddress
```
protected String m_openUrlResolverAddress
```
  - m_googleBaseUrl
```
protected String m_googleBaseUrl
```
  - m_sakaiServerKey
```
protected String m_sakaiServerKey
```
  - m_externalSearchUrl
```
protected String m_externalSearchUrl
```
  - m_osidConfig
```
protected String m_osidConfig
```
  - m_sessionManager
```
protected SessionManager m_sessionManager
```
  - m_serverConfigurationService
```
protected ServerConfigurationService m_serverConfigurationService
```
  - m_configMaps
```
protected static Map<String,Map<String,String>> m_configMaps
```
  - m_configListRef
```
protected static String m_configListRef
```
  - saveciteClients
```
protected Map<String,List<Map<String,String>>> saveciteClients
```
- Constructor Detail
  - BaseConfigurationService
```
public BaseConfigurationService()
```
- Method Detail
  - getConfigurationXml
```
public String getConfigurationXml()
                           throws OsidConfigurationException
```
    Fetch the appropriate XML configuration document for this user
    
    Specified by:
    
    getConfigurationXml in interface ConfigurationService
    
    Returns:
    
    Configuration XML resource name
    
    Throws:
    
    OsidConfigurationException
  - isConfigurationXmlAvailable
```
public boolean isConfigurationXmlAvailable()
```
    Is the configuration XML file provided and readable
    
    Specified by:
    
    isConfigurationXmlAvailable in interface ConfigurationService
    
    Returns:
    
    true If the XML file is provided and readable, false otherwise
  - getConfigFolderReference
```
public String getConfigFolderReference()
```
    Specified by:
    
    getConfigFolderReference in interface ConfigurationService
  - getConfigFolderId
```
public String getConfigFolderId()
```
    Specified by:
    
    getConfigFolderId in interface ConfigurationService
  - getDatabaseHierarchyXml
```
public String getDatabaseHierarchyXml()
                               throws OsidConfigurationException
```
    Fetch the appropriate XML database hierarchy document for this user
    
    Specified by:
    
    getDatabaseHierarchyXml in interface ConfigurationService
    
    Returns:
    
    Hierarchy XML resource name
    
    Throws:
    
    OsidConfigurationException
  - isDatabaseHierarchyXmlAvailable
```
public boolean isDatabaseHierarchyXmlAvailable()
```
    Is the database hierarchy XML file provided and readable
    
    Specified by:
    
    isDatabaseHierarchyXmlAvailable in interface ConfigurationService
    
    Returns:
    
    true If the XML file is provided and readable, false otherwise
  - getGroupIds
```
public List<String> getGroupIds()
                         throws OsidConfigurationException
```
    Fetch this user's group affiliations
    
    Specified by:
    
    getGroupIds in interface ConfigurationService
    
    Returns:
    
    A list of group IDs (empty if no IDs exist)
    
    Throws:
    
    OsidConfigurationException
  - getSiteConfigOsidPackageName
```
public String getSiteConfigOsidPackageName()
```
    Fetch the site specific Repository OSID package name
    
    Specified by:
    
    getSiteConfigOsidPackageName in interface ConfigurationService
    
    Returns:
    
    Repository Package (eg org.sakaibrary.osid.repository.xserver)
  - getSiteConfigExtendedRepositoryId
```
public String getSiteConfigExtendedRepositoryId()
```
    Fetch the site specific extended Repository ID
    
    Specified by:
    
    getSiteConfigExtendedRepositoryId in interface ConfigurationService
    
    Returns:
    
    The Repository ID
  - getSiteConfigMetasearchUsername
```
public String getSiteConfigMetasearchUsername()
```
    Fetch the meta-search username
    
    Specified by:
    
    getSiteConfigMetasearchUsername in interface ConfigurationService
    
    Returns:
    
    the username
  - getSiteConfigMetasearchPassword
```
public String getSiteConfigMetasearchPassword()
```
    Fetch the meta-search password
    
    Specified by:
    
    getSiteConfigMetasearchPassword in interface ConfigurationService
    
    Returns:
    
    the password
  - getSiteConfigMetasearchBaseUrl
```
public String getSiteConfigMetasearchBaseUrl()
```
    Fetch the meta-search base-URL
    
    Specified by:
    
    getSiteConfigMetasearchBaseUrl in interface ConfigurationService
    
    Returns:
    
    the username
  - getSiteConfigOpenUrlLabel
```
public String getSiteConfigOpenUrlLabel()
```
    Fetch the OpenURL label
    
    Specified by:
    
    getSiteConfigOpenUrlLabel in interface ConfigurationService
    
    Returns:
    
    the label text
  - getSiteConfigOpenUrlResolverAddress
```
public String getSiteConfigOpenUrlResolverAddress()
```
    Fetch the OpenURL resolver address
    
    Specified by:
    
    getSiteConfigOpenUrlResolverAddress in interface ConfigurationService
    
    Returns:
    
    the resolver address (domain name or IP)
  - getSiteConfigGoogleBaseUrl
```
public String getSiteConfigGoogleBaseUrl()
```
    Fetch the Google base-URL
    
    Specified by:
    
    getSiteConfigGoogleBaseUrl in interface ConfigurationService
    
    Returns:
    
    the URL
  - getSiteConfigSakaiServerKey
```
public String getSiteConfigSakaiServerKey()
```
    Fetch the Sakai server key
    
    Specified by:
    
    getSiteConfigSakaiServerKey in interface ConfigurationService
    
    Returns:
    
    the key text
  - getSiteConfigMaximumSearchableDBs
```
public int getSiteConfigMaximumSearchableDBs()
```
    Get the maximum number of databases we can search at one time
    
    Specified by:
    
    getSiteConfigMaximumSearchableDBs in interface ConfigurationService
    
    Returns:
    
    The maximum value (defaults to SEARCHABLE_DATABASES if no other value is specified)
  - getSiteConfigUsePreferredUrls
```
public String getSiteConfigUsePreferredUrls()
```
    How should we use URLs marked as "preferred" by the OSID implementation? The choices are:
    - "false" (do not use the preferred URL at all)
    - "title-link" (provide the preferred URL as the title link)
    - "related-link" (provide as a related link, not as the title link)
    Note: "false" is the default value if nothing is specified in the configuration file
    Specified by:
    
    getSiteConfigUsePreferredUrls in interface ConfigurationService
    
    Returns:
    
    "related-link", "title-link", or "false"
  - getSiteConfigPreferredUrlPrefix
```
public String getSiteConfigPreferredUrlPrefix()
```
    Prefix string for "preferred" URLs (when used as title or related links). This is likely to be the proxy information for the direct URL.
    
    Specified by:
    
    getSiteConfigPreferredUrlPrefix in interface ConfigurationService
    
    Returns:
    
    The prefix String (null if none)
  - setCitationsEnabledByDefault
```
public void setCitationsEnabledByDefault(boolean citationsEnabledByDefault)
```
    Enable/disable Citations Helper by default
    
    Specified by:
    
    setCitationsEnabledByDefault in interface ConfigurationService
    
    Parameters:
    
    state - true to set default 'On'
  - isCitationsEnabledByDefault
```
public boolean isCitationsEnabledByDefault()
```
    Is the Citations Helper [potentially] available for all sites?
    
    Specified by:
    
    isCitationsEnabledByDefault in interface ConfigurationService
    
    Returns:
    
    true if so
  - setAllowSiteBySiteOverride
```
public void setAllowSiteBySiteOverride(boolean allowSiteBySiteOverride)
```
    Enable/disable site by site Citations Helper override
    
    Specified by:
    
    setAllowSiteBySiteOverride in interface ConfigurationService
    
    Parameters:
    
    state - true to enable site by site Citations Helper
  - isAllowSiteBySiteOverride
```
public boolean isAllowSiteBySiteOverride()
```
    Is the Citations Helper enabled site-by-site?
    
    Specified by:
    
    isAllowSiteBySiteOverride in interface ConfigurationService
    
    Returns:
    
    true if so
  - setGoogleScholarEnabled
```
public void setGoogleScholarEnabled(boolean state)
```
    Enable/disable Google support (no support for site specific XML configuration)
    
    Specified by:
    
    setGoogleScholarEnabled in interface ConfigurationService
    
    Parameters:
    
    state - true to enable Google support
  - isGoogleScholarEnabled
```
public boolean isGoogleScholarEnabled()
```
    Is Google search enabled? (no support for site specific XML configuration)
    
    Specified by:
    
    isGoogleScholarEnabled in interface ConfigurationService
    
    Returns:
    
    true if so
  - setLibrarySearchEnabled
```
public void setLibrarySearchEnabled(boolean state)
```
    Enable/disable library search support (no support for site specific XML configuration)
    
    Specified by:
    
    setLibrarySearchEnabled in interface ConfigurationService
    
    Parameters:
    
    state - true to enable support
  - isLibrarySearchEnabled
```
public boolean isLibrarySearchEnabled()
```
    Is library search enabled for any users? (no support for site specific XML configuration)
    
    Specified by:
    
    isLibrarySearchEnabled in interface ConfigurationService
    
    Returns:
    
    true if so
  - getConfigurationParameter
```
protected String getConfigurationParameter(String parameter)
```
    Get a named value from the site-specific XML configuration file
    
    Parameters:
    
    parameter - Configuration parameter to lookup
    
    Returns:
    
    Parameter value (null if none [or error])
  - getSiteOsidConfiguration
```
protected SiteOsidConfiguration getSiteOsidConfiguration()
```
    Load and initialize the site-specific OSID configuration code
    
    Returns:
    
    The initialized, site-specific OSID configuration object (null on error)
  - getConfigurationHandler
```
public SiteOsidConfiguration getConfigurationHandler(String osidConfigHandler)
                                              throws ClassNotFoundException,
                                                     InstantiationException,
                                                     IllegalAccessException
```
    Return a SiteOsidConfiguration instance
    
    Returns:
    
    A SiteOsidConfiguration
    
    Throws:
    
    ClassNotFoundException
    
    InstantiationException
    
    IllegalAccessException
  - populateConfig
```
public void populateConfig(String configurationXml,
                           InputStream stream)
```
    Populate cached values from a configuration XML resource. We always try to parse the resource, regardless of any prior success or failure.
    
    Parameters:
    
    configurationXml - Configuration resource name (this doubles as a unique key into the configuration cache)
  - saveServletClientMappings
```
protected void saveServletClientMappings(Document document)
```
  - saveParameter
```
protected void saveParameter(Document document,
                             Map parameterMap,
                             String name)
```
    Lookup and save one dynamic configuration parameter
    
    Parameters:
    
    Configuration - XML
    
    parameterMap - Parameter name=value pairs
    
    name - Parameter name
  - parseXmlFromStream
```
protected Document parseXmlFromStream(InputStream stream)
```
    Parse an XML resource
    
    Parameters:
    
    filename - The filename (or URI) to parse
    
    Returns:
    
    DOM Document (null if parse fails)
  - getXmlDocumentBuilder
```
protected DocumentBuilder getXmlDocumentBuilder()
```
    Get a DOM Document builder.
    
    Returns:
    
    The DocumentBuilder
    
    Throws:
    
    DomException
  - normalizeText
```
protected String normalizeText(String original,
                               String update)
```
    "Normalize" XML text node content to create a simple string
    
    Parameters:
    
    original - Original text
    
    update - Text to add to the original string (a space separates the two)
    
    Returns:
    
    Concatenated contents (trimmed)
  - getText
```
protected String getText(Document root,
                         String elementName)
```
    Get the text associated with this element
    
    Parameters:
    
    root - The document containing the text element
    
    Returns:
    
    Text (trimmed of leading/trailing whitespace, null if none)
  - getText
```
protected String getText(Element root,
                         String elementName)
```
    Get the text associated with this element
    
    Parameters:
    
    root - The root node of the text element
    
    Returns:
    
    Text (trimmed of leading/trailing whitespace, null if none)
  - init
```
public void init()
```
  - destroy
```
public void destroy()
```
  - getOsidImpl
```
public String getOsidImpl()
```
    Returns:
    
    the OSID package name
  - setOsidImpl
```
public void setOsidImpl(String osidImpl)
```
    Parameters:
    
    osidImpl - the OSID package name
  - getExtendedRepositoryId
```
public String getExtendedRepositoryId()
```
    Returns:
    
    the extended Repository ID
  - setExtendedRepositoryId
```
public void setExtendedRepositoryId(String extendedRepositoryId)
```
    Parameters:
    
    extendedRepositoryId - the extended Repository ID
  - getMetasearchUsername
```
public String getMetasearchUsername()
```
    Returns:
    
    the m_metasearchUsername
  - setMetasearchUsername
```
public void setMetasearchUsername(String username)
```
    Parameters:
    
    username - the m_metasearchUsername to set
  - getMetasearchBaseUrl
```
public String getMetasearchBaseUrl()
```
    Returns:
    
    the m_metasearchBaseUrl
  - setMetasearchBaseUrl
```
public void setMetasearchBaseUrl(String baseUrl)
```
    Parameters:
    
    baseUrl - the m_metasearchBaseUrl to set
  - getMetasearchPassword
```
public String getMetasearchPassword()
```
    Returns:
    
    the m_metasearchPassword
  - setMetasearchPassword
```
public void setMetasearchPassword(String password)
```
    Parameters:
    
    password - the m_metasearchPassword to set
  - getGoogleBaseUrl
```
public String getGoogleBaseUrl()
```
    Returns:
    
    the Google base URL
  - setGoogleBaseUrl
```
public void setGoogleBaseUrl(String googleBaseUrl)
```
    Parameters:
    
    googleBaseUrl - the base URL to set
  - getSakaiServerKey
```
public String getSakaiServerKey()
```
    Returns:
    
    the sakaiServerKey
  - setSakaiServerKey
```
public void setSakaiServerKey(String sakaiId)
```
    Parameters:
    
    sakaiServerKey - the sakaiServerKey to set
  - getOpenUrlLabel
```
public String getOpenUrlLabel()
```
    Returns:
    
    the OpenURL label
  - setOpenUrlLabel
```
public void setOpenUrlLabel(String openUrlLabel)
```
    Parameters:
    
    set - the OpenURL label
  - getOpenUrlResolverAddress
```
public String getOpenUrlResolverAddress()
```
    Returns:
    
    the OpenURL resolver address
  - setOpenUrlResolverAddress
```
public void setOpenUrlResolverAddress(String openUrlResolverAddress)
```
    Parameters:
    
    set - the OpenURL resolver address
  - getDatabaseXml
```
public String getDatabaseXml()
```
    Returns:
    
    the database hierarchy XML filename/URI
  - setDatabaseXml
```
public void setDatabaseXml(String databaseXml)
```
    Parameters:
    
    set - the database hierarchy XML filename/URI
  - getSiteConfigXml
```
public String getSiteConfigXml()
```
    Returns:
    
    the configuration XML filename/URI
  - setSiteConfigXml
```
public void setSiteConfigXml(String siteConfigXml)
```
    Parameters:
    
    set - the configuration XML filename/URI
  - getServerConfigurationService
```
public ServerConfigurationService getServerConfigurationService()
```
    Returns:
    
    the serverConfigurationService
  - setServerConfigurationService
```
public void setServerConfigurationService(ServerConfigurationService serverConfigurationService)
```
    Parameters:
    
    serverConfigurationService - the serverConfigurationService to set
  - setSessionManager
```
public void setSessionManager(SessionManager sessionManager)
```
    Parameters:
    
    sessionManager - the SessionManager to save
  - getSessionManager
```
public SessionManager getSessionManager()
```
    Returns:
    
    the SessionManager
  - getOsidConfig
```
public String getOsidConfig()
```
    Returns:
    
    the site specific "OSID configuration" package name
  - setOsidConfig
```
public void setOsidConfig(String osidConfig)
```
    Parameters:
    
    osidConfig - the site specific "OSID configuration" package name
  - getGoogleSearchEnabled
```
public String getGoogleSearchEnabled()
```
    Returns:
    
    Google search support status
  - setGoogleSearchEnabled
```
public void setGoogleSearchEnabled(String googleSearchEnabled)
```
    Parameters:
    
    googleSearchEnabled - ("true" or "false")
  - getLibrarySearchEnabled
```
public String getLibrarySearchEnabled()
```
    Returns:
    
    library search support status
  - setLibrarySearchEnabled
```
public void setLibrarySearchEnabled(String librarySearchEnabled)
```
    Parameters:
    
    librarySearchEnabled - ("true" or "false")
  - getAdminSiteName
```
public String getAdminSiteName()
```
    Returns:
    
    the adminSiteName
  - setAdminSiteName
```
public void setAdminSiteName(String adminSiteName)
```
    Parameters:
    
    adminSiteName - the adminSiteName to set
  - getConfigFolder
```
public String getConfigFolder()
```
    Returns:
    
    the configFolder
  - setConfigFolder
```
public void setConfigFolder(String configFolder)
```
    Parameters:
    
    configFolder - the configFolder to set
  - getConfigXmlCache
```
public String getConfigXmlCache()
```
    Returns:
    
    the configFile
  - setConfigXmlCache
```
public void setConfigXmlCache(String configXml)
```
    Parameters:
    
    configFile - the configFile to set
  - getDatabaseXmlCache
```
public String getDatabaseXmlCache()
```
    Returns:
    
    the categoriesXml resource names
  - setDatabaseXmlCache
```
public void setDatabaseXmlCache(String categoriesXml)
```
    Parameters:
    
    categoriesXml - the categoriesXml to set
  - getSaveciteClients
```
public Map<String,List<Map<String,String>>> getSaveciteClients()
```
    Specified by:
    
    getSaveciteClients in interface ConfigurationService
    
    Returns:
    
    the saveciteClients
  - setSaveciteClients
```
public void setSaveciteClients(Map<String,List<Map<String,String>>> saveciteClients)
```
    Parameters:
    
    saveciteClients - the saveciteClients to set
  - getSaveciteClientsForLocale
```
public List<Map<String,String>> getSaveciteClientsForLocale(Locale locale)
```
    Specified by:
    
    getSaveciteClientsForLocale in interface ConfigurationService
  - addMapToStringBuilder
```
protected void addMapToStringBuilder(StringBuilder buf,
                                     Map map,
                                     int indent,
                                     int indentIncrement)
```
  - addListToStringBuilder
```
protected void addListToStringBuilder(StringBuilder buf,
                                      List list,
                                      int indent,
                                      int indentIncrement)
```
  - getAllCategoryXml
```
public Collection<String> getAllCategoryXml()
```
    Specified by:
    
    getAllCategoryXml in interface ConfigurationService
  - update
```
public void update(Observable arg0,
                   Object arg1)
```
    Called when an observed object chnages (@see java.util.Observer#update)
    
    Specified by:
    
    update in interface Observer
    
    Parameters:
    
    arg0 - - The observed object
    
    arg1 - - Event argument
  - updateConfig
```
protected void updateConfig(String configFileRef)
```
    Update configuration data from an XML resource
    
    Parameters:
    
    configFileRef - XML configuration reference (/content/...)
  - enableSecurityAdvisor
```
protected SecurityAdvisor enableSecurityAdvisor()
```
    Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions.
    
    Returns:
    
    the advisor
  - librarySearchEnabled
```
public boolean librarySearchEnabled()
```
    Is library search enabled for the current user?
    
    Specified by:
    
    librarySearchEnabled in interface ConfigurationService
    
    Returns:
    
    true if so
  - setExternalSearchEnabled
```
public void setExternalSearchEnabled(boolean state)
```
    Specified by:
    
    setExternalSearchEnabled in interface ConfigurationService
  - isExternalSerarchEnabled
```
public boolean isExternalSerarchEnabled()
```
    Specified by:
    
    isExternalSerarchEnabled in interface ConfigurationService
  - setExternalSearchUrl
```
public void setExternalSearchUrl(String url)
```
    Specified by:
    
    setExternalSearchUrl in interface ConfigurationService
  - getExternalSearchUrl
```
public String getExternalSearchUrl()
```
    Specified by:
    
    getExternalSearchUrl in interface ConfigurationService
  - getSecondsBetweenSaveciteRefreshes
```
public String getSecondsBetweenSaveciteRefreshes()
```
    Specified by:
    
    getSecondsBetweenSaveciteRefreshes in interface ConfigurationService

Class BaseConfigurationService

Field Summary

Fields inherited from interface org.sakaiproject.citation.api.ConfigurationService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SECONDS_BETWEEN_SAVECITE_REFRESHES

MAXIMUM_SECONDS_BETWEEN_SAVECITE_REFRESHES

PARAM_SECONDS_BETWEEN_SAVECITE_REFRESHES

m_citationsEnabledByDefault

m_allowSiteBySiteOverride

m_googleSearchEnabled

m_librarySearchEnabled

m_externalSearchEnabled

m_adminSiteName

m_configFolder

m_configXml

m_categoriesXml

m_updatableResources

m_databaseXml

m_siteConfigXml

m_metasearchUsername

m_metasearchPassword

m_metasearchBaseUrl

m_osidImpl

m_extendedRepositoryId

m_openUrlLabel

m_openUrlResolverAddress

m_googleBaseUrl

m_sakaiServerKey

m_externalSearchUrl

m_osidConfig

m_sessionManager

m_serverConfigurationService

m_configMaps

m_configListRef

saveciteClients

Constructor Detail

BaseConfigurationService

Method Detail

getConfigurationXml

isConfigurationXmlAvailable

getConfigFolderReference

getConfigFolderId

getDatabaseHierarchyXml

isDatabaseHierarchyXmlAvailable

getGroupIds

getSiteConfigOsidPackageName

getSiteConfigExtendedRepositoryId

getSiteConfigMetasearchUsername

getSiteConfigMetasearchPassword

getSiteConfigMetasearchBaseUrl

getSiteConfigOpenUrlLabel

getSiteConfigOpenUrlResolverAddress

getSiteConfigGoogleBaseUrl

getSiteConfigSakaiServerKey

getSiteConfigMaximumSearchableDBs

getSiteConfigUsePreferredUrls

getSiteConfigPreferredUrlPrefix

setCitationsEnabledByDefault

isCitationsEnabledByDefault

setAllowSiteBySiteOverride

isAllowSiteBySiteOverride

setGoogleScholarEnabled

isGoogleScholarEnabled

setLibrarySearchEnabled

isLibrarySearchEnabled

getConfigurationParameter

getSiteOsidConfiguration

getConfigurationHandler

populateConfig

saveServletClientMappings

saveParameter

parseXmlFromStream

getXmlDocumentBuilder

normalizeText

getText

getText

init