|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.GenericServlet
javax.servlet.http.HttpServlet
com.sun.ws.rest.spi.container.servlet.ServletContainer
public class ServletContainer
A servlet container for deploying root resource classes.
The web.xml MAY configure the servlet to have an initialization parameter
"com.sun.ws.rest.config.property.resourceConfigClass" and whose value is a
fully qualified name of a class that implements ResourceConfig
.
If the concrete class has a constructor that takes a single parameter of the
type Map then the class is instantiated with that constructor and an instance
of Map that contains all the initialization parameters is passed as the parameter.
Otherwise the default contructor is used to instantate the class.
If the initialization parameter
"com.sun.ws.rest.config.property.resourceConfigClass" is not present a new
instance of ClasspathResourceConfig
is created. The initialization
parameter "com.sun.ws.rest.config.property.classpath" MAY be set to provide
one or more paths. Each path MUST be separated by ';'. Each path MUST
be a virtual path as specified by the ServletContext.getRealPath(java.lang.String)
method,
and each path is transformed by that method. The transformed paths are
added as a property value to a Map instance using the property name
(@link ClasspathResourceConfig.PROPERTY_CLASSPATH}. Any additional
initialization parameters are then added to the Map instance. Then that Map
instance is passe to the constructor of ClasspathResourceConfig
.
If this parameter is not set then the
default value is set to the following virtual paths:
"/WEB-INF/lib;/WEB-INF/classes".
A new WebApplication
instance will be created and configured such
that the following classes may be injected onto the field of a root
resource class or a parameter of a method of root resource class that is
annotated with Resource
: @{link HttpServletRequest},
HttpServletResponse
and ServletConfig
.
Constructor Summary | |
---|---|
ServletContainer()
|
Method Summary | |
---|---|
protected void |
configure(javax.servlet.ServletConfig sc,
ResourceConfig rc,
WebApplication wa)
Configure the WebApplication . |
protected WebApplication |
create()
Create a new instance of a WebApplication . |
void |
init(javax.servlet.ServletConfig servletConfig)
|
protected void |
initiate(ResourceConfig rc,
WebApplication wa)
Initiate the WebApplication . |
void |
load()
Load the Web application. |
void |
onReload()
Called when reloading of the container is requested. |
void |
service(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp)
|
Methods inherited from class javax.servlet.http.HttpServlet |
---|
doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service |
Methods inherited from class javax.servlet.GenericServlet |
---|
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ServletContainer()
Method Detail |
---|
public final void init(javax.servlet.ServletConfig servletConfig) throws javax.servlet.ServletException
init
in interface javax.servlet.Servlet
init
in class javax.servlet.GenericServlet
javax.servlet.ServletException
public final void service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) throws javax.servlet.ServletException, java.io.IOException
service
in class javax.servlet.http.HttpServlet
javax.servlet.ServletException
java.io.IOException
public final void load()
This method may be called at runtime, more than once, to reload the
Web application. For example, if a ResourceConfig
implementation
is capable of detecting changes to resource classes (addition or removal)
or providers then this method may be invoked to reload the web
application for such changes to take effect.
If this method is called when there are pending requests then such requests will be processed using the previously loaded web application.
protected WebApplication create()
WebApplication
.
WebApplication
instance.protected void configure(javax.servlet.ServletConfig sc, ResourceConfig rc, WebApplication wa)
WebApplication
.
The WebApplication
is configured such that the following classes
may be injected onto the field of a root resource class or a parameter
of a method of root resource class that is annotated with
Resource
: @{link HttpServletRequest}, @{link HttpServletResponse}
and ServletConfig
.
An inheriting class may override this method to configure the
WebApplication
to provide alternative or additional instance
that may be injected into a root resource class, and may modify the
features and properties of the ResourceConfig
. For an inheriting
class to extend configuration behaviour the overriding method MUST call
super.configure(servletConfig, rc, wa) as the first statement of that
method.
sc
- the Servlet configurationrc
- the Resource configurationwa
- the Web applicationprotected void initiate(ResourceConfig rc, WebApplication wa)
WebApplication
.
rc
- the Resource configurationwa
- the Web applicationpublic void onReload()
ContainerListener
onReload
in interface ContainerListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |