A C D E F G I K L M N O P Q R S T U V X

A

Activator - Interface in org.dspace.kernel
An activator is a special type which allows a provider to be plugged into the system by dropping a jar file in with the kernel and adding in a hook in the configuration file.

C

Cache - Interface in org.dspace.services.model
This is a cache which can be used to store data.
CacheConfig - Class in org.dspace.services.model
Encodes the configuration for a cache into an object.
CacheConfig(CacheConfig.CacheScope) - Constructor for class org.dspace.services.model.CacheConfig
Configure the cache to use the given scope.
CacheConfig.CacheScope - Enum in org.dspace.services.model
Controls the scope of each created cache.
CacheProvider - Interface in org.dspace.providers
This is a provider (pluggable functionality) for DSpace.
CachingService - Interface in org.dspace.services
A service to manage creation and retrieval of caches.
checkName(String) - Static method in class org.dspace.kernel.DSpaceKernelManager
Ensure that we have a name suitable for an mbean.
clear() - Method in interface org.dspace.services.model.Cache
Clear out all cached items from this cache.
clear() - Method in interface org.dspace.services.model.Session
Purges all data from this session and effectively resets it to an anonymous session.
CommonLifecycle<T> - Interface in org.dspace.kernel
Beans that have a lifecycle and can be controlled via their lifecycle implement this interface.
ConfigChangeListener - Interface in org.dspace.kernel.mixins
Allow a service to be notified when a configuration change occurs.
configurationChanged(List<String>, Map<String, String>) - Method in interface org.dspace.kernel.mixins.ConfigChangeListener
Called whenever the configuration settings change (depending on the filter).
ConfigurationService - Interface in org.dspace.services
This service handles retrieval of the configuration data for a DSpace instance.
Constants - Class in org.dspace.constants
All core DSpace Services constants.
Constants() - Constructor for class org.dspace.constants.Constants
 

D

DATABASE_CONN_POOLING - Static variable in class org.dspace.constants.Constants
Set this to true (the default) to enable connection pooling.
DATABASE_CONNECTION_KEY - Static variable in class org.dspace.constants.Constants
JDBC database connection URL.
DATABASE_DRIVER_KEY - Static variable in class org.dspace.constants.Constants
Class of the JDBC driver.
DATABASE_PASSWORD_KEY - Static variable in class org.dspace.constants.Constants
Database connection password.
DATABASE_TYPE_KEY - Static variable in class org.dspace.constants.Constants
Configuration key for the name of the DBMS being used.
DATABASE_USERNAME_KEY - Static variable in class org.dspace.constants.Constants
Database connection user.
DEFAULT_ENCODING - Static variable in class org.dspace.constants.Constants
 
destroy() - Method in interface org.dspace.kernel.CommonLifecycle
Destroy the managed bean entirely.
destroyCache(String) - Method in interface org.dspace.providers.CacheProvider
Flush and destroy the cache with this name.
destroyCache(String) - Method in interface org.dspace.services.CachingService
Flushes and destroys the cache with this name.
DSPACE_TESTING_MODE - Static variable in class org.dspace.constants.Constants
If this is set to true then DSpace kernel is run as if it is inside a unit test.
DSPACE_TIMER_NAME - Static variable in class org.dspace.constants.Constants
This is the name of the timer thread for all DSpace core timers.
DSpaceKernel - Interface in org.dspace.kernel
This is the most core piece of the system: instantiating one will startup the dspace services framework.
DSpaceKernelManager - Class in org.dspace.kernel
Allows the DSpace kernel to be accessed if desired.
DSpaceKernelManager() - Constructor for class org.dspace.kernel.DSpaceKernelManager
 

E

