Top Description Inners Fields Constructors Methods
org.eclipse.jetty.ee10.servlet

public Class ServletHolder

extends Holder<Servlet>
implements Comparable<ServletHolder>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Annotations
@ManagedObject:Servlet Holder
Imports
java.io.File, .IOException, java.lang.reflect.InvocationTargetException, .Method, java.util.ArrayList, .Arrays, .Collection, .Collections, .HashMap, .HashSet, .List, .Map, .Objects, .Set, .Stack, java.util.concurrent.atomic.AtomicLong, jakarta.servlet.GenericServlet, .MultipartConfigElement, .Servlet, .ServletConfig, .ServletContext, .ServletException, .ServletRegistration, .ServletRequest, .ServletResponse, .ServletSecurityElement, .UnavailableException, jakarta.servlet.http.HttpServletResponse, org.eclipse.jetty.security.AuthenticationState, .IdentityService, .UserIdentity, org.eclipse.jetty.server.handler.ContextHandler, org.eclipse.jetty.util.Loader, .NanoTime, .StringUtil, org.eclipse.jetty.util.annotation.ManagedAttribute, .ManagedObject, org.eclipse.jetty.util.component.Dumpable, .DumpableCollection, org.eclipse.jetty.util.thread.AutoLock, org.slf4j.Logger, .LoggerFactory
Servlet Instance and Context Holder.

Holds the name, params and some state of a jakarta.servlet.Servlet instance. It implements the ServletConfig interface. This class will organise the loading of the servlet when needed or requested.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected class
ServletHolder.Config

public static enum
ServletHolder.JspContainer

private static class
ServletHolder.NotAsync

public class
ServletHolder.Registration

private static class
ServletHolder.RunAs

private class
ServletHolder.SingleThreadedWrapper

private class
ServletHolder.UnavailableServlet

public static interface
ServletHolder.WrapFunction

Experimental Wrapper mechanism for Servlet objects.

public static class
ServletHolder.Wrapper

Field Summary

Modifier and TypeField and Description
private ServletHolder.Config
_config

private boolean
_enabled

private String
_forcedPath

private boolean
_initOnStartup

private int
_initOrder

private ServletHolder.JspContainer
_jspContainer

private ServletHolder.Registration
_registration

private Map<String, String>
_roleMap

private String
_runAsRole

private volatile Servlet
_servlet

public static final String
APACHE_SENTINEL_CLASS

public static final String
JSP_GENERATED_PACKAGE_NAME

private static final Logger
LOG

Hides org.eclipse.jetty.ee10.servlet.Holder.LOG.

Constructor Summary

AccessConstructor and Description
public
ServletHolder()

Constructor .

public
ServletHolder(Source
the holder source
creator)

Constructor .

public
ServletHolder(Servlet
the servlet
servlet)

Constructor for existing servlet.

public
ServletHolder(String
the name of the servlet
name, Class<? extends Servlet>
the servlet class
servlet)

Constructor for servlet class.

public
ServletHolder(String
the servlet name
name, Servlet
the servlet
servlet)

Constructor for servlet class.

public
ServletHolder(Class<? extends Servlet>
the servlet class
servlet)

Constructor for servlet class.

Method Summary

Modifier and TypeMethod and Description
protected void
appendPath(StringBuffer
the path under construction
path, String
the element of the name to add
element)

Concatenate an element on to fully qualified classname.

private void
checkInitOnStartup()

Check if there is a jakarta.servlet.annotation.ServletSecurity annotation on the servlet class.

public void
checkServletType()

Check to ensure class of servlet is acceptable.

public int
compareTo(ServletHolder
the object to be compared.
sh)

Implements java.lang.Comparable.compareTo.

Comparator by init order.
protected Servlet
createInstance()

Overrides org.eclipse.jetty.ee10.servlet.BaseHolder.createInstance.

public void
destroyInstance(Object o)

Overrides org.eclipse.jetty.ee10.servlet.Holder.destroyInstance.

private void
detectJspContainer()

public void
doStart()

Overrides org.eclipse.jetty.ee10.servlet.BaseHolder.doStart.

Method to override to start the lifecycle
public void
doStop()

Overrides org.eclipse.jetty.ee10.servlet.BaseHolder.doStop.

Method to override to stop the lifecycle
public void
dump(Appendable
The appendable to dump to
out, String
The indent to apply after any new lines.
indent)

Overrides org.eclipse.jetty.ee10.servlet.BaseHolder.dump.

Implements org.eclipse.jetty.util.component.Dumpable.dump.

Dump this object (and children) into an Appendable using the provided indent after any new lines.
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String

Returns:

the fully qualified classname
getClassNameForJsp(String
the jsp-file from web.xml
jsp)

public String

Returns:

Returns the forcedPath.
getForcedPath()

public int
getInitOrder()

public String

Returns:

the package for all jsps
getJspPackagePrefix()

Get the package for all jsps.

public MultipartConfigElement
getMultipartConfigElement()

public String

Returns:

the simple classname of the jsp
getNameOfJspClass(String
the jsp-file
jsp)

public String
getPackageOfJspClass(String jsp)

public ServletHolder.Registration
getRegistration()

public String
getRunAsRole()

public Servlet

Returns:

The servlet
getServlet()

Get the servlet.

public Servlet

Returns:

The servlet or null
getServletInstance()

Get the servlet instance (no initialization done).

public UnavailableException

Returns:

The unavailable exception or null if not unavailable
getUnavailableException()

public void
handle(ServletRequest
the request
request, ServletResponse
the response
response)

Service a request with this servlet.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
initialize()

Overrides org.eclipse.jetty.ee10.servlet.BaseHolder.initialize.

Do any setup necessary after starting
protected void
initJspServlet()

private void
initServlet()

public boolean

Returns:

true if the holder is started and is not unavailable
isAvailable()

public boolean
isEnabled()

protected boolean
isJspServlet()

protected boolean
isJspServlet(String classname)

private Servlet
makeUnavailable(UnavailableException e)

private void
makeUnavailable(final Throwable e)

protected Servlet

Returns:

the newly created Servlet instance
newInstance()

private void
predestroyServlet(Servlet servlet)

protected void
prepare(ServletRequest
the request
request, ServletResponse
the response
response)

Prepare to service a request.

private void
setClassFrom(ServletHolder holder)

public void
setEnabled(boolean enabled)

public void
setForcedPath(String
The forcedPath to set.
forcedPath)

public void
setInitOrder(int
the servlet init order
order)

Set the initialize order.

public void
setRunAsRole(String role)

public void
setServlet(Servlet servlet)

public String
toString()

Overrides org.eclipse.jetty.ee10.servlet.Holder.toString.

Returns a string representation of the object.
Inherited from org.eclipse.jetty.ee10.servlet.Holder:
dumpgetDisplayNamegetInitParametergetInitParameterNamesgetInitParametersgetNameisAsyncSupportedsetAsyncSupportedsetClassNamesetDisplayNamesetHeldClasssetInitParametersetInitParameterssetInstancesetName