Interface IServletWrapper
- All Superinterfaces:
RequestProcessor
- All Known Implementing Classes:
GenericServletWrapper
Generic RequestProcessor representation of a compiled servlet. Any entity which
ends up begin a Servlet will be wrapper by a wrapper of this type. This wrapper
may be added as targets into the ServletContext, and the webcontainer will
dispatch requests intended for this resource in an optimized way.
NOTE: Components wishing to provide their own servlet wrappers are strongly
urged to extend the GenericServletWrapper class, which has convenience methods
to help with better integration with the webcontainer
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a ServletReferenceListener to this wrappervoid
destroy()
Signals that this wrapper should now be destroyed.long
Returns the time when this wrapper was last accessedReturns the servlet config associated with this servlet wrapperjavax.servlet.ServletContext
Returns the servlet context associated with this servlet wrapper.Returns the servlet name of the servlet wrapped by this servlet wrapperjavax.servlet.Servlet
Gets the target Servlet that this wrapper is wrappingReturns the ClassLoader instance that was used to load, or will be used to load the Servlet wrapped by this servlet wrappervoid
handleRequest
(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) This method will be called by the webcontainer when a request is intended for this wrapper.void
initialize
(IServletConfig config) Initializes this wrapper with the specified config.boolean
Returns whether the requested wrapper resource exists.void
load()
Loads the servlet and calls the Servlet's init method with the previously passed IServletConfig.void
Initializes this wrapper with the specified config.void
modifyTarget
(javax.servlet.Servlet s) void
Signals that this wrapper is going to be recycledvoid
service
(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) void
setParent
(IServletContext parent) Sets the parent context for this servletwrappervoid
setTarget
(javax.servlet.Servlet target) Sets the target Servlet that this wrapper should wrapvoid
setTargetClassLoader
(ClassLoader loader) Instructs the webcontainer to use the specified ClassLoader to load the Servlet wrapped by this servlet wrapper.Methods inherited from interface com.ibm.wsspi.webcontainer.RequestProcessor
getName, isInternal
-
Method Details
-
getServletConfig
IServletConfig getServletConfig()Returns the servlet config associated with this servlet wrapper- Returns:
-
getServletContext
javax.servlet.ServletContext getServletContext()Returns the servlet context associated with this servlet wrapper.- Returns:
-
setParent
Sets the parent context for this servletwrapper -
getServletName
String getServletName()Returns the servlet name of the servlet wrapped by this servlet wrapper- Returns:
-
setTargetClassLoader
Instructs the webcontainer to use the specified ClassLoader to load the Servlet wrapped by this servlet wrapper.- Parameters:
loader
-
-
getTargetClassLoader
ClassLoader getTargetClassLoader()Returns the ClassLoader instance that was used to load, or will be used to load the Servlet wrapped by this servlet wrapper- Parameters:
loader
-
-
setTarget
void setTarget(javax.servlet.Servlet target) Sets the target Servlet that this wrapper should wrap- Parameters:
target
-
-
getTarget
javax.servlet.Servlet getTarget()Gets the target Servlet that this wrapper is wrapping- Returns:
-
initialize
Initializes this wrapper with the specified config. Depending on the startup weight specified in the config, the underlying target Servlet will either be initialized within this call. NOTE: This initialization behaviour of the target Servlet can be controlled by calling the setStartUpWeight() method on the IServletConfig- Parameters:
config
-- Throws:
Exception
- See Also:
-
loadOnStartupCheck
Initializes this wrapper with the specified config. Depending on the startup weight specified in the config, the underlying target Servlet will either be initialized within this call. NOTE: This initialization behaviour of the target Servlet can be controlled by calling the setStartUpWeight() method on the IServletConfig- Parameters:
config
-- Throws:
Exception
- See Also:
-
handleRequest
void handleRequest(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) throws Exception This method will be called by the webcontainer when a request is intended for this wrapper. Classes directly implementing this interface (without extending GenericServletWrapper) will have to handle all aspects of the request processing. NOTE: Components wishing to provide their own servlet wrappers are strongly urged to extend the GenericServletWrapper class, which has convenience methods to help with better integration with the webcontainer. Subclasses can delegate request processing to the GenericServletWrapper by invoking the super.handleRequest() method- Specified by:
handleRequest
in interfaceRequestProcessor
- Throws:
Exception
-
prepareForReload
void prepareForReload()Signals that this wrapper is going to be recycled -
addServletReferenceListener
Adds a ServletReferenceListener to this wrapper- Parameters:
wrapper
-
-
getLastAccessTime
long getLastAccessTime()Returns the time when this wrapper was last accessed- Returns:
-
destroy
void destroy()Signals that this wrapper should now be destroyed. -
service
void service(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) throws IOException, javax.servlet.ServletException - Parameters:
request
-response
-- Throws:
IOException
javax.servlet.ServletException
-
isAvailable
boolean isAvailable()Returns whether the requested wrapper resource exists. -
load
Loads the servlet and calls the Servlet's init method with the previously passed IServletConfig. One component that calls this is SIP.- Throws:
Exception
-
modifyTarget
void modifyTarget(javax.servlet.Servlet s)
-