endRequest(Exception) - Method in interface org.dspace.services.RequestService
Ends the current running request, this can indicate success or failure of the request, this will trigger the interceptors and normally would be caused by a servlet request ending, note that a request cannot be ended twice, once it is ended this will just return null
Event - Class in org.dspace.services.model
This holds all the settings related to an event in the system.
Event(String) - Constructor for class org.dspace.services.model.Event
Create a new event with the given name.
Event(String, String, boolean) - Constructor for class org.dspace.services.model.Event
Create a new event with the given name for the given resource (item, collection, etc.).
Event(String, String, boolean, boolean) - Constructor for class org.dspace.services.model.Event
Create a new event with the given name for the given resource (item, collection, etc.).
Event(String, String, String, boolean) - Constructor for class org.dspace.services.model.Event
Create a new event with the given name for the given user on the given resource (item, collection, etc.).
Event(String, String, String, Map<String, String>, Event.Scope[], boolean) - Constructor for class org.dspace.services.model.Event
Create a new event with the given name for the given user on the given resource (item, collection, etc.).
Event.Scope - Enum in org.dspace.services.model
The event scopes to send events to.
EventListener - Interface in org.dspace.services.model
These will be triggered when specific events occur in the system.
EventService - Interface in org.dspace.services
Allows the creation of system events and registration of event listeners for notification of system events.
exists(String) - Method in interface org.dspace.services.model.Cache
Check if a key exists in the cache.

F

fireEvent(Event) - Method in interface org.dspace.services.EventService
Fires an event immediately (does not add it to the queue).

G

get(String) - Method in interface org.dspace.services.model.Cache
Gets an object from the cache if it can be found (maybe be a null).
getAllProperties() - Method in interface org.dspace.services.ConfigurationService
Get all currently known configuration settings
getAttribute(String) - Method in interface org.dspace.services.model.Request
 
getAttribute(String) - Method in interface org.dspace.services.model.Session
Get an attribute from the session if one exists.
getAttributes() - Method in interface org.dspace.services.model.Session
Get all attributes of this session.
getCache(String, CacheConfig) - Method in interface org.dspace.providers.CacheProvider
Construct a Cache with the given name (must be unique) OR retrieve the one that already exists with this name.
getCache(String, CacheConfig) - Method in interface org.dspace.services.CachingService
Construct a Cache with the given name OR retrieve the one that already exists with this name.
getCaches() - Method in interface org.dspace.providers.CacheProvider
Gets all the caches that this provider knows about.
getCaches() - Method in interface org.dspace.services.CachingService
Gets all the caches that the service knows about.
getCacheScope() - Method in class org.dspace.services.model.CacheConfig
 
getConfig() - Method in interface org.dspace.services.model.Cache
Returns a readable object which has the configuration used by this cache in it.
getConfigurationService() - Method in interface org.dspace.kernel.DSpaceKernel
 
getCurrentRequest() - Method in interface org.dspace.services.RequestService
Finds out of there is a request running in this thread and if so returns it
getCurrentRequestId() - Method in interface org.dspace.services.RequestService
Finds out of there is a request running in this thread and if so what the id of that request is.
getCurrentSession() - Method in interface org.dspace.services.SessionService
Start a new session and destroy any existing session that is known for this thread.
getCurrentSessionId() - Method in interface org.dspace.services.SessionService
Access the current session id for the current thread (also available from the current session).
getCurrentUserId() - Method in interface org.dspace.services.SessionService
Access the current user id for the current session.
getDefaultKernel() - Static method in class org.dspace.kernel.DSpaceKernelManager
 
getEventNamePrefixes() - Method in interface org.dspace.services.model.EventListener
This defines the events that you want to know about by event name.
getHttpServletRequest() - Method in interface org.dspace.services.model.Request
 
getHttpServletResponse() - Method in interface org.dspace.services.model.Request
 
getId() - Method in class org.dspace.services.model.Event
 
getKernel() - Method in class org.dspace.kernel.DSpaceKernelManager
Get the kernel.
getKernel(String) - Method in class org.dspace.kernel.DSpaceKernelManager
Get the kernel.
getKeys() - Method in interface org.dspace.services.model.Cache
Provides a method for finding out what keys are currently in the cache or getting all items out of the cache.
getManagedBean() - Method in interface org.dspace.kernel.CommonLifecycle
Gets a reference to the bean that is being managed inside this lifecycle.
getMBeanName() - Method in interface org.dspace.kernel.DSpaceKernel
 
getName() - Method in interface org.dspace.services.model.Cache
Get the unique name which identifies this cache.
getName() - Method in class org.dspace.services.model.Event
 
