| Section | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Citations Dynamic Configuration Overview
Dynamic Configuration allows you to select an appropriate Citations configuration for each individual user – this is done on-the-fly, at runtime. A The configuration is chosen based on a set of user characteristics that reflect the needs of your institution. This might include campus affiliation, guest status, etc.
...
At my institution, users affiliated with West Campus use Sirsi SingleSearch, and users affiliated with East Campus use Ex Libris MetaLib.
To handle our the example scenario, we'll need two sets of XML configuration files, one set for SingleSearch and another set for MetaLib, as well as .
We'll also need a site-specific implementation of the SiteOsidConfiguration API interface. The Our custom SiteOsidConfiguration implementation selects will select the appropriate configuration files at runtime, when the Citations Helper is invoked.
API Interface
The Citations code provides a Java interface that defines methods used by the Citations Helper to find appropriate configuration information for a given user. See:
org.sakaiproject.citation.api.SiteOsidConfiguration
Implementation
A The SiteOsidConfiguration implementation picks the proper selects appropriate XML configuration files for the current user, . The selction is typically based on that various user 's contextattributes: campus and course affiliations, guest status, etc. – basically, whatever attributes make sense for your institution.
Default Implementation
The default SiteOsidConfiguration API implementation provided with the Citations Helper is available here:
...
Your custom implementation of the SiteOsidConfiguration API needs to make the same three decisions outlined above.
It may be easiest to modify the default implementation, SampleSiteOsidConfiguration.java, with any changes required to address the needs at your site. Your updated code can be compiled and deployed using the normal Citations build procedure.
...
In our example scenario, we'll need to provide the names of our configuration and search categories files in sakai.properties. One set is for East Campus, the other is for West Campus.
...