com.logicaldoc.util.config

Class WebConfigurator

java.lang.Object

com.logicaldoc.util.config.XMLBean

com.logicaldoc.util.config.WebConfigurator

public class WebConfigurator
extends XMLBean

Configurator for the web.xml file

Since:

3.0

Author:

Marco Meschieri - Logical Objects, Sebastian Wenzky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebConfigurator.INIT_PARAM

Field Summary

Fields inherited from class com.logicaldoc.util.config.XMLBean

log

Constructor Summary

Constructors

Constructor and Description
WebConfigurator(String path)

Method Summary

Methods

Modifier and Type	Method and Description
void	addContextParam(String param_name, String param_value, String param_description, WebConfigurator.INIT_PARAM append) Adding a contextparam to the web.xml
void	addFilter(String name, String clazz) Adds a new filter to the deployment descriptor.
void	addFilterMapping(String filter, String pattern) Adds a new filter mapping to the deployment descriptor.
void	addInitParam(String servletName, String param_name, String param_value, String param_description) Adds a init parameter to the servlet
void	addInitParam(String servletName, String param_name, String param_value, String param_description, WebConfigurator.INIT_PARAM append) Adds a init parameter to the servlet
void	addListener(String clazz) Adds a new listener to the deployment descriptor.
void	addListenerInitParam(String listenerClazz, String param_name, String param_value, WebConfigurator.INIT_PARAM append) Adds a init parameter to the listener
void	addServlet(String name, String clazz) Adds a new servlet mapping to the deployment descriptor.
void	addServlet(String name, String clazz, int load_on_startup) Adds a new servlet to the deployment descriptor.
void	addServletMapping(String servlet, String pattern) Adds a new servlet mapping to the deployment descriptor.
String	getDisplayName()
void	setDescription(String description)
void	setDisplayName(String displayName)

Methods inherited from class com.logicaldoc.util.config.XMLBean

getAllAttribute, getAllChild, getAllChild, getAllChildText, getAttribute, getAttributeValue, getChild, getChild, getChildText, getRootChild, getRootElement, getText, getText, removeChild, setAttributeValue, setText, writeXMLDoc

Methods inherited from class java.lang.Object

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

Constructor Detail

WebConfigurator

public WebConfigurator(String path)

Method Detail

addContextParam

public void addContextParam(String param_name,
                   String param_value,
                   String param_description,
                   WebConfigurator.INIT_PARAM append)

Adding a contextparam to the web.xml

Parameters:

param_name - the param

param_value - the value

param_description -

append - * @param append if the param exist, should the new value appended? possible values are represented in WebConfigurator.INIT_PARAM

addInitParam

public void addInitParam(String servletName,
                String param_name,
                String param_value,
                String param_description,
                WebConfigurator.INIT_PARAM append)

Adds a init parameter to the servlet

Parameters:

servletName - The name of the servlet

name - Name of the Parameter

value - Value of the Parameter

description - Description

append - if the param exist, should the new value appended? possible values are represented in WebConfigurator.INIT_PARAM

addListenerInitParam

public void addListenerInitParam(String listenerClazz,
                        String param_name,
                        String param_value,
                        WebConfigurator.INIT_PARAM append)

Adds a init parameter to the listener

Parameters:

listenerClazz - The class of the listener

name - Name of the Parameter

value - Value of the Parameter

append - if the param exist, should the new value appended? possible values are represented in WebConfigurator.INIT_PARAM

addInitParam

public void addInitParam(String servletName,
                String param_name,
                String param_value,
                String param_description)

Adds a init parameter to the servlet

Parameters:

clazz - The classname

name - Name of the Parameter

value - Value of the Parameter

description - Description

addServlet

public void addServlet(String name,
              String clazz)

Adds a new servlet mapping to the deployment descriptor. If the mapping already exists no modifications are committed.

Parameters:

name - The servlet name

clazz - The servlet class fully qualified name

addServlet

public void addServlet(String name,
              String clazz,
              int load_on_startup)

Adds a new servlet to the deployment descriptor. If the servlet already exists no modifications are committed.

Parameters:

name - The servlet name

clazz - The servlet class fully qualified name

load_on - startup

addFilter

public void addFilter(String name,
             String clazz)

Adds a new filter to the deployment descriptor. If the filter already exists no modifications are committed.

Parameters:

name - The filter name

clazz - The filter class fully qualified name

addListener

public void addListener(String clazz)

Adds a new listener to the deployment descriptor. If the listener already exists no modifications are committed. e

Parameters:

clazz - The filter class fully qualified name

addServletMapping

public void addServletMapping(String servlet,
                     String pattern)

Adds a new servlet mapping to the deployment descriptor. If the mapping already exists no modifications are committed.

Parameters:

servlet - The name of the servlet

pattern - The mapping pattern

addFilterMapping

public void addFilterMapping(String filter,
                    String pattern)

Adds a new filter mapping to the deployment descriptor. If the mapping already exists no modifications are committed.

Parameters:

filter - The name of the filter

pattern - The mapping pattern

setDisplayName

public void setDisplayName(String displayName)

getDisplayName

public String getDisplayName()

setDescription

public void setDescription(String description)