getOrder() - Method in interface org.dspace.kernel.mixins.OrderedService
Sets the order to load the bean which implements this method compared to other beans of the same type.
getOriginatingHostIP() - Method in interface org.dspace.services.model.Session
 
getOriginatingHostName() - Method in interface org.dspace.services.model.Session
 
getProperties() - Method in interface org.dspace.services.ConfigurationService
Convenience method - get all configuration properties (settings) from the system.
getProperties() - Method in class org.dspace.services.model.Event
 
getProperty(String) - Method in interface org.dspace.services.ConfigurationService
Convenience method - get a configuration property (setting) from the system.
getPropertyAsType(String, Class<T>) - Method in interface org.dspace.services.ConfigurationService
Get a configuration property (setting) from the system as a specified type.
getPropertyAsType(String, T) - Method in interface org.dspace.services.ConfigurationService
Get a configuration property (setting) from the system, or return a default value if none is found.
getPropertyAsType(String, T, boolean) - Method in interface org.dspace.services.ConfigurationService
Get a configuration property (setting) from the system, or return (and possibly store) a default value if none is found.
getRequestId() - Method in interface org.dspace.services.model.Request
 
getResourcePaths(ConfigurationService) - Method in interface org.dspace.kernel.config.SpringLoader
Returns all the locations that contain spring files
getResourcePrefix() - Method in interface org.dspace.services.model.EventListener
This defines the events that you want to know about by event resource (reference).
getResourceReference() - Method in class org.dspace.services.model.Event
Reference the resource affected by this event.
getScopes() - Method in class org.dspace.services.model.Event
 
getServerId() - Method in interface org.dspace.services.model.Session
 
getServiceByName(String, Class<T>) - Method in interface org.dspace.kernel.ServiceManager
Allows developers to get the desired service singleton by the provided name and type.
getServiceManager() - Method in interface org.dspace.kernel.DSpaceKernel
 
getServicesByType(Class<T>) - Method in interface org.dspace.kernel.ServiceManager
Allows developers to get the desired service singleton by the provided type.
getServicesNames() - Method in interface org.dspace.kernel.ServiceManager
Get the names of all registered service singletons.
getServletRequest() - Method in interface org.dspace.services.model.Request
 
getServletResponse() - Method in interface org.dspace.services.model.Request
 
getSession() - Method in interface org.dspace.services.model.Request
 
getSessionId() - Method in interface org.dspace.services.model.Session
 
getStatus(String) - Method in interface org.dspace.services.CachingService
Get a status report of cache usage which is suitable for log or screen output.
getUserEID() - Method in interface org.dspace.services.model.Session
Get the external/enterprise user ID for this session.
getUserId() - Method in class org.dspace.services.model.Event
 
getUserId() - Method in interface org.dspace.services.model.Session
Return the internal user ID for this session.

I

init() - Method in interface org.dspace.kernel.mixins.InitializedService
Executed after the service is created and all dependencies and configurations injected.
InitializedService - Interface in org.dspace.kernel.mixins
Allow the service or provider to be initialized when it is started by the service manager.
isActive() - Method in interface org.dspace.services.model.Session
 
isModify() - Method in class org.dspace.services.model.Event
Did this event modify something in the system?
isRunning() - Method in interface org.dspace.kernel.DSpaceKernel
 
isServiceExists(String) - Method in interface org.dspace.kernel.ServiceManager
Lookup to see if a service exists with the given name.

K

KERNEL_NAME - Static variable in interface org.dspace.kernel.DSpaceKernel
 

L

look(String) - Method in interface org.dspace.services.model.Cache
Gets an object from the cache without causing it to be refreshed or renewed.

M

MBEAN_NAME - Static variable in interface org.dspace.kernel.DSpaceKernel
 
MBEAN_PREFIX - Static variable in interface org.dspace.kernel.DSpaceKernel
 
MBEAN_SUFFIX - Static variable in interface org.dspace.kernel.DSpaceKernel
 

N

notifyForConfigNames() - Method in interface org.dspace.kernel.mixins.ConfigChangeListener
Allows the listener to filter the change notifications so it is only notified when the named configuration items change.
notifyForTypes() - Method in interface org.dspace.kernel.mixins.ServiceChangeListener
Allows filtering so that notifications are only sent when classes implement one of the types specified.

