...
To handle our example scenario, we'll need two sets of XML configuration files, one set for SingleSearch and one another for MetaLib, as well as a site-specific implementation of the SiteOsidConfiguration
API interface. The custom SiteOsidConfiguration
implementation selects the appropriate configuration files at runtime, when the Citations Helper is invoked.
...
- Which XML configuration file is appropriate for this user?
The Java code returns the name of XML file that describes the proper configuration. SeegetConfigurationXml()
inSampleSiteOsidConfiguration
. - Which databases are available to this user?
The Java code returns the name of an XML file that describes the database hierarchy. SeegetDatabaseHierarchyXml()
inSampleSiteOsidConfiguration
. - What groups (if any) does this user belong to?
Groups allow the Citation Helper to decide which portions of the database hierarchy are available to the current user. In the Search Categories & Databases XML documentation, you will see that each defined database can have associated database-groups.
SeegetGroupIds()
inSampleSiteOsidConfiguration
for a simple implementation.
Custom Implementation
A custom, site specific SiteOsidConfiguration
implementation makes Your custom implementation of the SiteOsidConfiguration
API will make the same three decisions outlined above.
...