| Tip | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
...
Overview
Dynamic Configuration allows you to provide various authorization rules for different groups of Citations Helper users. This configuration method requires modifications to the default SiteOsidConfiguration API implementation, org.sakaiproject.citation.impl.SampleSiteOsidConfiguration.
...
API Interface
The org.sakaiproject.citation.api.SiteOsidConfiguration interface defines several methods that allow the Citations Helper to use different sets of configuration information, based on the current user's context - campus and course affiliations, guest status, etc.
For example, at my institution users affiliated with West Campus use Sirsi SingleSearch, and users affiliated with East Campus use Ex Libris MetaLib. To handle this there will need to be two sets of configuration information, one for SingleSearch and one for MetaLib, as well as a mechanism to determine which configuration to use for a given user. That mechanism is a site-specific implementation of the SiteOsidConfiguration API interface. Different sets of configuration information are maintained in separate XML files, and the SiteOsidConfiguration implementation selects the appropriate configuration files dynamically, when the Citations Helper is invoked.
...
Default Implementation
The org.sakaiproject.citation.impl.SampleSiteOsidConfiguration class is the default SiteOsidConfiguration API implementation used by the Citations Helper.
...
osidConfig@org.sakaiproject.citation.api.ConfigurationService=<full class name>- The default value for this property is
org.sakaiproject.citation.impl.SampleSiteOsidConfiguration
- The default value for this property is
| Anchor | ||||
|---|---|---|---|---|
|
...
XML Configuration Files
XML configuration files allow you to provide configuration information for different groups of users. The format of this XML file is very straightforward, simply setting the values of various properties. All of the properties are also Sakai properties that can be set through the sakai.properties file and that you may have already seen elsewhere in the documentation. Properties set in XML configuration files override those that are set through sakai.properties. If you want to use certain values from sakai.properties and override others, only include the properties you would like to override in the XML configuration file.
...