O

onEnd(String, Session, boolean, Exception) - Method in interface org.dspace.services.model.RequestInterceptor
Take actions after the request is handled for an operation.
onStart(String, Session) - Method in interface org.dspace.services.model.RequestInterceptor
Take actions before the request is handled for an operation.
OrderedService - Interface in org.dspace.kernel.mixins
Permit the service or provider to be ordered against other classes that implement the same interface (not this one).
org.dspace.constants - package org.dspace.constants
Manifest constants naming configuration data for core services.
org.dspace.kernel - package org.dspace.kernel
The DSpace Services kernel and service manager.
org.dspace.kernel.config - package org.dspace.kernel.config
 
org.dspace.kernel.mixins - package org.dspace.kernel.mixins
Interfaces for interacting with the startup, shutdown, or reconfiguration of the framework.
org.dspace.providers - package org.dspace.providers
Pluggable alternatives for some core functions.
org.dspace.services - package org.dspace.services
Core DSpace service definitions.
org.dspace.services.model - package org.dspace.services.model
Defines types managed by the core services.

P

pushConfig(Map<String, String>) - Method in interface org.dspace.kernel.ServiceManager
Allows new configuration settings to be pushed into the core DSpace configuration.
put(String, Object) - Method in interface org.dspace.services.model.Cache
Puts an object in the cache which is identified by this key.

Q

queueEvent(Event) - Method in interface org.dspace.services.EventService
Queues up an event to be fired at the end of a successful request/transaction.

R

receiveEvent(Event) - Method in interface org.dspace.services.model.EventListener
Called when an event occurs which passes through the filters created by EventListener.getEventNamePrefixes() and EventListener.getResourcePrefix().
registerEventListener(EventListener) - Method in interface org.dspace.services.EventService
Register an event listener which will be notified when events occur.
registerMBean(String, DSpaceKernel) - Static method in class org.dspace.kernel.DSpaceKernelManager
Register a new kernel MBean with the given name or fail
registerRequestInterceptor(RequestInterceptor) - Method in interface org.dspace.services.RequestService
Allows developers to perform actions on the start and end of the request cycle, if you decide you do not need to use your interceptor anymore then simply destroy it (dereference it) and the service will stop calling it, along those lines you should not register an interceptor that you do not keep a reference to (like an inline class or registerRequestListener(new YourInterceptor())) as this will be destroyed immediately, this registration is ClassLoader safe
registerService(String, Object) - Method in interface org.dspace.kernel.ServiceManager
Allows adding singleton services and providers in at runtime or after the service manager has started up.
registerServiceClass(String, Class<T>) - Method in interface org.dspace.kernel.ServiceManager
Allows adding singleton services and providers in at runtime or after the service manager has started up.
remove(String) - Method in interface org.dspace.services.model.Cache
Removes an object from the cache if it exists or does nothing if it does not.
Request - Interface in org.dspace.services.model
 
REQUEST_CACHE - Static variable in interface org.dspace.services.CachingService
This is the cache key used to stored requests in a request cache, typically handled by a servlet filter but can be handled by anything.
RequestInterceptor - Interface in org.dspace.services.model
Executes at the beginning and/or end of system requests.
RequestInterceptor.RequestInterruptionException - Exception in org.dspace.services.model
Indicate that request processing should be halted.
RequestInterceptor.RequestInterruptionException(String, Throwable) - Constructor for exception org.dspace.services.model.RequestInterceptor.RequestInterruptionException
 
RequestInterceptor.RequestInterruptionException(String) - Constructor for exception org.dspace.services.model.RequestInterceptor.RequestInterruptionException
 
RequestService - Interface in org.dspace.services
Allows for the managing of requests in the system in a way which is independent of any underlying system or code.
resetCaches() - Method in interface org.dspace.providers.CacheProvider
Clears the contents of all caches managed by this provider
resetCaches() - Method in interface org.dspace.services.CachingService
Clears all caches.

S

