Package org.eclipse.jetty.servlet

Class ServletHolder

  • All Implemented Interfaces:
    java.lang.Comparable<ServletHolder>, UserIdentity.Scope, Dumpable, LifeCycle
    @ManagedObject("Servlet Holder")
@Deprecated(since="2021-05-27")
public class ServletHolder
extends Holder<Servlet>
implements UserIdentity.Scope, java.lang.Comparable<ServletHolder>
    Deprecated.
    The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
    Servlet Instance and Context Holder.

    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.

    • Field Detail

      • APACHE_SENTINEL_CLASS

        public static final java.lang.String APACHE_SENTINEL_CLASS
        Deprecated.
        See Also:
        Constant Field Values

      • JSP_GENERATED_PACKAGE_NAME

        public static final java.lang.String JSP_GENERATED_PACKAGE_NAME
        Deprecated.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ServletHolder

        public ServletHolder()
        Deprecated.
        Constructor .

      • ServletHolder

        public ServletHolder​(Source creator)
        Deprecated.
        Constructor .
        Parameters:
        creator - the holder source

      • ServletHolder

        public ServletHolder​(Servlet servlet)
        Deprecated.
        Constructor for existing servlet.
        Parameters:
        servlet - the servlet

      • ServletHolder

        public ServletHolder​(java.lang.String name,
                     java.lang.Class<? extends Servlet> servlet)
        Deprecated.
        Constructor for servlet class.
        Parameters:
        name - the name of the servlet
        servlet - the servlet class

      • ServletHolder

        public ServletHolder​(java.lang.String name,
                     Servlet servlet)
        Deprecated.
        Constructor for servlet class.
        Parameters:
        name - the servlet name
        servlet - the servlet

      • ServletHolder

        public ServletHolder​(java.lang.Class<? extends Servlet> servlet)
        Deprecated.
        Constructor for servlet class.
        Parameters:
        servlet - the servlet class

    • Method Detail

      • getUnavailableException

        public UnavailableException getUnavailableException()
        Deprecated.
        Returns:
        The unavailable exception or null if not unavailable

      • setServlet

        public void setServlet​(Servlet servlet)
        Deprecated.

      • setInitOrder

        public void setInitOrder​(int order)
        Deprecated.
        Set the initialize order.

        Holders with order<0, are initialized on use. Those with order>=0 are initialized in increasing order when the handler is started.

        Parameters:
        order - the servlet init order

      • compareTo

        public int compareTo​(ServletHolder sh)
        Deprecated.
        Comparator by init order.
        Specified by:
        compareTo in interface java.lang.Comparable<ServletHolder>

      • equals

        public boolean equals​(java.lang.Object o)
        Deprecated.
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Deprecated.
        Overrides:
        hashCode in class java.lang.Object

      • setUserRoleLink

        public void setUserRoleLink​(java.lang.String name,
                            java.lang.String link)
        Deprecated.
        Link a user role. Translate the role name used by a servlet, to the link name used by the container.
        Parameters:
        name - The role name as used by the servlet
        link - The role name as used by the container.

      • getUserRoleLink

        public java.lang.String getUserRoleLink​(java.lang.String name)
        Deprecated.
        get a user role link.
        Parameters:
        name - The name of the role
        Returns:
        The name as translated by the link. If no link exists, the name is returned.

      • getForcedPath

        @ManagedAttribute(value="forced servlet path",
                  readonly=true)
public java.lang.String getForcedPath()
        Deprecated.
        Returns:
        Returns the forcedPath.

      • setForcedPath

        public void setForcedPath​(java.lang.String forcedPath)
        Deprecated.
        Parameters:
        forcedPath - The forcedPath to set.

      • isEnabled

        public boolean isEnabled()
        Deprecated.

      • setEnabled

        public void setEnabled​(boolean enabled)
        Deprecated.

      • doStart

        public void doStart()
             throws java.lang.Exception
        Deprecated.
        Overrides:
        doStart in class BaseHolder<Servlet>
        Throws:
        java.lang.Exception

      • initialize

        public void initialize()
                throws java.lang.Exception
        Deprecated.
        Description copied from class: BaseHolder
        Do any setup necessary after starting
        Overrides:
        initialize in class BaseHolder<Servlet>
        Throws:
        java.lang.Exception - if unable to initialize

      • doStop

        public void doStop()
            throws java.lang.Exception
        Deprecated.
        Overrides:
        doStop in class BaseHolder<Servlet>
        Throws:
        java.lang.Exception

      • getServletInstance

        public Servlet getServletInstance()
        Deprecated.
        Get the servlet instance (no initialization done).
        Returns:
        The servlet or null

      • isAvailable

        public boolean isAvailable()
        Deprecated.
        Returns:
        true if the holder is started and is not unavailable

      • getRoleRefMap

        public java.util.Map<java.lang.String,​java.lang.String> getRoleRefMap()
        Deprecated.
        Specified by:
        getRoleRefMap in interface UserIdentity.Scope
        Returns:
        A map of role reference names that converts from names used by application code to names used by the context deployment.
        See Also:
        UserIdentity.Scope.getRoleRefMap()

      • setRunAsRole

        public void setRunAsRole​(java.lang.String role)
        Deprecated.

      • getNameOfJspClass

        public java.lang.String getNameOfJspClass​(java.lang.String jsp)
        Deprecated.
        Parameters:
        jsp - the jsp-file
        Returns:
        the simple classname of the jsp

      • getPackageOfJspClass

        public java.lang.String getPackageOfJspClass​(java.lang.String jsp)
        Deprecated.

      • getJspPackagePrefix

        public java.lang.String getJspPackagePrefix()
        Deprecated.
        Returns:
        the package for all jsps

      • getClassNameForJsp

        public java.lang.String getClassNameForJsp​(java.lang.String jsp)
        Deprecated.
        Parameters:
        jsp - the jsp-file from web.xml
        Returns:
        the fully qualified classname

      • dump

        public void dump​(java.lang.Appendable out,
                 java.lang.String indent)
          throws java.io.IOException
        Deprecated.
        Description copied from interface: Dumpable
        Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.
        Specified by:
        dump in interface Dumpable
        Overrides:
        dump in class BaseHolder<Servlet>
        Parameters:
        out - The appendable to dump to
        indent - The indent to apply after any new lines.
        Throws:
        java.io.IOException - if unable to write to Appendable

      • toString

        public java.lang.String toString()
        Deprecated.
        Overrides:
        toString in class Holder<Servlet>