mirror of
https://github.com/DSpace/DSpace.git
synced 2025-10-17 15:03:18 +00:00
4f89b66f26
git-svn-id: http://scm.dspace.org/svn/repo/modules/dspace-services/trunk@4551 9c30dcfa-912a-0410-8fc2-9e0234be79fd
118 lines
4.6 KiB
Java
118 lines
4.6 KiB
Java
/**
|
|
* $Id$
|
|
* $URL$
|
|
* *************************************************************************
|
|
* Copyright (c) 2002-2009, DuraSpace. All rights reserved
|
|
* Licensed under the DuraSpace License.
|
|
*
|
|
* A copy of the DuraSpace License has been included in this
|
|
* distribution and is available at: http://scm.dspace.org/svn/repo/licenses/LICENSE.txt
|
|
*/
|
|
package org.dspace.services;
|
|
|
|
import java.util.Map;
|
|
import java.util.Properties;
|
|
|
|
|
|
/**
|
|
* This service handles retrieval of the configuration data for a DSpace instance <br/>
|
|
* The config files are properties files which look like this for simple config values:
|
|
* <xmp>
|
|
* thing.name = aaronz
|
|
* thing.number = 1234
|
|
* thing.on = true
|
|
* thing.value = abc,def,ghi
|
|
* </xmp>
|
|
* For these simple cases the service will automatically translate the settings into strings, booleans, numbers and arrays as requested
|
|
* in the various {@link #getPropertyAsType(String, Class)} methods <br/>
|
|
* <br/>
|
|
* There are special case config params allowed as well. <br/>
|
|
* The first allows setting of a param on any DSpace service by the given name,
|
|
* this should be used sparingly and really only by system admins (not developers),
|
|
* developers should be using simple config values to expose service configurations:
|
|
* <xmp>
|
|
* emailEnabled@org.dspace.Service = true
|
|
* adminUser@org.dspace.impl.MyService = aaronz
|
|
* </xmp>
|
|
*
|
|
* The second allows controlling the implementation used for a service interface or provider:
|
|
* <xmp>
|
|
* $org.dspace.Service = org.dspace.impl.MyService
|
|
* </xmp>
|
|
*
|
|
* @author Aaron Zeckoski (azeckoski @ gmail.com)
|
|
*/
|
|
public interface ConfigurationService {
|
|
|
|
/**
|
|
* Get a configuration property (setting) from the system as a certain type
|
|
*
|
|
* @param <T>
|
|
* @param name the property name
|
|
* @param type the type to return the property as
|
|
* @return the property value OR null if none is found
|
|
* @throws UnsupportedOperationException if the type cannot be converted to the requested type
|
|
*/
|
|
public <T> T getPropertyAsType(String name, Class<T> type);
|
|
|
|
/**
|
|
* Get a configuration property (setting) from the system and return the default value if none is found
|
|
*
|
|
* @param <T>
|
|
* @param name the property name
|
|
* @param defaultValue the value to return if this name is not found
|
|
* @return the property value OR null if none is found
|
|
* @throws IllegalArgumentException if the defaultValue type does not match the type of the property by name
|
|
*/
|
|
public <T> T getPropertyAsType(String name, T defaultValue);
|
|
|
|
/**
|
|
* Get a configuration property (setting) from the system and return the default value if none is found
|
|
*
|
|
* @param <T>
|
|
* @param name the property name
|
|
* @param defaultValue the value to return if this name is not found
|
|
* @param setDefaultIfNotFound if this is true and the config value is not found then
|
|
* the default value will be set in the configuration store assuming it is not null,
|
|
* otherwise the default value is just returned but not set
|
|
* @return the property value OR null if none is found
|
|
* @throws IllegalArgumentException if the defaultValue type does not match the type of the property by name
|
|
*/
|
|
public <T> T getPropertyAsType(String name, T defaultValue, boolean setDefaultIfNotFound);
|
|
|
|
/**
|
|
* Get all currently known configuration settings
|
|
*
|
|
* @return all the configuration properties as a map of name -> value
|
|
*/
|
|
public Map<String, String> getAllProperties();
|
|
|
|
/**
|
|
* Convenience method - get a configuration property (setting) from the system
|
|
*
|
|
* @param name the property name
|
|
* @return the property value OR null if none is found
|
|
*/
|
|
public String getProperty(String name);
|
|
|
|
/**
|
|
* Convenience method - get many configuration properties (setting) from the system
|
|
*
|
|
* @return all the configuration properties in a properties object (name -> value)
|
|
*/
|
|
public Properties getProperties();
|
|
|
|
/**
|
|
* Set a configuration property (setting) in the system,
|
|
* type is not important here since conversion happens automatically when properties are requested
|
|
*
|
|
* @param name the property name
|
|
* @param value the property value (set this to null to clear out the property)
|
|
* @return true if the property is new or changed from the existing value, false if it is the same
|
|
* @throws IllegalArgumentException if the name is null
|
|
* @throws UnsupportedOperationException if the type cannot be converted to something that is understandable by the system as a configuration property value
|
|
*/
|
|
public boolean setProperty(String name, Object value);
|
|
|
|
}
|