ServiceChangeListener - Interface in org.dspace.kernel.mixins
Allow a service to be notified when other services change.
ServiceManager - Interface in org.dspace.kernel
Allows for non-specific access to the core services.
serviceManagerReady(ServiceManager) - Method in interface org.dspace.kernel.mixins.ServiceManagerReadyAware
This is called when the startup of all core services and activators is complete.
ServiceManagerReadyAware - Interface in org.dspace.kernel.mixins
Allow a service to be notified when the service manager has started up all known services (including activators).
serviceRegistered(String, Object, List<Class<?>>) - Method in interface org.dspace.kernel.mixins.ServiceChangeListener
This will be called when services are newly registered with the service manager.
serviceUnregistered(String, Object) - Method in interface org.dspace.kernel.mixins.ServiceChangeListener
This will be called when services are removed from the service manager.
Session - Interface in org.dspace.services.model
Represents a user's session (login session) in the system.
SessionService - Interface in org.dspace.services
Provides access to user sessions and allows for initializing user sessions.
setAttribute(String, Object) - Method in interface org.dspace.services.model.Request
 
setAttribute(String, String) - Method in interface org.dspace.services.model.Session
Set an attribute on a session.
setDefaultKernel(DSpaceKernel) - Static method in class org.dspace.kernel.DSpaceKernelManager
 
setId(String) - Method in class org.dspace.services.model.Event
 
setModify(boolean) - Method in class org.dspace.services.model.Event
 
setName(String) - Method in class org.dspace.services.model.Event
 
setProperties(Map<String, String>) - Method in class org.dspace.services.model.Event
 
setProperty(String, Object) - Method in interface org.dspace.services.ConfigurationService
Set a configuration property (setting) in the system.
setResourceReference(String) - Method in class org.dspace.services.model.Event
 
setScopes(Event.Scope[]) - Method in class org.dspace.services.model.Event
 
setUserId(String) - Method in class org.dspace.services.model.Event
 
shutdown() - Method in interface org.dspace.kernel.mixins.ShutdownService
Called as the service manager is stopping or shutting down.
ShutdownService - Interface in org.dspace.kernel.mixins
Allow the service to be notified when the service manager is shutting it down.
size() - Method in interface org.dspace.services.model.Cache
How many items does this cache hold?
SpringLoader - Interface in org.dspace.kernel.config
User: kevin (kevin at atmire.com) Date: 3-aug-2011 Time: 11:19:33 Interface that is used so that modules can determine their own spring file locations
start(ServiceManager) - Method in interface org.dspace.kernel.Activator
This is called when the service manager is starting this activator.
start() - Method in interface org.dspace.kernel.CommonLifecycle
Starts the bean.
startRequest() - Method in interface org.dspace.services.RequestService
Initiates a request in the system.
startRequest(ServletRequest, ServletResponse) - Method in interface org.dspace.services.RequestService
Initiates a request in the system, normally this would be triggered by a servlet request starting
Only one request can be associated with the current thread so if another one is running it will be destroyed and a new one will be created
Note that requests are expected to be manually ended somehow and will not be closed out automatically
stop(ServiceManager) - Method in interface org.dspace.kernel.Activator
This is called when the service manager is shutting down this activator.
stop() - Method in interface org.dspace.kernel.CommonLifecycle
Stops the bean.

T

toString() - Method in class org.dspace.services.model.Event
 

U

unbindRequestCaches() - Method in interface org.dspace.services.CachingService
Unbinds all request caches.
unregisterMBean(String) - Static method in class org.dspace.kernel.DSpaceKernelManager
Unregister an MBean if possible
unregisterService(String) - Method in interface org.dspace.kernel.ServiceManager
Allows a service to be unregistered (which will only work if nothing depends on it).

V

valueOf(String) - Static method in enum org.dspace.services.model.CacheConfig.CacheScope
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.dspace.services.model.Event.Scope
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.dspace.services.model.CacheConfig.CacheScope
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.dspace.services.model.Event.Scope
Returns an array containing the constants of this enum type, in the order they are declared.

X

XML_SUFFIX - Static variable in interface org.dspace.kernel.config.SpringLoader
 

A C D E F G I K L M N O P Q R S T U V X

Copyright © Monday, September 1, 2008-2011 The DSpace Foundation. All Rights Reserved.