01: /*******************************************************************************
02: * $URL:
03: * $Id:
04: * **********************************************************************************
05: *
06: * Copyright (c) 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the
09: * "License"); you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16: * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17: * License for the specific language governing permissions and limitations under
18: * the License.
19: *
20: ******************************************************************************/package org.sakaiproject.citation.api;
21:
22: import java.util.List;
23: import org.sakaiproject.citation.util.api.OsidConfigurationException;
24:
25: /**
26: * Repository OSID configuration
27: */
28: public interface SiteOsidConfiguration {
29: /**
30: * Initialize
31: */
32: public void init() throws OsidConfigurationException;
33:
34: /**
35: * Fetch the appropriate XML configuration document for this user
36: * @return Configuration XML (eg file:///tomcat-home/sakai/config.xml)
37: */
38: public String getConfigurationXml()
39: throws OsidConfigurationException;
40:
41: /**
42: * Fetch the appropriate XML database hierarchy document for this user
43: * @return Hierarchy XML (eg file:///tomcat-home/sakai/database.xml)
44: */
45: public String getDatabaseHierarchyXml()
46: throws OsidConfigurationException;
47:
48: /**
49: * Fetch this user's group affiliations
50: * @return A list of group IDs (empty if no IDs exist)
51: */
52: public List<String> getGroupIds() throws OsidConfigurationException;
53: }
|