A C D E F G H I K L M N O P Q R S T U V X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractRequestImpl - Class in org.dspace.services.sessions.model
- AbstractRequestImpl() - Constructor for class org.dspace.services.sessions.model.AbstractRequestImpl
- 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.
- ADDON_RESOURCE_PATH - Static variable in class org.dspace.servicemanager.DSpaceServiceManager
- addPropertyDirect(String, Object) - Method in class org.dspace.servicemanager.config.DSpaceEnvironmentConfiguration
-
Adds a property to this configuration.
- addPropertyValue(String, Object) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
- addPropertyValue(String, Object) - Method in interface org.dspace.services.ConfigurationService
-
Add a value to a configuration property.
- addProvider(T) - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Add a provider to the stack of providers.
- AUTHENTICATED_EPERSON - Static variable in interface org.dspace.services.RequestService
-
Request attribute name for the current authenticated user
C
- cache - Variable in class org.dspace.services.caching.model.EhcacheCache
- Cache - Interface in org.dspace.services.model
-
This is a cache which can be used to store data.
- cacheConfig - Variable in class org.dspace.services.caching.model.EhcacheCache
- cacheConfig - Variable in class org.dspace.services.caching.model.MapCache
- 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.
- cacheManager - Variable in class org.dspace.services.caching.CachingServiceImpl
-
The underlying cache manager; injected.
- 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.
- CachingServiceImpl - Class in org.dspace.services.caching
-
Implementation of the core caching service, which is available for anyone who is writing code for DSpace to use.
- CachingServiceImpl() - Constructor for class org.dspace.services.caching.CachingServiceImpl
- CachingServiceImpl.NameComparator - Class in org.dspace.services.caching
-
Compare two Cache objects by name.
- checkName(String) - Static method in class org.dspace.kernel.DSpaceKernelManager
-
Ensure that we have a name suitable for an mbean.
- clear() - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Clears all the configuration settings.
- clear() - Method in class org.dspace.services.caching.model.EhcacheCache
- clear() - Method in class org.dspace.services.caching.model.MapCache
- 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.
- clear() - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
-
Clears out the settings inside this service.
- clear() - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Delete all providers from the current provider stack.
- clearConfig(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Clears a single configuration
- clearInternal() - Method in class org.dspace.servicemanager.config.DSpaceEnvironmentConfiguration
-
Removes all properties from this configuration.
- clearPropertyDirect(String) - Method in class org.dspace.servicemanager.config.DSpaceEnvironmentConfiguration
-
Removes a property from this configuration.
- clearQueuedEvents() - Method in class org.dspace.services.events.SystemEventService
-
Clears all events for the current request.
- CLUSTER - org.dspace.services.model.Event.Scope
- CLUSTERINVALIDATED - org.dspace.services.model.CacheConfig.CacheScope
-
This cache is destroyed when the entire cluster goes down.
- CLUSTERREPLICATED - org.dspace.services.model.CacheConfig.CacheScope
-
This cache is destroyed when the entire cluster goes down.
- CommonLifecycle<T> - Interface in org.dspace.kernel
-
Beans that have a lifecycle and can be controlled via their lifecycle implement this interface.
- compare(Object, Object) - Method in class org.dspace.utils.servicemanager.OrderedServiceComparator
- compare(Cache, Cache) - Method in class org.dspace.services.caching.CachingServiceImpl.NameComparator
- compare(ProviderHolder<?>, ProviderHolder<?>) - Method in class org.dspace.utils.servicemanager.ProviderStackComparator
- ConcreteExample - Class in org.dspace.servicemanager.example
-
Concrete example to fire up as a service.
- ConcreteExample() - Constructor for class org.dspace.servicemanager.example.ConcreteExample
- CONFIG_LIST_DELIMITER - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- CONFIG_PATH - Static variable in class org.dspace.servicemanager.DSpaceServiceManager
- 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).
- configurationChanged(List<String>, Map<String, String>) - Method in class org.dspace.services.caching.CachingServiceImpl
- ConfigurationService - Interface in org.dspace.services
-
This service handles retrieval of the configuration data for a DSpace instance.
- configureService(String, Object, ConfigurationService) - Static method in class org.dspace.servicemanager.DSpaceServiceManager
-
Configures a given service (i.e.
- contextDestroyed(ServletContextEvent) - Method in class org.dspace.servicemanager.servlet.DSpaceKernelServletContextListener
-
Deprecated.
- contextInitialized(ServletContextEvent) - Method in class org.dspace.servicemanager.servlet.DSpaceKernelServletContextListener
-
Deprecated.
- convertStreamToString(InputStream) - Static method in class org.dspace.utils.StreamUtils
-
A simple utility to convert
InputStream
s into strings. - CORE_RESOURCE_PATH - Static variable in class org.dspace.servicemanager.DSpaceServiceManager
D
- DEFAULT_CONFIG - Static variable in class org.dspace.services.caching.CachingServiceImpl
-
The default config location.
- DEFAULT_CONFIG_DEFINITION_FILE - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- DEFAULT_CONFIG_DIR - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- destroy() - Method in interface org.dspace.kernel.CommonLifecycle
-
Destroy the managed bean entirely.
- destroy() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- destroy() - Method in class org.dspace.utils.servlet.DSpaceWebappServletFilter
- destroyCache(String) - Method in interface org.dspace.providers.CacheProvider
-
Flush and destroy the cache with this name.
- destroyCache(String) - Method in class org.dspace.services.caching.CachingServiceImpl
- destroyCache(String) - Method in interface org.dspace.services.CachingService
-
Flushes and destroys the cache with this name.
- developing - Variable in class org.dspace.servicemanager.DSpaceServiceManager
- doDestroy() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
-
Called from within the shutdown thread.
- doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.dspace.utils.servlet.DSpaceWebappServletFilter
- DOT_CONFIG - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- DSpace - Class in org.dspace.utils
-
This is the DSpace helper services access object.
- DSpace() - Constructor for class org.dspace.utils.DSpace
-
Construct a DSpace helper object which uses the default kernel.
- DSpace(String) - Constructor for class org.dspace.utils.DSpace
-
Construct a DSpace helper object which uses the a specific named instance of the kernel.
- DSPACE - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- DSPACE_CONFIG_DEFINITION_PATH - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- DSPACE_CONFIG_PATH - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- DSPACE_HOME - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- DSPACE_SERVER_ID - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- DSpaceBeanFactoryPostProcessor - Class in org.dspace.servicemanager.spring
-
This will allow us to put the configuration into beans as they are being created.
- DSpaceBeanFactoryPostProcessor(ServiceManagerSystem, DSpaceConfigurationService, boolean) - Constructor for class org.dspace.servicemanager.spring.DSpaceBeanFactoryPostProcessor
- DSpaceBeanPostProcessor - Class in org.dspace.servicemanager.spring
-
This processes beans as they are loaded into the system by spring.
- DSpaceBeanPostProcessor(DSpaceConfigurationService) - Constructor for class org.dspace.servicemanager.spring.DSpaceBeanPostProcessor
- DSpaceConfigurationPlaceholderConfigurer - Class in org.dspace.servicemanager.config
-
Extends Spring PropertySourcesPlaceholderConfigurer to allow our Configuration to be included as a Spring PropertySource.
- DSpaceConfigurationPlaceholderConfigurer(Configuration) - Constructor for class org.dspace.servicemanager.config.DSpaceConfigurationPlaceholderConfigurer
- DSpaceConfigurationService - Class in org.dspace.servicemanager.config
-
The central DSpace configuration service.
- DSpaceConfigurationService() - Constructor for class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Initializes a ConfigurationService based on default values.
- DSpaceConfigurationService(String) - Constructor for class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Initializes a ConfigurationService based on the provided home directory for DSpace
- DSpaceEnvironmentConfiguration - Class in org.dspace.servicemanager.config
-
Bash does not allow environment variables that contain dots in their name.
- DSpaceEnvironmentConfiguration() - Constructor for class org.dspace.servicemanager.config.DSpaceEnvironmentConfiguration
-
Create a Configuration based on the environment variables.
- DSpaceEnvironmentConfigurationBuilderProvider - Class in org.dspace.servicemanager.config
-
Configures DSpaceEnvironmentConfiguration.
- DSpaceEnvironmentConfigurationBuilderProvider() - Constructor for class org.dspace.servicemanager.config.DSpaceEnvironmentConfigurationBuilderProvider
-
Creates a new instance of
BaseConfigurationBuilderProvider
and initializes all its properties. - DSpaceKernel - Interface in org.dspace.kernel
-
This is the most core piece of the system: instantiating one will startup the dspace services framework.
- DSpaceKernelImpl - Class in org.dspace.servicemanager
-
This is the kernel implementation which starts up the core of DSpace, registers the mbean, and initializes the DSpace object.
- DSpaceKernelImpl(String) - Constructor for class org.dspace.servicemanager.DSpaceKernelImpl
-
Creates a DSpace Kernel, does not do any checks though.
- DSpaceKernelInit - Class in org.dspace.servicemanager
-
This class simplifies the handling of lookup, registration, and access of a DSpace Kernel MBean.
- DSpaceKernelManager - Class in org.dspace.kernel
-
Allows the DSpace kernel to be accessed if desired.
- DSpaceKernelManager() - Constructor for class org.dspace.kernel.DSpaceKernelManager
- DSpaceKernelServletContextListener - Class in org.dspace.servicemanager.servlet
-
Deprecated.The DSpace Kernel initialisation is now done by org.dspace.app.rest.Application
- DSpaceKernelServletContextListener() - Constructor for class org.dspace.servicemanager.servlet.DSpaceKernelServletContextListener
-
Deprecated.
- DSpaceServiceManager - Class in org.dspace.servicemanager
-
A service locator based on Spring.
- DSpaceServiceManager(DSpaceConfigurationService) - Constructor for class org.dspace.servicemanager.DSpaceServiceManager
-
Standard constructor.
- DSpaceServiceManager(DSpaceConfigurationService, String...) - Constructor for class org.dspace.servicemanager.DSpaceServiceManager
-
TESTING - This is for testing only.
- DSpaceServicesFactory - Class in org.dspace.services.factory
-
Abstract factory to get services for the services package, use DSpaceServicesFactory.getInstance() to retrieve an implementation
- DSpaceServicesFactory() - Constructor for class org.dspace.services.factory.DSpaceServicesFactory
- DSpaceServicesFactoryImpl - Class in org.dspace.services.factory
-
Factory implementation to get services for the services package, use DSpaceServicesFactory.getInstance() to retrieve an implementation
- DSpaceServicesFactoryImpl() - Constructor for class org.dspace.services.factory.DSpaceServicesFactoryImpl
- DSpaceWebappServletFilter - Class in org.dspace.utils.servlet
-
This servlet filter will handle the hookup and setup for DSpace requests.
- DSpaceWebappServletFilter() - Constructor for class org.dspace.utils.servlet.DSpaceWebappServletFilter
E
- EhcacheCache - Class in org.dspace.services.caching.model
-
The ehcache implementation of the Cache object.
- EhcacheCache(Ehcache, CacheConfig) - Constructor for class org.dspace.services.caching.model.EhcacheCache
- EmailService - Interface in org.dspace.services
- EmailServiceImpl - Class in org.dspace.services.email
-
Provides mail sending services through JavaMail.
- EmailServiceImpl() - Constructor for class org.dspace.services.email.EmailServiceImpl
- 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
- endRequest(Exception) - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
- environmentPathVariable - Static variable in class org.dspace.servicemanager.spring.ResourceFinder
- equals(Object) - Method in class org.dspace.services.caching.model.EhcacheCache
- equals(Object) - Method in class org.dspace.utils.servicemanager.ProviderHolder
- 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_RESET - Static variable in class org.dspace.services.caching.CachingServiceImpl
-
This is the event key for a full cache reset.
- 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.
- EventListenerExample - Class in org.dspace.servicemanager.example
-
A sample EventListener which writes a string form of each received Event to the DSpace log.
- EventListenerExample() - Constructor for class org.dspace.servicemanager.example.EventListenerExample
- EventRequestInterceptor() - Constructor for class org.dspace.services.events.SystemEventService.EventRequestInterceptor
- EventService - Interface in org.dspace.services
-
Allows the creation of system events and registration of event listeners for notification of system events.
- execute() - Method in class org.dspace.utils.servicemanager.RequestExecutor
-
Execute the
Runnable
which is contained in this object, the same as callingRequestExecutor.run()
. - executeCallback() - Method in interface org.dspace.services.KernelStartupCallbackService
- exists(String) - Method in class org.dspace.services.caching.model.EhcacheCache
- exists(String) - Method in class org.dspace.services.caching.model.MapCache
- exists(String) - Method in interface org.dspace.services.model.Cache
-
Check if a key exists in the cache.
- EXT_CONFIG - Static variable in class org.dspace.servicemanager.config.DSpaceConfigurationService
- EXTERNAL - org.dspace.services.model.Event.Scope
- ExternalServiceManagerSystem - Interface in org.dspace.servicemanager
-
Interface for modular service manager systems.
F
- finalize() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- fireEvent(Event) - Method in class org.dspace.services.events.SystemEventService
- fireEvent(Event) - Method in interface org.dspace.services.EventService
-
Fires an event immediately (does not add it to the queue).
- fireQueuedEvents() - Method in class org.dspace.services.events.SystemEventService
-
Fires all queued events for the current request.
G
- generateCacheStats(Ehcache) - Static method in class org.dspace.services.caching.CachingServiceImpl
-
Generate some stats for this cache.
- get(String) - Method in class org.dspace.services.caching.model.EhcacheCache
- get(String) - Method in class org.dspace.services.caching.model.MapCache
- 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).
- getAllEhCaches(boolean) - Method in class org.dspace.services.caching.CachingServiceImpl
-
Return all caches from the CacheManager.
- getApplicationContext() - Method in interface org.dspace.kernel.ServiceManager
-
Get the application context
- getApplicationContext() - Method in class org.dspace.servicemanager.DSpaceServiceManager
- getArrayProperty(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as an array.
- getArrayProperty(String) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as a String Array.
- getArrayProperty(String, String[]) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as an array.
- getArrayProperty(String, String[]) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as a String Array.
- getAttribute(String) - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- 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.
- getAttribute(String) - Method in class org.dspace.services.sessions.model.HttpRequestImpl
- getAttribute(String) - Method in class org.dspace.services.sessions.model.InternalRequestImpl
- getAttributes() - Method in interface org.dspace.services.model.Session
-
Get all attributes of this session.
- getAttributes(String[]) - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- getBeanFactory() - Method in class org.dspace.servicemanager.DSpaceServiceManager
- getBooleanProperty(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as a boolean value.
- getBooleanProperty(String) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as a boolean value.
- getBooleanProperty(String, boolean) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as a boolean value.
- getBooleanProperty(String, boolean) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as a boolean value.
- getCache() - Method in class org.dspace.services.caching.model.EhcacheCache
- getCache() - Method in class org.dspace.services.caching.model.MapCache
- 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 class org.dspace.services.caching.CachingServiceImpl
- 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.
- getCacheManager() - Method in class org.dspace.services.caching.CachingServiceImpl
- getCacheProvider() - Method in class org.dspace.services.caching.CachingServiceImpl
- getCaches() - Method in interface org.dspace.providers.CacheProvider
-
Gets all the caches that this provider knows about.
- getCaches() - Method in class org.dspace.services.caching.CachingServiceImpl
- 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
- getCachingService() - Method in class org.dspace.services.factory.DSpaceServicesFactory
- getCachingService() - Method in class org.dspace.services.factory.DSpaceServicesFactoryImpl
- getCatalina() - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
This simply attempts to find the servlet container home for tomcat.
- getConfig() - Method in class org.dspace.services.caching.model.EhcacheCache
- getConfig() - Method in class org.dspace.services.caching.model.MapCache
- getConfig() - Method in interface org.dspace.services.model.Cache
-
Returns a readable object which has the configuration used by this cache in it.
- getConfiguration() - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns all loaded properties as a Configuration object.
- getConfiguration() - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get entire configuration (settings) from the system.
- getConfigurationService() - Method in interface org.dspace.kernel.DSpaceKernel
- getConfigurationService() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- getConfigurationService() - Method in class org.dspace.services.factory.DSpaceServicesFactory
- getConfigurationService() - Method in class org.dspace.services.factory.DSpaceServicesFactoryImpl
- getConfigurationService() - Method in class org.dspace.utils.DSpace
- getContainerHome() - Static method in class org.dspace.servicemanager.spring.ResourceFinder
-
If running in Tomcat, get its home directory.
- getCurrentRequest() - Method in interface org.dspace.services.RequestService
-
Finds out of there is a request running in this thread and if so returns it
- getCurrentRequest() - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
- 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.
- getCurrentRequestId() - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
- getCurrentUserId() - Method in interface org.dspace.services.RequestService
-
Access the current user id for the current session.
- getCurrentUserId() - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
-
(non-Javadoc)
- getDefaultKernel() - Static method in class org.dspace.kernel.DSpaceKernelManager
- getDSpaceHome(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
This attempts to find the DSpace home directory, based on system properties, and the providedHome (if not null).
- getEmailService() - Method in class org.dspace.services.factory.DSpaceServicesFactory
- getEmailService() - Method in class org.dspace.services.factory.DSpaceServicesFactoryImpl
- getEnvironmentPath() - Static method in class org.dspace.servicemanager.spring.ResourceFinder
- getEventNamePrefixes() - Method in class org.dspace.servicemanager.example.EventListenerExample
- getEventNamePrefixes() - Method in interface org.dspace.services.model.EventListener
-
This defines the events that you want to know about by event name.
- getEventService() - Method in class org.dspace.services.factory.DSpaceServicesFactory
- getEventService() - Method in class org.dspace.services.factory.DSpaceServicesFactoryImpl
- getEventService() - Method in class org.dspace.utils.DSpace
- getFile(String) - Static method in class org.dspace.servicemanager.spring.ResourceFinder
- getFiles(List<String>) - Static method in class org.dspace.servicemanager.spring.ResourceFinder
- getHttpServletRequest() - Method in interface org.dspace.services.model.Request
- getHttpServletRequest() - Method in class org.dspace.services.sessions.model.HttpRequestImpl
- getHttpServletRequest() - Method in class org.dspace.services.sessions.model.InternalRequestImpl
- getHttpServletResponse() - Method in interface org.dspace.services.model.Request
- getHttpServletResponse() - Method in class org.dspace.services.sessions.model.HttpRequestImpl
- getHttpServletResponse() - Method in class org.dspace.services.sessions.model.InternalRequestImpl
- getId() - Method in class org.dspace.services.model.Event
- getInputStream(String) - Static method in class org.dspace.servicemanager.spring.ResourceFinder
- getInputStreams(List<String>) - Static method in class org.dspace.servicemanager.spring.ResourceFinder
- getInstance() - Static method in class org.dspace.services.factory.DSpaceServicesFactory
- getIntProperty(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as an int value.
- getIntProperty(String) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as an int value.
- getIntProperty(String, int) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as an int value.
- getIntProperty(String, int) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as an int value.
- getIterator() - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Get the iterator of all providers currently in the stack.
- getKernel() - Method in class org.dspace.kernel.DSpaceKernelManager
-
Get the kernel.
- getKernel() - Method in class org.dspace.utils.DSpace
- getKernel() - Method in class org.dspace.utils.servlet.DSpaceWebappServletFilter
- getKernel(String) - Method in class org.dspace.kernel.DSpaceKernelManager
-
Get the kernel.
- getKernel(String) - Static method in class org.dspace.servicemanager.DSpaceKernelInit
-
Creates or retrieves a DSpace Kernel with the given name.
- getKeys() - Method in class org.dspace.services.caching.model.EhcacheCache
- getKeys() - Method in class org.dspace.services.caching.model.MapCache
- 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.
- getLastLoadDate() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
-
Time that this kernel was started, as a java.util.Date.
- getLoadTime() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
-
Time that this kernel was started, as seconds since the epoch.
- getLongProperty(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as a long value.
- getLongProperty(String) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as a long value.
- getLongProperty(String, long) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as a long value.
- getLongProperty(String, long) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as a long value.
- getManagedBean() - Method in interface org.dspace.kernel.CommonLifecycle
-
Gets a reference to the bean that is being managed inside this lifecycle.
- getManagedBean() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- getMBeanInfo() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- getMBeanName() - Method in interface org.dspace.kernel.DSpaceKernel
- getMBeanName() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- getModifiedEnvMap() - Static method in class org.dspace.servicemanager.config.DSpaceEnvironmentConfiguration
- getName() - Method in class org.dspace.servicemanager.example.ConcreteExample
- getName() - Method in interface org.dspace.servicemanager.example.ServiceExample
- getName() - Method in class org.dspace.servicemanager.example.ServiceExampleImpl
- getName() - Method in class org.dspace.services.caching.model.EhcacheCache
- getName() - Method in class org.dspace.services.caching.model.MapCache
- 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.
- getOrder() - Method in class org.dspace.servicemanager.example.RequestInterceptorExample
- getOrder() - Method in class org.dspace.services.events.SystemEventService.EventRequestInterceptor
- getOriginatingHostIP() - Method in interface org.dspace.services.model.Session
- getOriginatingHostName() - Method in interface org.dspace.services.model.Session
- getOtherName() - Method in interface org.dspace.servicemanager.example.ServiceExample
- getOtherName() - Method in class org.dspace.servicemanager.example.ServiceExampleImpl
- getPasswordAuthentication() - Method in class org.dspace.services.email.EmailServiceImpl
- getProperties() - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns all loaded properties as a Properties object.
- 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 class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as a String.
- getProperty(String) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as a String.
- getProperty(String, String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as a String.
- getProperty(String, String) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as a String.
- getPropertyAsType(String, Class<T>) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
- 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 class org.dspace.servicemanager.config.DSpaceConfigurationService
- 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 class org.dspace.servicemanager.config.DSpaceConfigurationService
- 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.
- getPropertyKeys() - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns all Property keys.
- getPropertyKeys() - Method in interface org.dspace.services.ConfigurationService
-
Get keys all currently known configuration settings
- getPropertyKeys(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns all Property keys that begin with a given prefix.
- getPropertyKeys(String) - Method in interface org.dspace.services.ConfigurationService
-
Get keys all currently known configuration settings, which begin with a given prefix.
- getPropertyValue(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns property value as an Object.
- getPropertyValue(String) - Method in interface org.dspace.services.ConfigurationService
-
Convenience method - get a configuration property (setting) from the system as its stored object
- getProvider() - Method in class org.dspace.utils.servicemanager.ProviderHolder
-
Gets the provider out of this holder.
- getProvider(int) - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Get a provider based on the position in the stack (starting at 0 and ending at size-1).
- getProviderHolder(int) - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Get the provider holder from the position in the stack if there is one.
- getProviderHolders() - Method in class org.dspace.utils.servicemanager.ProviderStack
-
This allows access to the provider holders.
- getProviderOrFail() - Method in class org.dspace.utils.servicemanager.ProviderHolder
-
Gets the provider out of this holder if it still exists.
- getProviders() - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Get the list of all providers currently in the stack.
- getRelativePath() - Static method in class org.dspace.servicemanager.spring.ResourceFinder
- getRequestCaches() - Method in class org.dspace.services.caching.CachingServiceImpl
- getRequestId() - Method in interface org.dspace.services.model.Request
- getRequestId() - Method in class org.dspace.services.sessions.model.AbstractRequestImpl
- getRequestService() - Method in class org.dspace.services.factory.DSpaceServicesFactory
- getRequestService() - Method in class org.dspace.services.factory.DSpaceServicesFactoryImpl
- getRequestService() - Method in class org.dspace.utils.DSpace
- getResource(String) - Static method in class org.dspace.servicemanager.spring.ResourceFinder
-
Resolve a path into a resource relative to environmental defaults or relative paths or the classloader.
- getResourceFromPaths(String[]) - Static method in class org.dspace.servicemanager.spring.ResourceFinder
-
Attempt to resolve multiple paths in order until one is found.
- getResourcePaths(ConfigurationService) - Method in interface org.dspace.kernel.config.SpringLoader
-
Returns all the locations that contain spring files
- getResourcePrefix() - Method in class org.dspace.servicemanager.example.EventListenerExample
- 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.
- getResources(List<String>) - Static method in class org.dspace.servicemanager.spring.ResourceFinder
-
Resolves a list of paths into resources relative to environmental defaults or relative paths or the classloader.
- 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.
- getServiceByName(String, Class<T>) - Method in class org.dspace.servicemanager.DSpaceServiceManager
- getServiceManager() - Method in interface org.dspace.kernel.DSpaceKernel
- getServiceManager() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- getServiceManager() - Method in class org.dspace.services.factory.DSpaceServicesFactory
- getServiceManager() - Method in class org.dspace.services.factory.DSpaceServicesFactoryImpl
- getServiceManager() - Method in class org.dspace.utils.DSpace
- getServices() - Method in class org.dspace.servicemanager.DSpaceServiceManager
- getServices() - Method in interface org.dspace.servicemanager.ServiceManagerSystem
-
Map service names to their beans.
- getServicesByType(Class<T>) - Method in interface org.dspace.kernel.ServiceManager
-
Allows developers to get the desired service singleton by the provided type.
- getServicesByType(Class<T>) - Method in class org.dspace.servicemanager.DSpaceServiceManager
- getServicesNames() - Method in interface org.dspace.kernel.ServiceManager
-
Get the names of all registered service singletons.
- getServicesNames() - Method in class org.dspace.servicemanager.DSpaceServiceManager
- getServletRequest() - Method in interface org.dspace.services.model.Request
- getServletRequest() - Method in class org.dspace.services.sessions.model.HttpRequestImpl
- getServletRequest() - Method in class org.dspace.services.sessions.model.InternalRequestImpl
- getServletResponse() - Method in interface org.dspace.services.model.Request
- getServletResponse() - Method in class org.dspace.services.sessions.model.HttpRequestImpl
- getServletResponse() - Method in class org.dspace.services.sessions.model.InternalRequestImpl
- getSession() - Method in class org.dspace.services.email.EmailServiceImpl
-
Provide a reference to the JavaMail session.
- getSession() - Method in interface org.dspace.services.EmailService
-
Provide a reference to the JavaMail session.
- getSessionId() - Method in interface org.dspace.services.model.Session
- getSingletonService(Class<T>) - Method in class org.dspace.utils.DSpace
- getSpringPaths(boolean, String[], DSpaceConfigurationService) - Static method in class org.dspace.servicemanager.DSpaceServiceManager
-
Build the complete list of Spring configuration paths, including hard-wired paths.
- getStatus(String) - Method in class org.dspace.services.caching.CachingServiceImpl
- 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.
H
- hashCode() - Method in class org.dspace.services.caching.model.EhcacheCache
- hashCode() - Method in class org.dspace.utils.servicemanager.ProviderHolder
- hasProperty(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Determine if a given property key exists within the currently loaded configuration
- hasProperty(String) - Method in interface org.dspace.services.ConfigurationService
-
Return whether a property exists within the configuration
- HttpRequestImpl - Class in org.dspace.services.sessions.model
- HttpRequestImpl(ServletRequest, ServletResponse) - Constructor for class org.dspace.services.sessions.model.HttpRequestImpl
I
- init() - Method in interface org.dspace.kernel.mixins.InitializedService
-
Executed after the service is created and all dependencies and configurations injected.
- init() - Method in class org.dspace.services.caching.CachingServiceImpl
- init() - Method in class org.dspace.services.email.EmailServiceImpl
- init() - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
- init(FilterConfig) - Method in class org.dspace.utils.servlet.DSpaceWebappServletFilter
- init(ServiceManagerSystem, DSpaceConfigurationService, boolean, boolean, List<ServiceManagerSystem>) - Method in interface org.dspace.servicemanager.ExternalServiceManagerSystem
-
Initialize the service manager's configuration.
- InitializedService - Interface in org.dspace.kernel.mixins
-
Allow the service or provider to be initialized when it is started by the service manager.
- initService(Object) - Static method in class org.dspace.servicemanager.DSpaceServiceManager
-
Initializes a service if it asks to be initialized or does nothing.
- INSTANCE - org.dspace.services.model.CacheConfig.CacheScope
-
This cache is destroyed when the current JVM shuts down.
- instantiateEhCache(String, CacheConfig) - Method in class org.dspace.services.caching.CachingServiceImpl
-
Create an EhcacheCache (and the associated EhCache) using the supplied name (with default settings), or get the cache out of Spring or the current configured cache.
- instantiateMapCache(String, CacheConfig) - Method in class org.dspace.services.caching.CachingServiceImpl
-
Create a thread map cache using the supplied name with supplied settings.
- InternalRequestImpl - Class in org.dspace.services.sessions.model
- InternalRequestImpl() - Constructor for class org.dspace.services.sessions.model.InternalRequestImpl
- invoke(String, Object[], String[]) - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- 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
- isRunning() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- isRunning() - Method in class org.dspace.servicemanager.DSpaceServiceManager
- isServiceExists(String) - Method in interface org.dspace.kernel.ServiceManager
-
Lookup to see if a service exists with the given name.
- isServiceExists(String) - Method in class org.dspace.servicemanager.DSpaceServiceManager
- isValidDSpaceHome(String) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Returns whether a given path seems to have the required DSpace configurations in order to make it a valid DSpace home directory
K
- KERNEL_NAME - Static variable in interface org.dspace.kernel.DSpaceKernel
- KernelStartupCallbackService - Interface in org.dspace.services
-
Interface whos implementations will be called when the kernel startup is completed.
L
- loadConfig(String, Object) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Loads (i.e.
- loadConfiguration(Map<String, Object>) - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Load (i.e.
- LOCAL - org.dspace.services.model.Event.Scope
- look(String) - Method in class org.dspace.services.caching.model.EhcacheCache
- look(String) - Method in class org.dspace.services.caching.model.MapCache
- 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
- MapCache - Class in org.dspace.services.caching.model
-
This is a simple Cache that just uses a map to store the cache values.
- MapCache(String, CacheConfig) - Constructor for class org.dspace.services.caching.model.MapCache
- 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
- name - Variable in class org.dspace.services.caching.model.MapCache
- NameComparator() - Constructor for class org.dspace.services.caching.CachingServiceImpl.NameComparator
- 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.
- notifyForConfigNames() - Method in class org.dspace.services.caching.CachingServiceImpl
- 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.
- notifyForTypes() - Method in class org.dspace.services.caching.CachingServiceImpl
- notifyServiceManagerReady() - Method in class org.dspace.servicemanager.DSpaceServiceManager
-
This will call all the services which want to be notified when the service manager is ready.
- NotProvider - Interface in org.dspace.utils.servicemanager
-
This is a special marker interface which is used to indicate that this service is not a provider and thus should not be included in the provider stacks which are being setup and stored.
O
- onEnd(String, boolean, Exception) - Method in class org.dspace.servicemanager.example.RequestInterceptorExample
- onEnd(String, boolean, Exception) - Method in class org.dspace.services.events.SystemEventService.EventRequestInterceptor
- onEnd(String, boolean, Exception) - Method in interface org.dspace.services.model.RequestInterceptor
-
Take actions after the request is handled for an operation.
- onStart(String) - Method in class org.dspace.servicemanager.example.RequestInterceptorExample
- onStart(String) - Method in class org.dspace.services.events.SystemEventService.EventRequestInterceptor
- onStart(String) - 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).
- OrderedServiceComparator - Class in org.dspace.utils.servicemanager
-
A comparator for provider beans, filters, and plugins which will take ordering into account if
OrderedService
is implemented. - OrderedServiceComparator() - Constructor for class org.dspace.utils.servicemanager.OrderedServiceComparator
- 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.servicemanager - package org.dspace.servicemanager
-
Register, configure, manipulate, locate services.
- org.dspace.servicemanager.config - package org.dspace.servicemanager.config
-
The configuration service.
- org.dspace.servicemanager.example - package org.dspace.servicemanager.example
-
Sample service implementations.
- org.dspace.servicemanager.servlet - package org.dspace.servicemanager.servlet
-
Support for using DSpace Services in a servlet context.
- org.dspace.servicemanager.spring - package org.dspace.servicemanager.spring
-
Spring extensions and adaptors for DSpace.
- org.dspace.services - package org.dspace.services
-
Core DSpace service definitions.
- org.dspace.services.caching - package org.dspace.services.caching
-
Implementation of the core Caching service.
- org.dspace.services.caching.model - package org.dspace.services.caching.model
-
Implementations of the Cache type, for various purposes.
- org.dspace.services.email - package org.dspace.services.email
-
Manages a JavaMail session for code which wants to send email.
- org.dspace.services.events - package org.dspace.services.events
-
Implementation of the event service.
- org.dspace.services.factory - package org.dspace.services.factory
- org.dspace.services.model - package org.dspace.services.model
-
Defines types managed by the core services.
- org.dspace.services.sessions - package org.dspace.services.sessions
-
Implement the session service.
- org.dspace.services.sessions.model - package org.dspace.services.sessions.model
-
Implement the session type.
- org.dspace.utils - package org.dspace.utils
-
Utility classes and starting points.
- org.dspace.utils.servicemanager - package org.dspace.utils.servicemanager
-
Handy types to support ServiceManagers.
- org.dspace.utils.servlet - package org.dspace.utils.servlet
-
Connect a servlet container with the DSpace Services framework, in a web application context.
P
- postProcessAfterInitialization(Object, String) - Method in class org.dspace.servicemanager.spring.DSpaceBeanPostProcessor
- postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.dspace.servicemanager.spring.DSpaceBeanFactoryPostProcessor
- postProcessBeforeDestruction(Object, String) - Method in class org.dspace.servicemanager.spring.DSpaceBeanPostProcessor
- postProcessBeforeInitialization(Object, String) - Method in class org.dspace.servicemanager.spring.DSpaceBeanPostProcessor
- ProviderHolder<T> - Class in org.dspace.utils.servicemanager
-
A holder which is designed to make it easy to hold onto a reference to a class which is outside of our ClassLoader and not cause it to not be able to reload happily.
- ProviderHolder() - Constructor for class org.dspace.utils.servicemanager.ProviderHolder
-
Default constructor.
- ProviderHolder(T) - Constructor for class org.dspace.utils.servicemanager.ProviderHolder
-
Create the holder with a provider already in it.
- ProviderNotFoundException - Exception in org.dspace.utils.servicemanager
-
This exception indicates that the provider was not found (the reference was collected).
- ProviderNotFoundException(String) - Constructor for exception org.dspace.utils.servicemanager.ProviderNotFoundException
- ProviderNotFoundException(String, Throwable) - Constructor for exception org.dspace.utils.servicemanager.ProviderNotFoundException
- providers - Variable in class org.dspace.utils.servicemanager.ProviderStack
- ProviderStack<T> - Class in org.dspace.utils.servicemanager
-
This class stores a list of providers in a specific order (determined by insertion order and the
OrderedService
settings). - ProviderStack() - Constructor for class org.dspace.utils.servicemanager.ProviderStack
-
Default empty constructor.
- ProviderStack(ServiceManager, Class<T>) - Constructor for class org.dspace.utils.servicemanager.ProviderStack
-
Construct a provider holder with all currently known providers of the given type.
- ProviderStack(T[]) - Constructor for class org.dspace.utils.servicemanager.ProviderStack
-
Construct a provider holder with a given set of providers.
- ProviderStackComparator - Class in org.dspace.utils.servicemanager
-
A Comparator for provider stacks.
- ProviderStackComparator() - Constructor for class org.dspace.utils.servicemanager.ProviderStackComparator
- pushConfig(Map<String, Object>) - Method in interface org.dspace.kernel.ServiceManager
-
Allows new configuration settings to be pushed into the core DSpace configuration.
- pushConfig(Map<String, Object>) - Method in class org.dspace.servicemanager.DSpaceServiceManager
- put(String, Object) - Method in class org.dspace.services.caching.model.EhcacheCache
- put(String, Object) - Method in class org.dspace.services.caching.model.MapCache
- 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 class org.dspace.services.events.SystemEventService
- 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 class org.dspace.servicemanager.example.EventListenerExample
- receiveEvent(Event) - Method in interface org.dspace.services.model.EventListener
-
Called when an event occurs which passes through the filters created by
EventListener.getEventNamePrefixes()
andEventListener.getResourcePrefix()
. - refresh() - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Check to make sure all providers are refreshed and any that are no longer valid are flushed out of the list.
- registerEventListener(EventListener) - Method in class org.dspace.services.events.SystemEventService
- 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
- registerRequestInterceptor(RequestInterceptor) - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
- 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.
- registerService(String, Object) - Method in class org.dspace.servicemanager.DSpaceServiceManager
- 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.
- registerServiceClass(String, Class<T>) - Method in class org.dspace.servicemanager.DSpaceServiceManager
- registerServiceNoAutowire(String, Object) - Method in interface org.dspace.kernel.ServiceManager
- registerServiceNoAutowire(String, Object) - Method in class org.dspace.servicemanager.DSpaceServiceManager
- registerShutdownHook() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- relativePath - Static variable in class org.dspace.servicemanager.spring.ResourceFinder
- reloadConfig() - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
-
Reload all configurations from the DSpace configuration definition.
- reloadConfig() - Method in class org.dspace.services.caching.CachingServiceImpl
-
Reloads the config settings from the configuration service.
- reloadConfig() - Method in interface org.dspace.services.ConfigurationService
-
Reload the configuration from the DSpace configuration files.
- remove(String) - Method in class org.dspace.services.caching.model.EhcacheCache
- remove(String) - Method in class org.dspace.services.caching.model.MapCache
- 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.
- removeProvider(int) - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Remove a provider based on the position in the stack (starting at 0 and ending at size-1).
- removeProvider(T) - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Remove a provider by the object equality.
- Request - Interface in org.dspace.services.model
- REQUEST - org.dspace.services.model.CacheConfig.CacheScope
-
This cache is destroyed at the end of the current request for the current thread it was created in.
- 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.
- RequestExecutor - Class in org.dspace.utils.servicemanager
-
This will execute a request and ensure that it closes even if the thing that is being executed (run) dies.
- RequestExecutor(RequestService, Runnable) - Constructor for class org.dspace.utils.servicemanager.RequestExecutor
-
Create an executor which can be used to execute the runnable within a request by calling the execute method.
- RequestExecutor(RequestService, Runnable, boolean) - Constructor for class org.dspace.utils.servicemanager.RequestExecutor
-
Create an executor which can be used to execute the runnable within a request by calling the execute method.
- 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.
- RequestInterceptorExample - Class in org.dspace.servicemanager.example
-
A sample RequestInterceptor which simply logs request start and end calls.
- RequestInterceptorExample(RequestService) - Constructor for class org.dspace.servicemanager.example.RequestInterceptorExample
-
Constructor which will inject the instantiated Interceptor into a service handed to it.
- RequestInterruptionException(String) - Constructor for exception org.dspace.services.model.RequestInterceptor.RequestInterruptionException
- RequestInterruptionException(String, Throwable) - 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.
- requiresDestruction(Object) - Method in class org.dspace.servicemanager.spring.DSpaceBeanPostProcessor
- reset() - Method in class org.dspace.services.email.EmailServiceImpl
-
Force a new initialization of the session, useful for testing purpose
- resetCaches() - Method in interface org.dspace.providers.CacheProvider
-
Clears the contents of all caches managed by this provider
- resetCaches() - Method in class org.dspace.services.caching.CachingServiceImpl
- resetCaches() - Method in interface org.dspace.services.CachingService
-
Clears all caches.
- ResourceFinder - Class in org.dspace.servicemanager.spring
-
Takes a list of paths to resources and turns them into different things (file/IS/resource).
- run() - Method in class org.dspace.utils.servicemanager.RequestExecutor
- running - Variable in class org.dspace.servicemanager.DSpaceServiceManager
S
- serialVersionUID - Static variable in class org.dspace.services.caching.CachingServiceImpl.NameComparator
- serialVersionUID - Static variable in class org.dspace.utils.servicemanager.OrderedServiceComparator
- serialVersionUID - Static variable in class org.dspace.utils.servicemanager.ProviderStackComparator
- ServiceChangeListener - Interface in org.dspace.kernel.mixins
-
Allow a service to be notified when other services change.
- ServiceExample - Interface in org.dspace.servicemanager.example
-
Sample service.
- ServiceExampleImpl - Class in org.dspace.servicemanager.example
-
Example implementation of the example service.
- ServiceExampleImpl() - Constructor for class org.dspace.servicemanager.example.ServiceExampleImpl
- 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).
- ServiceManagerSystem - Interface in org.dspace.servicemanager
-
This interface should be implemented by any service managers that we are using in the system, e.g.
- 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.
- serviceRegistered(String, Object, List<Class<?>>) - Method in class org.dspace.services.caching.CachingServiceImpl
- serviceUnregistered(String, Object) - Method in interface org.dspace.kernel.mixins.ServiceChangeListener
-
This will be called when services are removed from the service manager.
- serviceUnregistered(String, Object) - Method in class org.dspace.services.caching.CachingServiceImpl
- Session - Interface in org.dspace.services.model
-
Represents a user's session (login session) in the system.
- setAttribute(String, Object) - Method in interface org.dspace.services.model.Request
- setAttribute(String, Object) - Method in class org.dspace.services.sessions.model.HttpRequestImpl
- setAttribute(String, Object) - Method in class org.dspace.services.sessions.model.InternalRequestImpl
- setAttribute(String, String) - Method in interface org.dspace.services.model.Session
-
Set an attribute on a session.
- setAttribute(Attribute) - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- setAttributes(AttributeList) - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- setCacheManager(CacheManager) - Method in class org.dspace.services.caching.CachingServiceImpl
- setCfg(ConfigurationService) - Method in class org.dspace.services.email.EmailServiceImpl
-
Inject/set the ConfigurationService
- setConcreteExample(ConcreteExample) - Method in class org.dspace.servicemanager.example.ServiceExampleImpl
- setConfigurationService(ConfigurationService) - Method in class org.dspace.services.caching.CachingServiceImpl
- setConfigurationService(ConfigurationService) - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
- setCurrentUserId(UUID) - Method in interface org.dspace.services.RequestService
-
Set the ID of the current authenticated user
- setCurrentUserId(UUID) - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
-
(non-Javadoc)
- 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.servicemanager.example.ConcreteExample
- setName(String) - Method in class org.dspace.servicemanager.example.ServiceExampleImpl
- 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 class org.dspace.servicemanager.config.DSpaceConfigurationService
- setProperty(String, Object) - Method in interface org.dspace.services.ConfigurationService
-
Set a configuration property (setting) in the system.
- setProvider(T) - Method in class org.dspace.utils.servicemanager.ProviderHolder
-
Stores a provider in this holder in a ClassLoader safe way.
- setRequestService(RequestService) - Method in class org.dspace.services.caching.CachingServiceImpl
- setResourceReference(String) - Method in class org.dspace.services.model.Event
- setScopes(Event.Scope[]) - Method in class org.dspace.services.model.Event
- setServiceManager(ServiceManager) - Method in class org.dspace.services.caching.CachingServiceImpl
- 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.
- shutdown() - Method in class org.dspace.servicemanager.DSpaceServiceManager
-
Shut down the Spring context and leave the "running" state.
- shutdown() - Method in interface org.dspace.servicemanager.ServiceManagerSystem
-
Shuts down the service manager and all services that it is managing.
- shutdown() - Method in class org.dspace.services.caching.CachingServiceImpl
- shutdown() - Method in class org.dspace.services.events.SystemEventService
- shutdown() - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
- shutdownService(Object) - Static method in class org.dspace.servicemanager.DSpaceServiceManager
-
Shuts down a service if it asks to be shutdown or does nothing.
- ShutdownService - Interface in org.dspace.kernel.mixins
-
Allow the service to be notified when the service manager is shutting it down.
- size() - Method in class org.dspace.services.caching.model.EhcacheCache
- size() - Method in class org.dspace.services.caching.model.MapCache
- size() - Method in interface org.dspace.services.model.Cache
-
How many items does this cache hold?
- size() - Method in class org.dspace.utils.servicemanager.ProviderStack
-
Check the number of current providers which are available in this stack.
- SpringLoader - Interface in org.dspace.kernel.config
-
Interface that is used so that modules can determine their own spring file locations
- springXmlConfigFiles - Variable in class org.dspace.servicemanager.DSpaceServiceManager
- start() - Method in interface org.dspace.kernel.CommonLifecycle
-
Starts the bean.
- start() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- start(String) - Method in class org.dspace.servicemanager.DSpaceKernelImpl
-
This starts up the entire core system.
- start(ServiceManager) - Method in interface org.dspace.kernel.Activator
-
This is called when the service manager is starting this activator.
- startRequest() - Method in interface org.dspace.services.RequestService
-
Initiates a request in the system.
- startRequest() - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
- 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 - startRequest(ServletRequest, ServletResponse) - Method in class org.dspace.services.sessions.StatelessRequestServiceImpl
- startup() - Method in class org.dspace.servicemanager.DSpaceServiceManager
- startup() - Method in interface org.dspace.servicemanager.ServiceManagerSystem
-
Startup the service manager and initialize all services.
- StatelessRequestServiceImpl - Class in org.dspace.services.sessions
-
Implementation of the session service.
- StatelessRequestServiceImpl() - Constructor for class org.dspace.services.sessions.StatelessRequestServiceImpl
- stop() - Method in interface org.dspace.kernel.CommonLifecycle
-
Stops the bean.
- stop() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- stop(ServiceManager) - Method in interface org.dspace.kernel.Activator
-
This is called when the service manager is shutting down this activator.
- StreamUtils - Class in org.dspace.utils
-
Simple set of utilities which handle various stream operations.
- SystemEventService - Class in org.dspace.services.events
-
This is a placeholder until we get a real event service going.
- SystemEventService(RequestService, CachingService) - Constructor for class org.dspace.services.events.SystemEventService
- SystemEventService.EventRequestInterceptor - Class in org.dspace.services.events
-
The request interceptor for the event service.
T
- testing - Variable in class org.dspace.servicemanager.DSpaceServiceManager
- toString() - Method in class org.dspace.servicemanager.config.DSpaceConfigurationService
- toString() - Method in class org.dspace.servicemanager.DSpaceKernelImpl
- toString() - Method in class org.dspace.services.caching.model.EhcacheCache
- toString() - Method in class org.dspace.services.caching.model.MapCache
- toString() - Method in class org.dspace.services.model.Event
- toString() - Method in class org.dspace.utils.servicemanager.ProviderHolder
U
- unbindRequestCaches() - Method in class org.dspace.services.caching.CachingServiceImpl
-
Unbinds all request caches.
- 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).
- unregisterService(String) - Method in class org.dspace.servicemanager.DSpaceServiceManager
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
All Classes All Packages