org.apache.oodt.cas.curation.service

Class CurationServiceConfig

java.lang.Object

org.apache.oodt.cas.curation.service.CurationServiceConfig

All Implemented Interfaces:

CuratorConfMetKeys

public class CurationServiceConfig
extends Object
implements CuratorConfMetKeys

Configures the CurationService by reading the parameters out of the context.xml file, doing a PathUtils.replaceEnvVariables(String) on each property in the context.xml. This allows you to specify environment variables using the traditional CAS syntax of:

   [VAR_NAME], e.g., [CAS_CURATOR_HOME]/some/other/path
 

The configuration parameters are read once upon loading the instance of this object.

Version:

$Revision$

Author:

pramirez, mattmann

Field Summary

Fields inherited from interface org.apache.oodt.cas.curation.metadata.CuratorConfMetKeys

CATALOG_FACTORY_CLASS, CRAWLER_CONF_FILE, DEFAULT_TRANSFER_FACTORY, FM_PROPS, FM_URL, MET_AREA_PATH, MET_EXTENSION, MET_EXTRACTOR_CONF_UPLOAD_PATH, POLICY_UPLOAD_PATH, STAGING_AREA_PATH

Method Summary

Modifier and Type	Method and Description
String	getCrawlerConfFile()
String	getDefaultTransferFactory()
XmlRpcFileManagerClient	getFileManagerClient()
String	getFileMgrProps()
String	getFileMgrURL()
static CurationServiceConfig	getInstance(javax.servlet.ServletConfig conf) Gets a singleton static instance of the global CurationServiceConfig for the CAS Curator Webapp.
String	getMetAreaPath()
String	getMetExtension()
String	getMetExtrConfUploadPath()
String	getParameter(String name) Gets a property from the CAS Curator config without calling PathUtils.replaceEnvVariables(String).
String	getPolicyUploadPath()
String	getStagingAreaPath()

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static CurationServiceConfig getInstance(javax.servlet.ServletConfig conf)

Gets a singleton static instance of the global CurationServiceConfig for the CAS Curator Webapp.

Parameters:

conf - The ServletConfig read on startup of the webapp. This is typically specified in a context.xml file, but can also be specified in web.xml.

Returns:

A singleton instance of the global CurationServiceConfig.

Throws:

InstantiationException - If there is any error constructing the config.

getMetAreaPath

public String getMetAreaPath()

Returns:

The metadata output file path.

getMetExtension

public String getMetExtension()

Returns:

The extension of metadata files that will be generated and consumed by CAS curator.

getStagingAreaPath

public String getStagingAreaPath()

Returns:

The path to the staging area where the CAS curator is ingesting files from.

getFileMgrURL

public String getFileMgrURL()

Returns:

A String representation of the CAS File Manager URL .

getFileManagerClient

public XmlRpcFileManagerClient getFileManagerClient()

Returns:

The full XmlRpcFileManagerClient built from the CAS curator property filemgr.url.

getMetExtrConfUploadPath

public String getMetExtrConfUploadPath()

Returns:

The upload path for metadata extractor config files.

getCrawlerConfFile

public String getCrawlerConfFile()

Returns:

The path to the crawler config file.

getPolicyUploadPath

public String getPolicyUploadPath()

Returns:

The path to the location where policy directories should be uploaded to.

getDefaultTransferFactory

public String getDefaultTransferFactory()

Returns:

The default CAS File Manager DataTransferFactory classname.

getParameter

public String getParameter(String name)

Gets a property from the CAS Curator config without calling PathUtils.replaceEnvVariables(String).

Parameters:

name - The name of the parameter to return.

Returns:

The un-evaluated property value from the config.

getFileMgrProps

public String getFileMgrProps()