DSpace Services API 2.0.2 API

The DSpace Services Framework provides the infrastructure of a more componentized realization of DSpace.

See:
Description

Packages

org.dspace.constants	Manifest constants naming configuration data for core services.
org.dspace.kernel	The DSpace Services kernel and service manager.
org.dspace.kernel.mixins	Interfaces for interacting with the startup, shutdown, or reconfiguration of the framework.
org.dspace.providers	Pluggable alternatives for some core functions.
org.dspace.services	Core DSpace service definitions.
org.dspace.services.model	Defines types managed by the core services.

The DSpace Services Framework provides the infrastructure of a more componentized realization of DSpace. Services, plugins, and providers are registered with the framework so that they can find each other without having to know each other too intimately. This should make it easier to maintain, extend, and understand DSpace as it evolves.

The framework consists of:

kernel

initializes and starts the framework, grants ready access to core services

service manager

instantiates, configures, and controls services

core services

configuration, events, and the like

utilities

includes the DSpace object, a starting point in using the framework

To use the Services Framework, start by creating a running kernel instance.

• In a standalone application, you can call org.dspace.servicemanager.DSpaceKernelInit#getKernel to get a reference to one.
• In a Spring container, you need to ensure that spring/spring-dspace-applicationContext.xml and spring/spring-dspace-core-services.xml are loaded. Then you can wire references to
  • org.dspace.services.CachingService
  • org.dspace.services.SessionService
  • org.dspace.services.RequestService
  • org.dspace.services.EventService
  into your beans as needed.
• In a servlet container, you should configure a context listener to instantiate the kernel and a filter to establish the connection between the web application and the framework.

See Also:

DSpace Services Framework