public static class ServletDeploymentContext.Builder extends DeploymentContext.Builder
If properties of the builder are not modified, default values will be utilized:
ServletContainer
.null
.
After the build()
has been invoked the state of the builder will be reset to the default values.
Modifier | Constructor and Description |
---|---|
protected |
Builder()
Create new deployment context builder instance not explicitly bound to the JAX-RS / Jersey application class.
|
protected |
Builder(javax.ws.rs.core.Application app)
Create new deployment context builder instance and bind it to the JAX-RS / Jersey application instance.
|
protected |
Builder(Class<? extends javax.ws.rs.core.Application> appClass)
Create new deployment context builder instance and bind it to the JAX-RS / Jersey application class.
|
|
Builder(String name,
String value)
Create a builder with one initialization parameter.
|
Modifier and Type | Method and Description |
---|---|
ServletDeploymentContext.Builder |
addFilter(Class<? extends javax.servlet.Filter> filterClass,
String filterName)
Add a filter class.
|
ServletDeploymentContext.Builder |
addFilter(Class<? extends javax.servlet.Filter> filterClass,
String filterName,
Map<String,String> initParams)
Add a filter class.
|
ServletDeploymentContext.Builder |
addFilter(Class<? extends javax.servlet.Filter> filterClass,
String filterName,
Map<String,String> initParams,
Set<javax.servlet.DispatcherType> dispatcherTypes)
Add a filter class.
|
ServletDeploymentContext.Builder |
addFilter(Class<? extends javax.servlet.Filter> filterClass,
String filterName,
Set<javax.servlet.DispatcherType> dispatcherTypes)
Add a filter class.
|
ServletDeploymentContext.Builder |
addListener(Class<? extends EventListener> listenerClass)
Add event listener class.
|
ServletDeploymentContext |
build()
Build a new servlet deployment context configured by the current state of this
servlet deployment context builder.
|
ServletDeploymentContext.Builder |
contextParam(String name,
String value)
Add a context parameter.
|
ServletDeploymentContext.Builder |
contextParams(Map<String,String> contextParams)
Add context parameters.
|
ServletDeploymentContext.Builder |
contextPath(String contextPath)
Set the application deployment context path.
|
ServletDeploymentContext.Builder |
filterClass(Class<? extends javax.servlet.Filter> filterClass)
Set the filter class.
|
ServletDeploymentContext.Builder |
filterClass(Class<? extends javax.servlet.Filter> filterClass,
Set<javax.servlet.DispatcherType> dispatcherTypes)
Set the filter class.
|
ServletDeploymentContext.Builder |
initParam(String name,
String value)
Add an initialization parameter.
|
ServletDeploymentContext.Builder |
initParams(Map<String,String> initParams)
Add initialization parameters.
|
protected void |
reset()
Reset the application deployment context builder values to defaults.
|
ServletDeploymentContext.Builder |
servlet(javax.servlet.http.HttpServlet servlet)
Set the servlet instance.
|
ServletDeploymentContext.Builder |
servletClass(Class<? extends javax.servlet.http.HttpServlet> servletClass)
Set the servlet class.
|
ServletDeploymentContext.Builder |
servletPath(String servletPath)
Set the servlet path.
|
protected Builder()
The constructor is provided to support different subclass initialization scenarios.
public Builder(String name, String value)
name
- the parameter name.value
- the parameter value.protected Builder(javax.ws.rs.core.Application app)
app
- JAX-RS / Jersey application instance.protected Builder(Class<? extends javax.ws.rs.core.Application> appClass)
appClass
- JAX-RS / Jersey application class.public ServletDeploymentContext.Builder initParam(String name, String value)
name
- the parameter name.value
- the parameter value.public ServletDeploymentContext.Builder initParams(Map<String,String> initParams)
initParams
- a map of initialization parameters. The parameters will be copied.NullPointerException
- is the specified map is null
.public ServletDeploymentContext.Builder contextParam(String name, String value)
name
- the parameter name.value
- the parameter value.public ServletDeploymentContext.Builder contextParams(Map<String,String> contextParams)
contextParams
- a map of context parameters. The parameters will be copied.NullPointerException
- is the specified map is null
.public ServletDeploymentContext.Builder servletClass(Class<? extends javax.servlet.http.HttpServlet> servletClass)
Setting a servlet class resets the servlet instance as well as registered filters to null
.
servletClass
- the servlet class to serve the application.NullPointerException
- if servletClass
is null
.public ServletDeploymentContext.Builder servlet(javax.servlet.http.HttpServlet servlet)
Setting a servlet instance resets the servlet class as well as registered filters to null
.
servlet
- the servlet instance to serve the application.NullPointerException
- if servletClass
is null
.public ServletDeploymentContext.Builder filterClass(Class<? extends javax.servlet.Filter> filterClass)
DispatcherType.REQUEST
dispatch types only.
Setting a filter class resets the servlet class and servlet instance to null
.
filterClass
- the filter class to serve the application.NullPointerException
- if filterClass
is null
.public ServletDeploymentContext.Builder filterClass(Class<? extends javax.servlet.Filter> filterClass, Set<javax.servlet.DispatcherType> dispatcherTypes)
Setting a filter class resets the servlet class and servlet instance to null
.
filterClass
- the filter class to serve the application.dispatcherTypes
- dispatcher types for which the filter should be registered.NullPointerException
- if filterClass
or dispatcherTypes
is null
.IllegalArgumentException
- in case the dispatcherTypes
is empty.public ServletDeploymentContext.Builder addFilter(Class<? extends javax.servlet.Filter> filterClass, String filterName)
Adding a filter class DOES NOT reset the servlet or filter classes. Filter will be instantiated without initialization parameters.
filterClass
- filter class. Must not be null
.filterName
- filter name. Must not be null
or empty string.NullPointerException
- if filterClass
or filterName
is null
.IllegalArgumentException
- in case the filterName
is empty.public ServletDeploymentContext.Builder addFilter(Class<? extends javax.servlet.Filter> filterClass, String filterName, Map<String,String> initParams)
Adding a filter class DOES NOT reset the servlet or filter classes. Filter will be instantiated without initialization parameters.
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
.NullPointerException
- if filterClass
or filterName
or initParams
is null
.IllegalArgumentException
- in case the filterName
is empty.public ServletDeploymentContext.Builder addFilter(Class<? extends javax.servlet.Filter> filterClass, String filterName, Set<javax.servlet.DispatcherType> dispatcherTypes)
Adding a filter class DOES NOT reset the servlet or filter classes. Filter will be instantiated without initialization parameters.
filterClass
- filter class. Must not be null
.filterName
- filter name. Must not be null
or empty string.dispatcherTypes
- filter will be registered for these dispatcher types. Must not be null
.NullPointerException
- if filterClass
or filterName
or dispatcherTypes
is null
.IllegalArgumentException
- in case the filterName
or dispatcherTypes
is empty.public ServletDeploymentContext.Builder addFilter(Class<? extends javax.servlet.Filter> filterClass, String filterName, Map<String,String> initParams, Set<javax.servlet.DispatcherType> dispatcherTypes)
Adding a filter class DOES NOT reset the servlet or filter classes. Filter will be instantiated without initialization parameters.
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
.dispatcherTypes
- filter will be registered for these dispatcher types. Must not be null
.NullPointerException
- if filterClass
or filterName
or initParams
or dispatcherTypes
is null
.IllegalArgumentException
- in case the filterName
or dispatcherTypes
is empty.public ServletDeploymentContext.Builder contextPath(String contextPath)
DeploymentContext.Builder
contextPath
in class DeploymentContext.Builder
contextPath
- application context path.public ServletDeploymentContext.Builder servletPath(String servletPath)
servletPath
- the servlet path to the application. (See Servlet specification for definition of servletPath.)NullPointerException
- if servletPath
is null
.public ServletDeploymentContext.Builder addListener(Class<? extends EventListener> listenerClass)
The event listener should be one of the following types:
ServletContextListener
ServletContextAttributeListener
ServletRequestListener
ServletRequestAttributeListener
HttpSessionListener
HttpSessionActivationListener
HttpSessionAttributeListener
listenerClass
- the event listener class.NullPointerException
- if listenerClass
is null
.IllegalArgumentException
- if listenerClass
is neither of the supported listener types listed
above.public ServletDeploymentContext build()
build
in class DeploymentContext.Builder
protected void reset()
DeploymentContext.Builder
reset
in class DeploymentContext.Builder
Copyright © 2007-2015, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.