|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ops4j.pax.web.extender.war.internal.model.WebApp
public class WebApp
Root element of web.xml.
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 |
---|
public WebApp()
Method Detail |
---|
public void setDisplayName(java.lang.String displayName)
displayName
- value to setpublic void setContextName(java.lang.String contextName)
contextName
- value to set. Cannot be null.
org.ops4j.lang.NullArgumentException
- if context name is nullpublic void setRootPath(java.lang.String rootPath)
public java.lang.String getRootPath()
public void setSessionTimeout(java.lang.String minutes)
minutes
- session timeoutpublic java.lang.String getSessionTimeout()
public org.osgi.framework.Bundle getBundle()
public void setBundle(org.osgi.framework.Bundle bundle)
bundle
- value to setpublic void addServlet(WebAppServlet servlet)
servlet
- to add
org.ops4j.lang.NullArgumentException
- if servlet, servlet name or servlet class is nullpublic void addServletMapping(WebAppServletMapping servletMapping)
servletMapping
- to add
org.ops4j.lang.NullArgumentException
- if servlet mapping, servlet name or url pattern is nullpublic void addFilter(WebAppFilter filter)
filter
- to add
org.ops4j.lang.NullArgumentException
- if filter, filter name or filter class is nullpublic void addFilterMapping(WebAppFilterMapping filterMapping)
filterMapping
- to add
org.ops4j.lang.NullArgumentException
- if filter mapping or filter name is nullpublic void addListener(WebAppListener listener)
listener
- to add
org.ops4j.lang.NullArgumentException
- if listener or listener class is nullpublic void addErrorPage(WebAppErrorPage errorPage)
errorPage
- to add
org.ops4j.lang.NullArgumentException
- if error page is null or both error type and exception code is nullpublic void addWelcomeFile(java.lang.String welcomeFile)
welcomeFile
- to add
org.ops4j.lang.NullArgumentException
- if welcome file is null or emptypublic java.lang.String[] getWelcomeFiles()
public void addContextParam(WebAppInitParam contextParam)
contextParam
- to add
org.ops4j.lang.NullArgumentException
- if context param, param name or param value is nullpublic WebAppInitParam[] getContextParams()
public void addMimeMapping(WebAppMimeMapping mimeMapping)
mimeMapping
- to add
org.ops4j.lang.NullArgumentException
- if mime mapping, extension or mime type is nullpublic void addConstraintMapping(WebAppConstraintMapping constraintMapping)
securityConstraint
-
org.ops4j.lang.NullArgumentException
- if security constraint is nullpublic WebAppConstraintMapping[] getConstraintMappings()
public void addSecurityRole(WebAppSecurityRole securityRole)
securityRole
- public WebAppSecurityRole[] getSecurityRoles()
public void addLoginConfig(WebAppLoginConfig loginConfig)
loginConfig
- public WebAppLoginConfig[] getLoginConfigs()
public WebAppMimeMapping[] getMimeMappings()
public org.osgi.service.http.HttpContext getHttpContext()
public void setHttpContext(org.osgi.service.http.HttpContext httpContext)
httpContext
- value to setpublic void accept(WebAppVisitor visitor)
visitor
- visitorpublic java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |