Package edu.ucsb.nceas.metacat.admin

Class PropertiesAdmin

java.lang.Object

edu.ucsb.nceas.metacat.admin.MetacatAdmin

edu.ucsb.nceas.metacat.admin.PropertiesAdmin

public class PropertiesAdmin
extends MetacatAdmin

Control the display of the main properties configuration page and the processing of the configuration values.

Field Summary

Fields inherited from class edu.ucsb.nceas.metacat.admin.MetacatAdmin

FAILURE, IN_PROGRESS, SUCCESS

Method Summary

Modifier and Type	Method	Description
void	configureProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Handle configuration of the main application properties
static PropertiesAdmin	getInstance()	Get the single instance of the MetaCatConfig.
protected boolean	isIndexerCodeployed()	Determine if the metacat-index context exists with metacat in the same Tomcat container.
protected void	setMNBaseURL(Collection<String> validationErrors)	Set the property of dataone.mn.baseURL automatically
protected String	updateMetacatPropertiesPath(String metacatContext, String webXmlContents)
protected Vector<String>	validateOptions(javax.servlet.http.HttpServletRequest request)	Validate the most important configuration options submitted by the user.

Methods inherited from class edu.ucsb.nceas.metacat.admin.MetacatAdmin

updateUpgradeStatus

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static PropertiesAdmin getInstance()

Get the single instance of the MetaCatConfig.

Returns:

the single instance of MetaCatConfig

configureProperties

public void configureProperties(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                         throws AdminException

Handle configuration of the main application properties

Parameters:

request - the http request object

response - the http response to be sent back to the client

Throws:

AdminException

updateMetacatPropertiesPath

protected String updateMetacatPropertiesPath(String metacatContext,
 String webXmlContents)

validateOptions

protected Vector<String> validateOptions(javax.servlet.http.HttpServletRequest request)

Validate the most important configuration options submitted by the user.

Specified by:

validateOptions in class MetacatAdmin

Parameters:

request - the http request object

Returns:

a vector holding error message for any fields that fail validation.

setMNBaseURL

protected void setMNBaseURL(Collection<String> validationErrors)

Set the property of dataone.mn.baseURL automatically

Parameters:

validationErrors - the container for error message

isIndexerCodeployed

protected boolean isIndexerCodeployed()
                               throws AdminException

Determine if the metacat-index context exists with metacat in the same Tomcat container. Now we use the file directory as the indicator. We maybe change it in the future.

Returns:

true if it exists; otherwise false.

Throws:

AdminException