...
At my institution, users affiliated with West Campus use Sirsi SingleSearch, and users affiliated with East Campus use Ex Libris MetaLib.
API Interface
The org.sakaiproject.citation.api.SiteOsidConfiguration
interface defines several methods that allow Citations code provides a Java interface that defines methods used by the Citations Helper to locate the find appropriate configuration information for a given user. See:
org.sakaiproject.citation.api.SiteOsidConfiguration
Typically, a SiteOsidConfiguration
implementation will select a set of XML configuration files based on that a user's context – campus and course affiliations, guest status, etc.
To handle our example scenario, we'll need two sets of configuration information, one for SingleSearch and one for MetaLib, as well as a mechanism to determine which configuration to use for any 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 The SiteOsidConfiguration
implementation selects the appropriate configuration files at runtime, when the Citations Helper is invoked.
Default Implementation
The default SiteOsidConfiguration
API implementation provided with the Citations Helper is available here:
org.sakaiproject.citation.impl.SampleSiteOsidConfiguration
class is the default SiteOsidConfiguration
API implementation used by the Citations Helper.
This class makes three decisions:
...