org.eclipse.jetty.servlet
public class ServletHolder extends Holder<javax.servlet.Servlet> implements UserIdentity.Scope, java.lang.Comparable
Modifier and Type | Class and Description |
---|---|
protected class |
ServletHolder.Config |
class |
ServletHolder.Registration |
Holder.HolderConfig, Holder.HolderRegistration, Holder.Source
AbstractLifeCycle.AbstractLifeCycleListener
LifeCycle.Listener
Modifier and Type | Field and Description |
---|---|
static java.util.Map<java.lang.String,java.lang.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(java.lang.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(java.lang.String name,
java.lang.Class<? extends javax.servlet.Servlet> servlet)
Constructor for servlet class.
|
ServletHolder(java.lang.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(java.lang.Object o)
Comparitor by init order.
|
void |
destroyInstance(java.lang.Object o) |
void |
doStart() |
void |
doStop() |
boolean |
equals(java.lang.Object o) |
java.lang.String |
getContextPath() |
java.lang.String |
getForcedPath() |
int |
getInitOrder() |
javax.servlet.ServletRegistration.Dynamic |
getRegistration() |
java.util.Map<java.lang.String,java.lang.String> |
getRoleMap() |
java.util.Map<java.lang.String,java.lang.String> |
getRoleRefMap() |
java.lang.String |
getRunAsRole() |
javax.servlet.Servlet |
getServlet()
Get the servlet.
|
javax.servlet.Servlet |
getServletInstance()
Get the servlet instance (no initialization done).
|
javax.servlet.UnavailableException |
getUnavailableException() |
java.lang.String |
getUserRoleLink(java.lang.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() |
boolean |
isAvailable() |
boolean |
isEnabled() |
boolean |
isSetInitOrder() |
protected javax.servlet.Servlet |
newInstance() |
void |
setEnabled(boolean enabled) |
void |
setForcedPath(java.lang.String forcedPath) |
void |
setInitOrder(int order)
Set the initialize order.
|
void |
setRunAsRole(java.lang.String role) |
void |
setServlet(javax.servlet.Servlet servlet) |
void |
setUserRoleLink(java.lang.String name,
java.lang.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, toString
addLifeCycleListener, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getName
public static final java.util.Map<java.lang.String,java.lang.String> NO_MAPPED_ROLES
public ServletHolder()
public ServletHolder(Holder.Source creator)
public ServletHolder(javax.servlet.Servlet servlet)
public ServletHolder(java.lang.String name, java.lang.Class<? extends javax.servlet.Servlet> servlet)
public ServletHolder(java.lang.String name, javax.servlet.Servlet servlet)
public ServletHolder(java.lang.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(java.lang.Object o)
compareTo
in interface java.lang.Comparable
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public void setUserRoleLink(java.lang.String name, java.lang.String link)
name
- The role name as used by the servletlink
- The role name as used by the container.public java.lang.String getUserRoleLink(java.lang.String name)
name
- The name of the rolepublic java.util.Map<java.lang.String,java.lang.String> getRoleMap()
public java.lang.String getForcedPath()
public void setForcedPath(java.lang.String forcedPath)
forcedPath
- The forcedPath to set.public boolean isEnabled()
public void setEnabled(boolean enabled)
public void doStart() throws java.lang.Exception
public void doStop() throws java.lang.Exception
public void destroyInstance(java.lang.Object o) throws java.lang.Exception
destroyInstance
in class Holder<javax.servlet.Servlet>
java.lang.Exception
public javax.servlet.Servlet getServlet() throws javax.servlet.ServletException
javax.servlet.ServletException
public javax.servlet.Servlet getServletInstance()
public void checkServletType() throws javax.servlet.UnavailableException
javax.servlet.UnavailableException
public boolean isAvailable()
public java.lang.String getContextPath()
getContextPath
in interface UserIdentity.Scope
UserIdentity.Scope.getContextPath()
public java.util.Map<java.lang.String,java.lang.String> getRoleRefMap()
getRoleRefMap
in interface UserIdentity.Scope
UserIdentity.Scope.getRoleRefMap()
public java.lang.String getRunAsRole()
public void setRunAsRole(java.lang.String role)
public void handle(Request baseRequest, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) throws javax.servlet.ServletException, javax.servlet.UnavailableException, java.io.IOException
javax.servlet.ServletException
javax.servlet.UnavailableException
java.io.IOException
public javax.servlet.ServletRegistration.Dynamic getRegistration()
protected javax.servlet.Servlet newInstance() throws javax.servlet.ServletException, java.lang.IllegalAccessException, java.lang.InstantiationException
javax.servlet.ServletException
java.lang.IllegalAccessException
java.lang.InstantiationException
Copyright © 2016. All Rights Reserved.