org.sakaiproject.citation.impl

Class SakaiOsidLoader

java.lang.Object

org.sakaiproject.citation.impl.SakaiOsidLoader

All Implemented Interfaces:

Serializable

public class SakaiOsidLoader
extends Object
implements Serializable

OsidLoader loads a specific implementation of an Open Service Interface Definition (OSID) with its getManager method. The getManager method loads an instance of the OSID's org.osid.OsidManager, assigns the manager's OsidContext, assigns any configuration information, and returns the instance of the OSID implementation. This usage of the getManager method in the OsidLoader is how applications should bind a particular implementation to an OSID. The value of this approach is that an application can defer which specific OSID implementation is used until runtime. The specific implementation package name can then be part of the configuration information rather than being hard coded. Changing implementations is simplified with this approach.

As an example, in order to create a new Hierarchy, an application does not use the new operator. It uses the OsidLoader getManager method to get an instance of a class that implements HierarchyManager (a subclass of org.osid.OsidManager). The application uses the HierarchyManager instance to create the Hierarchy. It is the createHierarchy() method in some package (e.g. org.osid.hierarchy.impl.HierarchyManager) which uses the new operator on org.osid.hierarchy.impl.Hierarchy, casts it as org.osid.hierarchy.Hierarchy, and returns it to the application. This indirection offers the significant value of being able to change implementations in one spot with one modification, namely by using a implementation package name argument for the OsidLoader getManager method.

Sample:

org.osid.OsidContext myContext = new org.osid.OsidContext();
String key = "myKey";
myContext.assignContext(key, "I want to save this string as context");
String whatWasMyContext = myContext.getContext(key);
org.osid.hierarchy.HierarchyManager hierarchyManager =

org.osid.OsidLoader.getManager("org.osid.hierarchy.HierarchyManager","org.osid.shared.impl",myContext,null);

org.osid.hierarchy.Hierarchy myHierarchy = hierarchyManager.createHierarchy(...);

A similar technique can be used for creating other objects. OSIDs that have org.osid.OsidManager implementations loaded by OsidLoader, will define an appropriate interface to create these objects.

The arguments to OsidLoader.getManager method are the OSID org.osid.OsidManager interface name, the implementing package name, the OsidContext, and any additional configuration information.

OSID Version: 2.0

Licensed under the MIT O.K.I. OSID Definition License.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SakaiOsidLoader()

Method Summary

Modifier and Type	Method and Description
static InputStream	getConfigStream(String fileName, Class curClass) Get an InputStream for a particular file name - first check the sakai.home area and then revert to the classpath.
static org.osid.OsidManager	getManager(String osidPackageManagerName, String implPackageName, org.osid.OsidContext context, Properties additionalConfiguration) Returns an instance of the org.osid.OsidManager of the OSID specified by the OSID package org.osid.OsidManager interface name and the implementation package name.

Methods inherited from class java.lang.Object

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

Constructor Detail

SakaiOsidLoader

public SakaiOsidLoader()

Method Detail

getConfigStream

public static InputStream getConfigStream(String fileName,
                                          Class curClass)

Get an InputStream for a particular file name - first check the sakai.home area and then revert to the classpath. This is a utility method used several places.

getManager

public static org.osid.OsidManager getManager(String osidPackageManagerName,
                                              String implPackageName,
                                              org.osid.OsidContext context,
                                              Properties additionalConfiguration)
                                       throws org.osid.OsidException

Returns an instance of the org.osid.OsidManager of the OSID specified by the OSID package org.osid.OsidManager interface name and the implementation package name. The implementation class name is constructed from the SID package Manager interface name. A configuration file name is constructed in a similar manner and if the file exists it is loaded into the implementation's org.osid.OsidManager's configuration.

Example: To load an implementation of the org.osid.Filing OSID implemented in a package "xyz", one would use:

org.osid.filing.FilingManager fm = (org.osid.filing.FilingManager)org.osid.OsidLoader.getManager(

"org.osid.filing.FilingManager" ,

"xyz" ,

new org.osid.OsidContext());

Parameters:

osidPackageManagerName - osidPackageManagerName is a fully qualified org.osid.OsidManager interface name

implPackageName - implPackageName is a fully qualified implementation package name

context -

additionalConfiguration -

Returns:

org.osid.OsidManager

Throws:

org.osid.OsidException - An exception with one of the following messages defined in org.osid.OsidException: OPERATION_FAILED, NULL_ARGUMENT, VERSION_ERROR, =INTERFACE_NOT_FOUND, =MANAGER_NOT_FOUND, =MANAGER_INSTANTIATION_ERROR, =ERROR_ASSIGNING_CONTEXT, =ERROR_ASSIGNING_CONFIGURATION