Versions Compared

Key

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

...

Table of Contents
excludeSummary

Download

Getting Okapia jars from the maven repository.

Try An Example

Clone a sample application and OSID Provider:

Code Block
% git clone githttps://git.assembla.com/osidbitbucket.org/okapia/9-planets-sample.git
% cd osid9-planets-sample
% make run

If you count nine planets, your OSID environment is working. Anything less then there was would be a serious problem.

What It Does

OSID Consumer

net.okapia.osid.sample.Test illustrates the basics of consuming an OSID. 

  • Starting up the OSID Runtime environment.
  • Loading a Resource OSID Provider
  • Getting some stuff from it.

OSID Provider

The OSID Resource OSID Provider is net.okapia.osid.sample.providers.resource.solarsystem. It demonstrates :the basics of an OSID Provider using the Okapia OSID implementation framework.

  • An OsidManager.
  • Setting up the identity of the service provider.
  • Implementing a simple OsidSession.
  • Implementing an OsidRecord attached to an OsidObject.

Source Navigation

Resource OSID Consumer

net.okapia.osid.sample.Planets is the sample application. It performs the following:

  1. Starts up an OsidRuntimeManager via a Bootloader
  2. Gets the net.okapia.osid.sample.providers.resource.solarsystem.ResourceManager Resource OSID Provider via the OsidRuntimeManager.
  3. Gets a ResourceLookupSession via the ResourceManager.
  4. Gets a stream of Resources via the ResourceLookupSession.
  5. Iterates through the ResourceList and displays them.
  6. Shuts down the Resource OSID Provider and OSID Runtime.

Resource OSID Provider

The shaded rows indicate classes that directly implement an OSID. The others are supporting files.

...

Configuration

An example configuration for this OSID Resource Provider is net.okapia.osid.sample.providers.resource.solarsystem

...

.

...

ResourceManager.xml

...

.

...

Package Dependencies

The OSID Java Language Binding is in a jar OSID-<version>.jar. The other package dependencies are part of the Okapia OSID implementation framework.

Looking at the class files in the Resource OSID Provider, you can see that they extend classes in this framework and often make use of other Okapia tools in them. 

Methods annotated with 

@OSID @Override

directly implement an OSID method in an OSID.