org.sakaiproject.citation.impl

Class SampleSiteOsidConfiguration

java.lang.Object

org.sakaiproject.citation.impl.SampleSiteOsidConfiguration

All Implemented Interfaces:

org.sakaiproject.citation.api.SiteOsidConfiguration

public class SampleSiteOsidConfiguration
extends Object
implements org.sakaiproject.citation.api.SiteOsidConfiguration

Sample Repository OSID configuration

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORIES_XML
static String	CONFIGURATION_XML
static String	FULL_ACCESS_GROUP
static String	GUEST_ACCESS_GROUP

Constructor Summary

Constructors

Constructor and Description
SampleSiteOsidConfiguration() Simple public constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getConfigurationXml() Fetch the appropriate XML configuration document for this user.
String	getDatabaseHierarchyXml() /** Fetch the appropriate XML database document for this user.
List<String>	getGroupIds() Fetch this user's group affiliations (ALL in this example)
void	init() Initialization - do whatever is appropriate here

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CATEGORIES_XML

public static final String CATEGORIES_XML

See Also:

Constant Field Values

CONFIGURATION_XML

public static final String CONFIGURATION_XML

See Also:

Constant Field Values

FULL_ACCESS_GROUP

public static final String FULL_ACCESS_GROUP

See Also:

Constant Field Values

GUEST_ACCESS_GROUP

public static final String GUEST_ACCESS_GROUP

See Also:

Constant Field Values

Constructor Detail

SampleSiteOsidConfiguration

public SampleSiteOsidConfiguration()

Simple public constructor

Method Detail

init

public void init()
          throws org.sakaiproject.citation.util.api.OsidConfigurationException

Initialization - do whatever is appropriate here

Specified by:

init in interface org.sakaiproject.citation.api.SiteOsidConfiguration

Throws:

org.sakaiproject.citation.util.api.OsidConfigurationException

getConfigurationXml

public String getConfigurationXml()
                           throws org.sakaiproject.citation.util.api.OsidConfigurationException

Fetch the appropriate XML configuration document for this user. Typically, this will be a path relative to the root folder for citations configurations ( e.g. samples/config.xml)

Return null to force the use of the siteConfigXml property from components.xml

Specified by:

getConfigurationXml in interface org.sakaiproject.citation.api.SiteOsidConfiguration

Returns:

Configuration XML (eg config.xml or samples/config.xml)

Throws:

org.sakaiproject.citation.util.api.OsidConfigurationException

getDatabaseHierarchyXml

public String getDatabaseHierarchyXml()
                               throws org.sakaiproject.citation.util.api.OsidConfigurationException

/** Fetch the appropriate XML database document for this user. Typically, this will be a path relative to the root folder for citations configurations ( e.g. samples/categories.xml)

Return null to force the use of the databaseXml property from components.xml

Specified by:

getDatabaseHierarchyXml in interface org.sakaiproject.citation.api.SiteOsidConfiguration

Returns:

Hierarchy XML (eg categories.xml or samples/categories.xml)

Throws:

org.sakaiproject.citation.util.api.OsidConfigurationException

getGroupIds

public List<String> getGroupIds()
                         throws org.sakaiproject.citation.util.api.OsidConfigurationException

Fetch this user's group affiliations (ALL in this example)

Specified by:

getGroupIds in interface org.sakaiproject.citation.api.SiteOsidConfiguration

Returns:

A list of group ID strings (empty if no IDs exist)

Throws:

org.sakaiproject.citation.util.api.OsidConfigurationException