public static class WebAppDescriptor.Builder extends AppDescriptor.AppDescriptorBuilder<WebAppDescriptor.Builder,WebAppDescriptor>
If properties of the builder are not modified default values be utilized.
The default value for initialization and context parameters is an
empty map.
The default value for the context and servlet path is an empty string.
The default value for the servlet class is the class
ServletContainer
.
The default value for the filter class and the servlet context listener
class is null
.
After the build()
has been invoked the state of the builder
will be reset to the default values.
Modifier and Type | Field and Description |
---|---|
protected Map<String,String> |
contextParams |
protected String |
contextPath |
protected List<WebAppDescriptor.FilterDescriptor> |
filters |
protected Map<String,String> |
initParams |
protected List<Class<? extends EventListener>> |
listeners |
protected Class<? extends javax.servlet.http.HttpServlet> |
servletClass |
protected String |
servletPath |
cc
Constructor and Description |
---|
WebAppDescriptor.Builder()
Create a builder.
|
WebAppDescriptor.Builder(Map<String,String> initParams)
Create a builder with initialization parameters.
|
WebAppDescriptor.Builder(String... packages)
Create a builder with one or more package names where
root resource and provider classes reside.
|
WebAppDescriptor.Builder(String name,
String value)
Create a builder with one initialization parameter.
|
Modifier and Type | Method and Description |
---|---|
WebAppDescriptor.Builder |
addFilter(Class<? extends javax.servlet.Filter> filterClass,
String filterName)
Adds filter class.
|
WebAppDescriptor.Builder |
addFilter(Class<? extends javax.servlet.Filter> filterClass,
String filterName,
Map<String,String> initParams)
Adds filter class.
|
WebAppDescriptor |
build()
Build the Web-based application descriptor.
|
WebAppDescriptor.Builder |
contextAttributeListenerClass(Class<? extends javax.servlet.ServletContextAttributeListener> contextAttributeListenerClass)
Set a
ServletContextListener class |
WebAppDescriptor.Builder |
contextListenerClass(Class<? extends javax.servlet.ServletContextListener> contextListenerClass)
Set a
ServletContextListener class |
WebAppDescriptor.Builder |
contextParam(String name,
String value)
Add a context parameter.
|
WebAppDescriptor.Builder |
contextPath(String contextPath)
Set the context path.
|
WebAppDescriptor.Builder |
filterClass(Class<? extends javax.servlet.Filter> filterClass)
Set the filter class.
|
WebAppDescriptor.Builder |
httpSessionActivationListenerClass(Class<? extends javax.servlet.http.HttpSessionActivationListener> httpSessionActivationListenerClass)
Set a
HttpSessionActivationListener class |
WebAppDescriptor.Builder |
httpSessionAttributeListenerClass(Class<? extends javax.servlet.http.HttpSessionAttributeListener> httpSessionAttributeListenerClass)
Set a
HttpSessionAttributeListener class |
WebAppDescriptor.Builder |
httpSessionListenerClass(Class<? extends javax.servlet.http.HttpSessionListener> httpSessionListenerClass)
Set a
HttpSessionListener class |
WebAppDescriptor.Builder |
initParam(String name,
String value)
Add an initialization parameter.
|
WebAppDescriptor.Builder |
requestAttributeListenerClass(Class<? extends javax.servlet.ServletRequestAttributeListener> requestAttributeListenerClass)
Set a
ServletRequestAttributeListener class |
WebAppDescriptor.Builder |
requestListenerClass(Class<? extends javax.servlet.ServletRequestListener> requestListenerClass)
Set a
ServletRequestListener class |
protected void |
reset() |
WebAppDescriptor.Builder |
servletClass(Class<? extends javax.servlet.http.HttpServlet> servletClass)
Set the servlet class.
|
WebAppDescriptor.Builder |
servletPath(String servletPath)
Set the servlet path.
|
clientConfig
protected Class<? extends javax.servlet.http.HttpServlet> servletClass
protected List<WebAppDescriptor.FilterDescriptor> filters
protected List<Class<? extends EventListener>> listeners
protected String contextPath
protected String servletPath
public WebAppDescriptor.Builder()
public WebAppDescriptor.Builder(Map<String,String> initParams) throws IllegalArgumentException
initParams
- a map of initialization parameters. The parameters
will be copied.IllegalArgumentException
- if initParams
is null.public WebAppDescriptor.Builder(String name, String value)
name
- the parameter name.value
- the parameter value.public WebAppDescriptor.Builder(String... packages) throws IllegalArgumentException
packages
- one or more package names where
root resource and provider classes reside.IllegalArgumentException
- if packages
is null.public WebAppDescriptor.Builder initParam(String name, String value)
name
- the parameter name.value
- the parameter value.public WebAppDescriptor.Builder contextParam(String name, String value)
name
- the parameter name.value
- the parameter value.public WebAppDescriptor.Builder servletClass(Class<? extends javax.servlet.http.HttpServlet> servletClass) throws IllegalArgumentException
Setting a servlet class resets the filter class to null.
servletClass
- the servlet class to serve the application.IllegalArgumentException
- if servletClass
is null.public WebAppDescriptor.Builder filterClass(Class<? extends javax.servlet.Filter> filterClass) throws IllegalArgumentException
Setting a filter class resets the servlet class to null
filterClass
- the filter class to serve the application.IllegalArgumentException
- if filterClass
is null.public WebAppDescriptor.Builder addFilter(Class<? extends javax.servlet.Filter> filterClass, String filterName) throws IllegalArgumentException
Adding a filter class DOES NOT reset the servlet or filter classes. Filter will be instanciated without initialization parameters.
filterClass
- filter class. Must not be null.filterName
- filter name. Must not be null or empty string.IllegalArgumentException
- if filterClass
or filterName
is null.public WebAppDescriptor.Builder addFilter(Class<? extends javax.servlet.Filter> filterClass, String filterName, Map<String,String> initParams) throws IllegalArgumentException
Adding a filter class DOES NOT reset the servlet or filter classes
filterClass
- filter class. Must not be null.filterName
- filter name. Must not be null or empty string.initParams
- filter init parameters. Must not be null.IllegalArgumentException
- if filterClass
, filterName
or initParams
is null.public WebAppDescriptor.Builder contextPath(String contextPath)
contextPath
- the context path to the application. (See Servlet specification for definition of contextPath)IllegalArgumentException
- if contextPath
is null.public WebAppDescriptor.Builder servletPath(String servletPath)
servletPath
- the servlet path to the application. (See Servlet specification for definition of servletPath)IllegalArgumentException
- if servletPath
is null.public WebAppDescriptor.Builder contextListenerClass(Class<? extends javax.servlet.ServletContextListener> contextListenerClass)
ServletContextListener
classcontextListenerClass
- the servlet context listener class.IllegalArgumentException
- if contextListenerClass
is null.public WebAppDescriptor.Builder contextAttributeListenerClass(Class<? extends javax.servlet.ServletContextAttributeListener> contextAttributeListenerClass)
ServletContextListener
classcontextAttributeListenerClass
- the servlet context listener class.IllegalArgumentException
- if contextListenerClass
is null.public WebAppDescriptor.Builder requestListenerClass(Class<? extends javax.servlet.ServletRequestListener> requestListenerClass)
ServletRequestListener
classrequestListenerClass
- the servlet request listener class.IllegalArgumentException
- if requestListenerClass
is null.public WebAppDescriptor.Builder requestAttributeListenerClass(Class<? extends javax.servlet.ServletRequestAttributeListener> requestAttributeListenerClass)
ServletRequestAttributeListener
classrequestAttributeListenerClass
- the servlet request attribute listener class.IllegalArgumentException
- if requestAttributeListenerClass
is null.public WebAppDescriptor.Builder httpSessionListenerClass(Class<? extends javax.servlet.http.HttpSessionListener> httpSessionListenerClass)
HttpSessionListener
classhttpSessionListenerClass
- the HTTP Session Listener class.IllegalArgumentException
- if httpSessionListenerClass
is null.public WebAppDescriptor.Builder httpSessionActivationListenerClass(Class<? extends javax.servlet.http.HttpSessionActivationListener> httpSessionActivationListenerClass)
HttpSessionActivationListener
classhttpSessionActivationListenerClass
- the HTTP Session Activation Listener class.IllegalArgumentException
- if httpSessionActivationListenerClass
is null.public WebAppDescriptor.Builder httpSessionAttributeListenerClass(Class<? extends javax.servlet.http.HttpSessionAttributeListener> httpSessionAttributeListenerClass)
HttpSessionAttributeListener
classhttpSessionAttributeListenerClass
- the HTTPSessionAttributeListener class.IllegalArgumentException
- if httpSessionAttributeListenerClass
is null.public WebAppDescriptor build()
build
in class AppDescriptor.AppDescriptorBuilder<WebAppDescriptor.Builder,WebAppDescriptor>
protected void reset()
reset
in class AppDescriptor.AppDescriptorBuilder<WebAppDescriptor.Builder,WebAppDescriptor>
Copyright © 2013 Oracle Corporation. All rights reserved.