Package org.pentaho.platform.config

Class WebXml

java.lang.Object

org.pentaho.platform.config.WebXml

public class WebXml
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	BASE_URL_CONTEXT_PARAM_NAME
protected static String	CONTEXT_CONFIG_CONTEXT_PARAM_NAME
protected static String	CONTEXT_PARAM_ELEMENT
protected static String	CONTEXT_PARAM_NAME_TEMPLATE_XPATH
protected static String	CONTEXT_PARAM_XPATH
protected static String	ENCODING_CONTEXT_PARAM_NAME
protected static String	FULLY_QUALIFIED_SERVER_URL_CONTEXT_PARAM_NAME
protected static String	HOME_SERVLET_NAME
protected static String	LOCALE_COUNTRY_CONTEXT_PARAM_NAME
protected static String	LOCALE_LANGUAGE_CONTEXT_PARAM_NAME
protected static String	PARAM_NAME_ELEMENT
protected static String	PARAM_VALUE_ELEMENT
protected static String	ROOT_ELEMENT
protected static String	SERVLET_NAME_TEMPLATE_XPATH
protected static String	SOLUTION_PATH_CONTEXT_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
WebXml()
WebXml(File pentahoXmlFile)
WebXml(String xml)
WebXml(org.dom4j.Document doc)

Method Summary

Modifier and Type	Method	Description
String	getBaseUrl()	Deprecated. use getFullyQualifiedServerUrl() instead.
String	getContextConfigFileName()
String	getContextParamValue(String name)
org.dom4j.Document	getDocument()
String	getEncoding()
String	getFullyQualifiedServerUrl()
String	getHomePage()
String	getLocaleCountry()
String	getLocaleLanguage()
String	getServletMapping(String name)
String	getSolutionPath()
void	setBaseUrl(String baseUrl)
void	setContextConfigFileName(String fileName)
void	setContextParamValue(String name, String value)
void	setEncoding(String encoding)
void	setFullyQualifiedServerUrl(String fullyQualifiedServerUrl)
void	setHomePage(String homePage)
void	setLocaleCountry(String country)
void	setLocaleLanguage(String language)
boolean	setServletMapping(String name, String value)
void	setSolutionPath(String solutionPath)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_NAME_ELEMENT

protected static final String PARAM_NAME_ELEMENT

See Also:

Constant Field Values

PARAM_VALUE_ELEMENT

protected static final String PARAM_VALUE_ELEMENT

See Also:

Constant Field Values

ROOT_ELEMENT

protected static final String ROOT_ELEMENT

See Also:

Constant Field Values

CONTEXT_CONFIG_CONTEXT_PARAM_NAME

protected static final String CONTEXT_CONFIG_CONTEXT_PARAM_NAME

See Also:

Constant Field Values

BASE_URL_CONTEXT_PARAM_NAME

protected static final String BASE_URL_CONTEXT_PARAM_NAME

See Also:

Constant Field Values

FULLY_QUALIFIED_SERVER_URL_CONTEXT_PARAM_NAME

protected static final String FULLY_QUALIFIED_SERVER_URL_CONTEXT_PARAM_NAME

See Also:

Constant Field Values

SOLUTION_PATH_CONTEXT_PARAM_NAME

protected static final String SOLUTION_PATH_CONTEXT_PARAM_NAME

See Also:

Constant Field Values

LOCALE_LANGUAGE_CONTEXT_PARAM_NAME

protected static final String LOCALE_LANGUAGE_CONTEXT_PARAM_NAME

See Also:

Constant Field Values

LOCALE_COUNTRY_CONTEXT_PARAM_NAME

protected static final String LOCALE_COUNTRY_CONTEXT_PARAM_NAME

See Also:

Constant Field Values

ENCODING_CONTEXT_PARAM_NAME

protected static final String ENCODING_CONTEXT_PARAM_NAME

See Also:

Constant Field Values

HOME_SERVLET_NAME

protected static final String HOME_SERVLET_NAME

See Also:

Constant Field Values

CONTEXT_PARAM_ELEMENT

protected static final String CONTEXT_PARAM_ELEMENT

See Also:

Constant Field Values

CONTEXT_PARAM_XPATH

protected static final String CONTEXT_PARAM_XPATH

See Also:

Constant Field Values

CONTEXT_PARAM_NAME_TEMPLATE_XPATH

protected static final String CONTEXT_PARAM_NAME_TEMPLATE_XPATH

See Also:

Constant Field Values

SERVLET_NAME_TEMPLATE_XPATH

protected static final String SERVLET_NAME_TEMPLATE_XPATH

See Also:

Constant Field Values

Constructor Detail

WebXml

public WebXml(File pentahoXmlFile)
       throws IOException,
              org.dom4j.DocumentException,
              org.pentaho.platform.api.util.XmlParseException

Throws:

IOException

org.dom4j.DocumentException

org.pentaho.platform.api.util.XmlParseException

WebXml

public WebXml(String xml)
       throws org.dom4j.DocumentException,
              org.pentaho.platform.api.util.XmlParseException

Throws:

org.dom4j.DocumentException

org.pentaho.platform.api.util.XmlParseException

WebXml

public WebXml(org.dom4j.Document doc)
       throws org.dom4j.DocumentException

Throws:

org.dom4j.DocumentException

WebXml

public WebXml()

Method Detail

getContextConfigFileName

public String getContextConfigFileName()

getBaseUrl

@Deprecated
public String getBaseUrl()

Deprecated.

use getFullyQualifiedServerUrl() instead.

Returns:

the fully qualified url of the server

getFullyQualifiedServerUrl

public String getFullyQualifiedServerUrl()

getSolutionPath

public String getSolutionPath()

getLocaleLanguage

public String getLocaleLanguage()

getLocaleCountry

public String getLocaleCountry()

getEncoding

public String getEncoding()

getHomePage

public String getHomePage()

setContextConfigFileName

public void setContextConfigFileName(String fileName)

setBaseUrl

public void setBaseUrl(String baseUrl)

setFullyQualifiedServerUrl

public void setFullyQualifiedServerUrl(String fullyQualifiedServerUrl)

setSolutionPath

public void setSolutionPath(String solutionPath)

setLocaleLanguage

public void setLocaleLanguage(String language)

setLocaleCountry

public void setLocaleCountry(String country)

setEncoding

public void setEncoding(String encoding)

setHomePage

public void setHomePage(String homePage)

getDocument

public org.dom4j.Document getDocument()

getContextParamValue

public String getContextParamValue(String name)

setContextParamValue

public void setContextParamValue(String name,
                                 String value)

setServletMapping

public boolean setServletMapping(String name,
                                 String value)

getServletMapping

public String getServletMapping(String name)