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

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

public class WebApp
extends java.lang.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 addConstraintMapping(WebAppConstraintMapping constraintMapping)
          Add a security constraint
 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 addLoginConfig(WebAppLoginConfig loginConfig)
          Adds a login config
 void addMimeMapping(WebAppMimeMapping mimeMapping)
          Add a mime mapping.
 void addSecurityRole(WebAppSecurityRole securityRole)
          Adds a security role
 void addServlet(WebAppServlet servlet)
          Add a servlet.
 void addServletMapping(WebAppServletMapping servletMapping)
          Add a servlet mapping.
 void addWelcomeFile(java.lang.String welcomeFile)
          Add a welcome file.
 org.osgi.framework.Bundle getBundle()
          Getter.
 WebAppConstraintMapping[] getConstraintMappings()
           
 WebAppInitParam[] getContextParams()
          Return all context params.
 org.osgi.service.http.HttpContext getHttpContext()
          Getter.
 WebAppLoginConfig[] getLoginConfigs()
           
 WebAppMimeMapping[] getMimeMappings()
          Return all mime mappings.
 java.lang.String getRootPath()
           
 WebAppSecurityRole[] getSecurityRoles()
           
 java.lang.String getSessionTimeout()
          Getter.
 java.lang.String[] getWelcomeFiles()
          Return all welcome files.
 void setBundle(org.osgi.framework.Bundle bundle)
          Setter.
 void setContextName(java.lang.String contextName)
          Setter.
 void setDisplayName(java.lang.String displayName)
          Setter.
 void setHttpContext(org.osgi.service.http.HttpContext httpContext)
          Setter.
 void setRootPath(java.lang.String rootPath)
           
 void setSessionTimeout(java.lang.String minutes)
          Setter.
 java.lang.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(java.lang.String displayName)
Setter.

Parameters:
displayName - value to set

setContextName

public void setContextName(java.lang.String contextName)
Setter.

Parameters:
contextName - value to set. Cannot be null.
Throws:
org.ops4j.lang.NullArgumentException - if context name is null

setRootPath

public void setRootPath(java.lang.String rootPath)

getRootPath

public java.lang.String getRootPath()

setSessionTimeout

public void setSessionTimeout(java.lang.String minutes)
Setter.

Parameters:
minutes - session timeout

getSessionTimeout

public java.lang.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(java.lang.String welcomeFile)
Add a welcome file.

Parameters:
welcomeFile - to add
Throws:
org.ops4j.lang.NullArgumentException - if welcome file is null or empty

getWelcomeFiles

public java.lang.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

addConstraintMapping

public void addConstraintMapping(WebAppConstraintMapping constraintMapping)
Add a security constraint

Parameters:
securityConstraint -
Throws:
org.ops4j.lang.NullArgumentException - if security constraint is null

getConstraintMappings

public WebAppConstraintMapping[] getConstraintMappings()
Returns:

addSecurityRole

public void addSecurityRole(WebAppSecurityRole securityRole)
Adds a security role

Parameters:
securityRole -

getSecurityRoles

public WebAppSecurityRole[] getSecurityRoles()
Returns:

addLoginConfig

public void addLoginConfig(WebAppLoginConfig loginConfig)
Adds a login config

Parameters:
loginConfig -

getLoginConfigs

public WebAppLoginConfig[] getLoginConfigs()
Returns:

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 java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2006-2011 OPS4J - Open Participation Software for Java. All Rights Reserved.