com.esri.gpt.server.csw.provider.components
Class ServiceProperties

java.lang.Object
  com.esri.gpt.server.csw.provider.components.ServiceProperties

public class ServiceProperties
extends Object

Describes the properties associated with a service.

Constructor Summary

ServiceProperties()
Default constructor

Method Summary

Map<String,Object>	getAdditionalProperties() Gets the free form map of additional properties.
String	getCswBaseURL() Convenience method to get the base CSW URL used for call back functions.
String	getCswSubContextPath() Gets the HTTP sub-context path associated with the CSW service.
String	getHttpContextPath() Gets the base context path associated with an active HTTP request.
String	getResourceFilePrefix() Gets the path prefix for resource files.
String	getServiceName() Gets the service name.
String	getServiceVersion() Gets the service version.
SupportedParameters	getSupportedParameters() Gets the supported parameters.
ISupportedValues	getSupportedValues(String parameterName) Gets the supported values for a parameter.
void	setAdditionalProperties(Map<String,Object> additionalProperties) Sets the free form map of additional properties.
void	setCswSubContextPath(String path) Sets the HTTP sub-context path associated with the CSW service.
void	setHttpContextPath(String path) Sets the base context path associated with an active HTTP request.
void	setResourceFilePrefix(String resourceFilePrefix) Sets the path prefix for XML/XSLT resource files.
void	setServiceName(String serviceName) Sets the service name.
void	setServiceVersion(String serviceVersion) Sets the service version.
void	setSupportedParameters(SupportedParameters supportedParameters) Sets the supported parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceProperties

public ServiceProperties()

Default constructor

Method Detail

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Gets the free form map of additional properties.

Returns:

the additional properties

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)

Sets the free form map of additional properties.

Parameters:

additionalProperties - the additional properties

getCswBaseURL

public String getCswBaseURL()

Convenience method to get the base CSW URL used for call back functions.

A CSW base URL will have the form:
http://host:port/context/sub-context
e.g. http://host:port/geoportal/csw

Returns:

the CSW base URL

getCswSubContextPath

public String getCswSubContextPath()

Gets the HTTP sub-context path associated with the CSW service.

A CSW request URL will have the form:
http://host:port/context/sub-context
e.g. http://host:port/geoportal/csw
where /csw is the CSW sub-context path

Returns:

the CSW sub-context path

setCswSubContextPath

public void setCswSubContextPath(String path)

Sets the HTTP sub-context path associated with the CSW service.

A CSW base URL will have the form:
http://host:port/context/sub-context
e.g. http://host:port/geoportal/csw
where /csw is the CSW sub-context path

Parameters:

path - the CSW sub-context path

getHttpContextPath

public String getHttpContextPath()

Gets the base context path associated with an active HTTP request.

The base context path has the form:
http://host:port/context

Returns:

the base context path

setHttpContextPath

public void setHttpContextPath(String path)

Sets the base context path associated with an active HTTP request.

The base context path has the form:
http://host:port/context

Parameters:

path - the base context path

getResourceFilePrefix

public String getResourceFilePrefix()

Gets the path prefix for resource files.

Returns:

the resource file path prefix

setResourceFilePrefix

public void setResourceFilePrefix(String resourceFilePrefix)

Sets the path prefix for XML/XSLT resource files.

Parameters:

resourceFilePrefix - the resource file path prefix

getServiceName

public String getServiceName()

Gets the service name.

Returns:

the service name

setServiceName

public void setServiceName(String serviceName)

Sets the service name.

Parameters:

serviceName - the service name

getServiceVersion

public String getServiceVersion()

Gets the service version.

Returns:

the service version

setServiceVersion

public void setServiceVersion(String serviceVersion)

Sets the service version.

Parameters:

serviceVersion - the service version

getSupportedParameters

public SupportedParameters getSupportedParameters()

Gets the supported parameters.

Returns:

the supported parameters

setSupportedParameters

public void setSupportedParameters(SupportedParameters supportedParameters)

Sets the supported parameters.

Parameters:

supportedParameters - the supported parameters

getSupportedValues

public ISupportedValues getSupportedValues(String parameterName)

Gets the supported values for a parameter.

Parameters:

parameterName - the parameter name

Returns:

the supported values (can be null)