org.ops4j.pax.web.extender.war.internal.model
Class WebApp

java.lang.Object
  org.ops4j.pax.web.extender.war.internal.model.WebApp

public class WebApp
extends Object

Root element of web.xml.

Since:

0.3.0, December 27, 2007

Author:

Alin Dreghiciu

Constructor Summary

WebApp()
Creates a new web app.

Method Summary

void	accept(WebAppVisitor visitor) Accepts a visitor for inner elements.
void	addContextParam(WebAppInitParam contextParam) Add a context param.
void	addErrorPage(WebAppErrorPage errorPage) Add an error page.
void	addFilter(WebAppFilter filter) Add a filter.
void	addFilterMapping(WebAppFilterMapping filterMapping) Add a filter mapping.
void	addListener(WebAppListener listener) Add a listener.
void	addMimeMapping(WebAppMimeMapping mimeMapping) Add a mime mapping.
void	addServlet(WebAppServlet servlet) Add a servlet.
void	addServletMapping(WebAppServletMapping servletMapping) Add a servlet mapping.
void	addWelcomeFile(String welcomeFile) Add a welcome file.
org.osgi.framework.Bundle	getBundle() Getter.
WebAppInitParam[]	getContextParams() Return all context params.
org.osgi.service.http.HttpContext	getHttpContext() Getter.
WebAppMimeMapping[]	getMimeMappings() Return all mime mappings.
String	getSessionTimeout() Getter.
String[]	getWelcomeFiles() Return all welcome files.
void	setBundle(org.osgi.framework.Bundle bundle) Setter.
void	setContextName(String contextName) Setter.
void	setDisplayName(String displayName) Setter.
void	setHttpContext(org.osgi.service.http.HttpContext httpContext) Setter.
void	setSessionTimeout(String minutes) Setter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebApp

public WebApp()

Creates a new web app.

Method Detail

setDisplayName

public void setDisplayName(String displayName)

Setter.

Parameters:

displayName - value to set

setContextName

public void setContextName(String contextName)

Setter.

Parameters:

contextName - value to set. Cannot be null.

Throws:

org.ops4j.lang.NullArgumentException - if context name is null

setSessionTimeout

public void setSessionTimeout(String minutes)

Setter.

Parameters:

minutes - session timeout

getSessionTimeout

public String getSessionTimeout()

Getter.

Returns:

session timeout in minutes

getBundle

public org.osgi.framework.Bundle getBundle()

Getter.

Returns:

bundle

setBundle

public void setBundle(org.osgi.framework.Bundle bundle)

Setter.

Parameters:

bundle - value to set

addServlet

public void addServlet(WebAppServlet servlet)

Add a servlet.

Parameters:

servlet - to add

Throws:

org.ops4j.lang.NullArgumentException - if servlet, servlet name or servlet class is null

addServletMapping

public void addServletMapping(WebAppServletMapping servletMapping)

Add a servlet mapping.

Parameters:

servletMapping - to add

Throws:

org.ops4j.lang.NullArgumentException - if servlet mapping, servlet name or url pattern is null

addFilter

public void addFilter(WebAppFilter filter)

Add a filter.

Parameters:

filter - to add

Throws:

org.ops4j.lang.NullArgumentException - if filter, filter name or filter class is null

addFilterMapping

public void addFilterMapping(WebAppFilterMapping filterMapping)

Add a filter mapping.

Parameters:

filterMapping - to add

Throws:

org.ops4j.lang.NullArgumentException - if filter mapping or filter name is null

addListener

public void addListener(WebAppListener listener)

Add a listener.

Parameters:

listener - to add

Throws:

org.ops4j.lang.NullArgumentException - if listener or listener class is null

addErrorPage

public void addErrorPage(WebAppErrorPage errorPage)

Add an error page.

Parameters:

errorPage - to add

Throws:

org.ops4j.lang.NullArgumentException - if error page is null or both error type and exception code is null

addWelcomeFile

public void addWelcomeFile(String welcomeFile)

Add a welcome file.

Parameters:

welcomeFile - to add

Throws:

org.ops4j.lang.NullArgumentException - if welcome file is null or empty

getWelcomeFiles

public String[] getWelcomeFiles()

Return all welcome files.

Returns:

an array of all welcome files

addContextParam

public void addContextParam(WebAppInitParam contextParam)

Add a context param.

Parameters:

contextParam - to add

Throws:

org.ops4j.lang.NullArgumentException - if context param, param name or param value is null

getContextParams

public WebAppInitParam[] getContextParams()

Return all context params.

Returns:

an array of all context params

addMimeMapping

public void addMimeMapping(WebAppMimeMapping mimeMapping)

Add a mime mapping.

Parameters:

mimeMapping - to add

Throws:

org.ops4j.lang.NullArgumentException - if mime mapping, extension or mime type is null

getMimeMappings

public WebAppMimeMapping[] getMimeMappings()

Return all mime mappings.

Returns:

an array of all mime mappings

getHttpContext

public org.osgi.service.http.HttpContext getHttpContext()

Getter.

Returns:

http context

setHttpContext

public void setHttpContext(org.osgi.service.http.HttpContext httpContext)

Setter.

Parameters:

httpContext - value to set

accept

public void accept(WebAppVisitor visitor)

Accepts a visitor for inner elements.

Parameters:

visitor - visitor

toString

public String toString()

Overrides:

toString in class Object