public class ServletHolder extends Holder<javax.servlet.Servlet> implements UserIdentity.Scope, Comparable
| Modifier and Type | Class and Description |
|---|---|
protected class |
ServletHolder.Config |
class |
ServletHolder.Registration |
Holder.HolderConfig, Holder.HolderRegistration, Holder.SourceAbstractLifeCycle.AbstractLifeCycleListenerLifeCycle.Listener| Modifier and Type | Field and Description |
|---|---|
static Map<String,String> |
NO_MAPPED_ROLES |
_asyncSupported, _class, _className, _displayName, _extInstance, _initParams, _name, _servletHandler_listeners, FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING| Constructor and Description |
|---|
ServletHolder()
Constructor .
|
ServletHolder(Class<? extends javax.servlet.Servlet> servlet)
Constructor for servlet class.
|
ServletHolder(Holder.Source creator)
Constructor .
|
ServletHolder(javax.servlet.Servlet servlet)
Constructor for existing servlet.
|
ServletHolder(String name,
Class<? extends javax.servlet.Servlet> servlet)
Constructor for servlet class.
|
ServletHolder(String name,
javax.servlet.Servlet servlet)
Constructor for servlet class.
|
| Modifier and Type | Method and Description |
|---|---|
void |
checkServletType()
Check to ensure class of servlet is acceptable.
|
int |
compareTo(Object o)
Comparitor by init order.
|
void |
destroyInstance(Object o) |
void |
doStart() |
void |
doStop() |
boolean |
equals(Object o) |
String |
getContextPath() |
String |
getForcedPath() |
int |
getInitOrder() |
javax.servlet.ServletRegistration.Dynamic |
getRegistration() |
Map<String,String> |
getRoleMap() |
Map<String,String> |
getRoleRefMap() |
String |
getRunAsRole() |
javax.servlet.Servlet |
getServlet()
Get the servlet.
|
javax.servlet.Servlet |
getServletInstance()
Get the servlet instance (no initialization done).
|
javax.servlet.UnavailableException |
getUnavailableException() |
String |
getUserRoleLink(String name)
get a user role link.
|
void |
handle(Request baseRequest,
javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response)
Service a request with this servlet.
|
int |
hashCode() |
protected void |
initJspServlet() |
protected void |
initMultiPart()
Register a ServletRequestListener that will ensure tmp multipart
files are deleted when the request goes out of scope.
|
boolean |
isAvailable() |
boolean |
isEnabled() |
boolean |
isSetInitOrder() |
protected javax.servlet.Servlet |
newInstance() |
void |
setEnabled(boolean enabled) |
void |
setForcedPath(String forcedPath) |
void |
setInitOrder(int order)
Set the initialize order.
|
void |
setRunAsRole(String role) |
void |
setServlet(javax.servlet.Servlet servlet) |
void |
setUserRoleLink(String name,
String link)
Link a user role.
|
dump, dump, getClassName, getDisplayName, getHeldClass, getInitParameter, getInitParameterNames, getInitParameters, getName, getServletHandler, getSource, illegalStateIfContextStarted, isAsyncSupported, isInstance, setAsyncSupported, setClassName, setDisplayName, setHeldClass, setInitParameter, setInitParameters, setName, setServletHandler, toStringaddLifeCycleListener, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stopclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetNamepublic ServletHolder()
public ServletHolder(Holder.Source creator)
public ServletHolder(javax.servlet.Servlet servlet)
public ServletHolder(String name, Class<? extends javax.servlet.Servlet> servlet)
public ServletHolder(String name, javax.servlet.Servlet servlet)
public ServletHolder(Class<? extends javax.servlet.Servlet> servlet)
public javax.servlet.UnavailableException getUnavailableException()
public void setServlet(javax.servlet.Servlet servlet)
public int getInitOrder()
public void setInitOrder(int order)
public boolean isSetInitOrder()
public int compareTo(Object o)
compareTo in interface Comparablepublic 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 rolepublic 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
public void doStop()
throws Exception
public void destroyInstance(Object o) throws Exception
destroyInstance in class Holder<javax.servlet.Servlet>Exceptionpublic javax.servlet.Servlet getServlet()
throws javax.servlet.ServletException
javax.servlet.ServletExceptionpublic javax.servlet.Servlet getServletInstance()
public void checkServletType()
throws javax.servlet.UnavailableException
javax.servlet.UnavailableExceptionpublic boolean isAvailable()
protected void initMultiPart()
throws Exception
Exceptionpublic String getContextPath()
getContextPath in interface UserIdentity.ScopeUserIdentity.Scope.getContextPath()public Map<String,String> getRoleRefMap()
getRoleRefMap in interface UserIdentity.ScopeUserIdentity.Scope.getRoleRefMap()public String getRunAsRole()
public void setRunAsRole(String role)
public void handle(Request baseRequest, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) throws javax.servlet.ServletException, javax.servlet.UnavailableException, IOException
javax.servlet.ServletExceptionjavax.servlet.UnavailableExceptionIOExceptionpublic javax.servlet.ServletRegistration.Dynamic getRegistration()
protected javax.servlet.Servlet newInstance()
throws javax.servlet.ServletException,
IllegalAccessException,
InstantiationException
javax.servlet.ServletExceptionIllegalAccessExceptionInstantiationExceptionCopyright © 1995-2015 Mort Bay Consulting. All Rights Reserved.