org.fcrepo.server
Class Parameterized

java.lang.Object
  org.fcrepo.server.Parameterized

All Implemented Interfaces:

Constants

Direct Known Subclasses:

Configuration, Pluggable

public abstract class Parameterized
extends Object
implements Constants

Abstract superclass of all Fedora components that can be configured by a set of name-value pairs.

Author:

Chris Wilper

Nested Class Summary

Nested classes/interfaces inherited from interface org.fcrepo.common.Constants

Constants.FedoraHome

Field Summary

Fields inherited from interface org.fcrepo.common.Constants

ACCESS, ACTION, API, ATOM_APIM1_0, ATOM_ZIP1_1, ATOM1_1, AUDIT, AUDIT1_0, BATCH_MODIFY, BATCH_MODIFY1_1, BE_SECURITY, BE_SECURITY1_0, BINDING_SPEC, DATASTREAM, DC, DISSEMINATOR, DS_COMPOSITE_MODEL, DS_COMPOSITE_MODEL1_0, DS_INPUT_SPEC1_0, DS_INPUT_SPEC1_1, ENVIRONMENT, FCFG, FEDORA, FEDORA_APP_CONTEXT_NAME, FEDORA_DEFAULT_APP_CONTEXT, FEDORA_HOME, FOXML, FOXML1_0, FOXML1_0_LEGACY, FOXML1_1, HTTP_REQUEST, MANAGEMENT, METHOD_MAP, METS, METS_EXT, METS_EXT1_0, METS_EXT1_0_LEGACY, METS_EXT1_1, MODEL, MULGARA, OAI_DC, OAI_DC2_0, OAI_FRIENDS, OAI_FRIENDS2_0, OAI_IDENTIFIER, OAI_IDENTIFIER2_0, OAI_PMH, OAI_PMH2_0, OAI_PROV, OAI_PROV2_0, OBJ_DATASTREAMS1_0, OBJ_HISTORY1_0, OBJ_ITEMS1_0, OBJ_METHODS1_0, OBJ_PROFILE1_0, OBJ_VALIDATION1_0, OBJECT, OLD_XLINK, PID_LIST1_0, RDF, RDF_XSD, RECOVERY, RELS_EXT, RELS_EXT1_0, RELS_INT1_0, REPO_DESC1_0, RESOURCE, SDEF, SDEF_METHOD_MAP1_0, SDEP, SDEP_METHOD_MAP1_0, SDEP_METHOD_MAP1_1, SERVICE_PROFILE, SOAP, SOAP_ENC, SUBJECT, TYPES, VIEW, WSDL, WSDL_HTTP, WSDL_MIME, XACML_POLICY, XACML_POLICY1_0, XLINK, XML_XSD, XMLNS, XSI

Constructor Summary

Parameterized()
Creates a Parameterized with no parameters.

Parameterized(List<Parameter> parameters)

Parameterized(Map<String,String> parameters)
Creates a Parameterized with name-value pairs from the supplied Map.

Method Summary

String	getParameter(String name) Gets the value of a named configuration parameter.
String	getParameter(String name, boolean asAbsolutePath) Gets the value of a named configuration parameter.
Parameter	getParameter(String name, Class<Parameter> type)
protected static List<Parameter>	getParameterList(Map<String,String> map)
Map<String,String>	getParameters()
Collection<Parameter>	getParameters(Class<Parameter> type)
Iterator<String>	parameterNames() Gets an Iterator over the names of parameters for this component.
protected void	setParameter(String name, String value)
protected void	setParameters(List<Parameter> parameters)
protected void	setParameters(Map<String,String> parameters) Sets the parameters with name-value pairs from the supplied Map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Parameterized

public Parameterized()

Creates a Parameterized with no parameters.

Parameterized

public Parameterized(Map<String,String> parameters)

Creates a Parameterized with name-value pairs from the supplied Map.

Parameters:

parameters - The map from which to derive the name-value pairs.

Parameterized

public Parameterized(List<Parameter> parameters)

Method Detail

setParameters

protected final void setParameters(Map<String,String> parameters)

Sets the parameters with name-value pairs from the supplied Map. This is protected because it is intended to only be called by subclasses where super(Map m) is not possible to call at the start of the constructor. Server.java:Server(URL) is an example of this.

Parameters:

parameters - The map from which to derive the name-value pairs.

setParameters

protected final void setParameters(List<Parameter> parameters)

getParameter

public final String getParameter(String name,
                                 boolean asAbsolutePath)

Gets the value of a named configuration parameter. Same as getParameter(String name) but prepends the location of FEDORA_HOME if asAbsolutePath is true and the parameter location does not already specify an absolute pathname.

Parameters:

name - The parameter name.

asAbsolutePath - Whether to return the parameter value as an absolute path relative to FEDORA_HOME.

Returns:

The value, null if undefined.

getParameter

public final String getParameter(String name)

Gets the value of a named configuration parameter.

Parameters:

name - The parameter name.

Returns:

String The value, null if undefined.

getParameter

public final Parameter getParameter(String name,
                                    Class<Parameter> type)

setParameter

protected final void setParameter(String name,
                                  String value)

getParameters

public Map<String,String> getParameters()

getParameters

public Collection<Parameter> getParameters(Class<Parameter> type)

parameterNames

public final Iterator<String> parameterNames()

Gets an Iterator over the names of parameters for this component.

Returns:

Iterator The names.

getParameterList

protected static List<Parameter> getParameterList(Map<String,String> map)