@ManagedObject(value="Servlet Holder") public class ServletHolder extends Holder<Servlet> implements UserIdentity.Scope, Comparable<ServletHolder>
Holds the name, params and some state of a javax.servlet.Servlet instance. It implements the ServletConfig interface. This class will organise the loading of the servlet when needed or requested.
Modifier and Type | Class and Description |
---|---|
static class |
ServletHolder.JspContainer |
class |
ServletHolder.Registration |
AbstractLifeCycle.AbstractLifeCycleListener
LifeCycle.Listener
Modifier and Type | Field and Description |
---|---|
static String |
APACHE_SENTINEL_CLASS |
static String |
JSP_GENERATED_PACKAGE_NAME |
Constructor and Description |
---|
ServletHolder()
Constructor .
|
ServletHolder(Class<? extends Servlet> servlet)
Constructor for servlet class.
|
ServletHolder(Servlet servlet)
Constructor for existing servlet.
|
ServletHolder(Source creator)
Constructor .
|
ServletHolder(String name,
Class<? extends Servlet> servlet)
Constructor for servlet class.
|
ServletHolder(String name,
Servlet servlet)
Constructor for servlet class.
|
Modifier and Type | Method and Description |
---|---|
void |
checkServletType()
Check to ensure class of servlet is acceptable.
|
int |
compareTo(ServletHolder sh)
Comparator by init order.
|
void |
destroyInstance(Object o) |
void |
doStart() |
void |
doStop() |
void |
dump(Appendable out,
String indent)
Dump this object (and children) into an Appendable using the provided indent after any new lines.
|
Servlet |
ensureInstance()
Deprecated.
|
boolean |
equals(Object o) |
String |
getClassNameForJsp(String jsp) |
ContextHandler |
getContextHandler() |
String |
getContextPath() |
String |
getForcedPath() |
int |
getInitOrder() |
String |
getJspPackagePrefix() |
String |
getNameOfJspClass(String jsp) |
String |
getPackageOfJspClass(String jsp) |
ServletRegistration.Dynamic |
getRegistration() |
Map<String,String> |
getRoleRefMap() |
String |
getRunAsRole() |
Servlet |
getServlet()
Get the servlet.
|
Servlet |
getServletInstance()
Get the servlet instance (no initialization done).
|
UnavailableException |
getUnavailableException() |
String |
getUserRoleLink(String name)
get a user role link.
|
void |
handle(Request baseRequest,
ServletRequest request,
ServletResponse response)
Service a request with this servlet.
|
int |
hashCode() |
void |
initialize()
Do any setup necessary after starting
|
boolean |
isAvailable() |
boolean |
isEnabled() |
void |
setEnabled(boolean enabled) |
void |
setForcedPath(String forcedPath) |
void |
setInitOrder(int order)
Set the initialize order.
|
void |
setRunAsRole(String role) |
void |
setServlet(Servlet servlet) |
void |
setUserRoleLink(String name,
String link)
Link a user role.
|
String |
toString() |
dump, getDisplayName, getInitParameter, getInitParameterNames, getInitParameters, getName, isAsyncSupported, setAsyncSupported, setClassName, setDisplayName, setHeldClass, setInitParameter, setInitParameters, setName
getClassName, getHeldClass, getServletHandler, getSource, isInstance, setServletHandler
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop
getName
dump, dumpContainer, dumpIterable, dumpMapEntries, dumpObject, dumpObjects, dumpSelf, named
public static final String APACHE_SENTINEL_CLASS
public static final String JSP_GENERATED_PACKAGE_NAME
public ServletHolder()
public ServletHolder(Source creator)
creator
- the holder sourcepublic ServletHolder(Servlet servlet)
servlet
- the servletpublic ServletHolder(String name, Class<? extends Servlet> servlet)
name
- the name of the servletservlet
- the servlet classpublic ServletHolder(String name, Servlet servlet)
name
- the servlet nameservlet
- the servletpublic UnavailableException getUnavailableException()
public void setServlet(Servlet servlet)
@ManagedAttribute(value="initialization order", readonly=true) public int getInitOrder()
public void setInitOrder(int order)
Holders with order<0, are initialized on use. Those with order>=0 are initialized in increasing order when the handler is started.
order
- the servlet init orderpublic int compareTo(ServletHolder sh)
compareTo
in interface Comparable<ServletHolder>
public void setUserRoleLink(String name, String link)
name
- The role name as used by the servletlink
- The role name as used by the container.public String getUserRoleLink(String name)
name
- The name of the role@ManagedAttribute(value="forced servlet path", readonly=true) public String getForcedPath()
public void setForcedPath(String forcedPath)
forcedPath
- The forcedPath to set.public boolean isEnabled()
public void setEnabled(boolean enabled)
public void doStart() throws Exception
doStart
in class BaseHolder<Servlet>
Exception
public void initialize() throws Exception
BaseHolder
initialize
in class BaseHolder<Servlet>
Exception
- if unable to initializepublic void doStop() throws Exception
doStop
in class BaseHolder<Servlet>
Exception
public void destroyInstance(Object o) throws Exception
destroyInstance
in class Holder<Servlet>
Exception
public Servlet getServlet() throws ServletException
ServletException
- if unable to init the servlet on first usepublic Servlet getServletInstance()
public void checkServletType() throws UnavailableException
UnavailableException
- if Servlet class is not of type Servlet
public boolean isAvailable()
public ContextHandler getContextHandler()
getContextHandler
in interface UserIdentity.Scope
public String getContextPath()
getContextPath
in interface UserIdentity.Scope
UserIdentity.Scope.getContextPath()
public Map<String,String> getRoleRefMap()
getRoleRefMap
in interface UserIdentity.Scope
UserIdentity.Scope.getRoleRefMap()
@ManagedAttribute(value="role to run servlet as", readonly=true) public String getRunAsRole()
public void setRunAsRole(String role)
@Deprecated public Servlet ensureInstance() throws ServletException
ServletException
public void handle(Request baseRequest, ServletRequest request, ServletResponse response) throws ServletException, UnavailableException, IOException
baseRequest
- the base requestrequest
- the requestresponse
- the responseServletException
- if unable to process the servletUnavailableException
- if servlet is unavailableIOException
- if unable to process the request or responsepublic String getNameOfJspClass(String jsp)
jsp
- the jsp-filepublic String getJspPackagePrefix()
public String getClassNameForJsp(String jsp)
jsp
- the jsp-file from web.xmlpublic ServletRegistration.Dynamic getRegistration()
public void dump(Appendable out, String indent) throws IOException
Dumpable
dump
in interface Dumpable
dump
in class BaseHolder<Servlet>
out
- The appendable to dump toindent
- The indent to apply after any new lines.IOException
- if unable to write to AppendableCopyright © 2010 - 2020 Adobe. All Rights Reserved