Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A custom Java implementation of the SiteOsidConfiguration API is required when setting to set up a Dynamic Configuration.

...

    org.sakaiproject.citation.impl.SampleSiteOsidConfiguration

This class needs to make makes three basic decisions:

  1. Which XML configuration file is appropriate for this user?

    The Java code returns the name of XML file that describes the proper configuration. See getConfigurationXml() in SampleSiteOsidConfiguration.

  2. Which databases are available to this user?

    The Java code returns the name of an XML file that describes the database hierarchy. See getDatabaseHierarchyXml() in SampleSiteOsidConfiguration.

  3. 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.

    See getGroupIds() in SampleSiteOsidConfiguration for a simple implementation.

Custom Implementation

A custom (or , site specific ) SiteOsidConfiguration implementation needs to make makes the same three decisions outlined above.

...

To establish a dynamic configuration, changes are made to sakai.properties. In addition, you 'll probably may need to create multiple sets of XML configuration and search category files.

...