Package org.eclipse.jetty.servlet

Class ServletContextHandler.Context

java.lang.Object

org.eclipse.jetty.util.AttributesMap

org.eclipse.jetty.server.handler.ContextHandler.StaticContext

org.eclipse.jetty.server.handler.ContextHandler.Context

org.eclipse.jetty.servlet.ServletContextHandler.Context

All Implemented Interfaces:

ServletContext, Attributes, Dumpable

Enclosing class:

ServletContextHandler

@Deprecated(since="2021-05-27")
public class ServletContextHandler.Context
extends ContextHandler.Context

Deprecated.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Attributes

Attributes.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Field Summary

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Fields inherited from interface javax.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors

Constructor	Description
Context()	Deprecated.

Method Summary

Modifier and Type	Method	Description
FilterRegistration.Dynamic	addFilter(String filterName, Class<? extends Filter> filterClass)	Deprecated. Add filter to context.
FilterRegistration.Dynamic	addFilter(String filterName, String className)	Deprecated. Add filter to context.
FilterRegistration.Dynamic	addFilter(String filterName, Filter filter)	Deprecated. Add filter to context.
void	addListener(Class<? extends EventListener> listenerClass)	Deprecated. TODO SERVLET3 - Add comments
void	addListener(String className)	Deprecated. TODO SERVLET3 - Add comments
<T extends EventListener> void	addListener(T t)	Deprecated. TODO SERVLET3 - Add comments
ServletRegistration.Dynamic	addServlet(String servletName, Class<? extends Servlet> servletClass)	Deprecated. Add servlet to context.
ServletRegistration.Dynamic	addServlet(String servletName, String className)	Deprecated. Register a servlet implementation for use in this ServletContext.
ServletRegistration.Dynamic	addServlet(String servletName, Servlet servlet)	Deprecated. Register a servlet instance for use in this ServletContext.
void	declareRoles(String... roleNames)	Deprecated. Add to the declared roles for this ServletContext.
<T extends Filter> void	destroyFilter(T f)	Deprecated.
<T extends Servlet> void	destroyServlet(T s)	Deprecated.
Set<SessionTrackingMode>	getDefaultSessionTrackingModes()	Deprecated. Obtains the default session tracking modes for this web application.
Set<SessionTrackingMode>	getEffectiveSessionTrackingModes()	Deprecated. Obtains the currently enabled session tracking modes for this web application.
FilterRegistration	getFilterRegistration(String filterName)	Deprecated. TODO SERVLET3 - Add comments
Map<String,? extends FilterRegistration>	getFilterRegistrations()	Deprecated.
JspConfigDescriptor	getJspConfigDescriptor()	Deprecated.
RequestDispatcher	getNamedDispatcher(String name)	Deprecated. Returns a RequestDispatcher object that acts as a wrapper for the named servlet.
ServletRegistration	getServletRegistration(String servletName)	Deprecated. Obtain the details of the named servlet.
Map<String,? extends ServletRegistration>	getServletRegistrations()	Deprecated. TODO SERVLET3 - Add comments
SessionCookieConfig	getSessionCookieConfig()	Deprecated.
boolean	setInitParameter(String name, String value)	Deprecated. Set the given initialisation parameter to the given value.
void	setJspConfigDescriptor(JspConfigDescriptor d)	Deprecated.
void	setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)	Deprecated. Configures the available session tracking modes for this web application.

Methods inherited from class org.eclipse.jetty.server.handler.ContextHandler.Context

checkListener, getAttribute, getAttributeNames, getClassLoader, getContext, getContextHandler, getContextPath, getInitParameter, getInitParameterNames, getMimeType, getRealPath, getRequestDispatcher, getResource, getResourceAsStream, getResourcePaths, getServletContextName, getVirtualServerName, isEnabled, isExtendedListenerTypes, log, log, log, removeAttribute, setAttribute, setEnabled, setExtendedListenerTypes, toString

Methods inherited from class org.eclipse.jetty.server.handler.ContextHandler.StaticContext

createFilter, createListener, createServlet, getEffectiveMajorVersion, getEffectiveMinorVersion, getMajorVersion, getMinorVersion, getServerInfo, getServlet, getServletNames, getServlets, setEffectiveMajorVersion, setEffectiveMinorVersion

Methods inherited from class org.eclipse.jetty.util.AttributesMap

addAll, clearAttributes, dump, dump, getAttributeEntrySet, getAttributeNamesCopy, getAttributeNameSet, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Constructor Details

Context

public Context()

Deprecated.

Method Details

getNamedDispatcher

public RequestDispatcher getNamedDispatcher(String name)

Deprecated.

Description copied from interface: ServletContext

Returns a RequestDispatcher object that acts as a wrapper for the named servlet.

Servlets (and JSP pages also) may be given names via server administration or via a web application deployment descriptor. A servlet instance can determine its name using ServletConfig.getServletName().

This method returns null if the ServletContext cannot return a RequestDispatcher for any reason.

Specified by:

getNamedDispatcher in interface ServletContext

Overrides:

getNamedDispatcher in class ContextHandler.StaticContext

Parameters:

name - a String specifying the name of a servlet to wrap

Returns:

a RequestDispatcher object that acts as a wrapper for the named servlet, or null if the ServletContext cannot return a RequestDispatcher

See Also:

• RequestDispatcher
• ServletContext.getContext(java.lang.String)
• ServletConfig.getServletName()

addFilter

public FilterRegistration.Dynamic addFilter(String filterName,
 Class<? extends Filter> filterClass)

Deprecated.

Description copied from interface: ServletContext

Add filter to context.

Specified by:

addFilter in interface ServletContext

Overrides:

addFilter in class ContextHandler.StaticContext

Parameters:

filterName - Name of filter to add

filterClass - Class of filter to add

Returns:

null if the filter has already been fully defined, else a FilterRegistration.Dynamic object that can be used to further configure the filter

Since:

servlet-api-3.0

addFilter

public FilterRegistration.Dynamic addFilter(String filterName,
 String className)

Deprecated.

Description copied from interface: ServletContext

Add filter to context.

Specified by:

addFilter in interface ServletContext

Overrides:

addFilter in class ContextHandler.StaticContext

Parameters:

filterName - Name of filter to add

className - Name of filter class

Returns:

null if the filter has already been fully defined, else a FilterRegistration.Dynamic object that can be used to further configure the filter

Since:

servlet-api-3.0

addFilter

public FilterRegistration.Dynamic addFilter(String filterName,
 Filter filter)

Deprecated.

Description copied from interface: ServletContext

Add filter to context.

Specified by:

addFilter in interface ServletContext

Overrides:

addFilter in class ContextHandler.StaticContext

Parameters:

filterName - Name of filter to add

filter - Filter to add

Returns:

null if the filter has already been fully defined, else a FilterRegistration.Dynamic object that can be used to further configure the filter

Since:

servlet-api-3.0

addServlet

public ServletRegistration.Dynamic addServlet(String servletName,
 Class<? extends Servlet> servletClass)

Deprecated.

Description copied from interface: ServletContext

Add servlet to context.

Specified by:

addServlet in interface ServletContext

Overrides:

addServlet in class ContextHandler.StaticContext

Parameters:

servletName - Name of servlet to add

servletClass - Class of servlet to add

Returns:

null if the servlet has already been fully defined, else a ServletRegistration.Dynamic object that can be used to further configure the servlet

Since:

servlet-api-3.0

addServlet

public ServletRegistration.Dynamic addServlet(String servletName,
 String className)

Deprecated.

Description copied from interface: ServletContext

Register a servlet implementation for use in this ServletContext.

Specified by:

addServlet in interface ServletContext

Overrides:

addServlet in class ContextHandler.StaticContext

Parameters:

servletName - The name of the servlet to register

className - The implementation class for the servlet

Returns:

The registration object that enables further configuration

Since:

servlet-api-3.0

addServlet

public ServletRegistration.Dynamic addServlet(String servletName,
 Servlet servlet)

Deprecated.

Description copied from interface: ServletContext

Register a servlet instance for use in this ServletContext.

Specified by:

addServlet in interface ServletContext

Overrides:

addServlet in class ContextHandler.StaticContext

Parameters:

servletName - The name of the servlet to register

servlet - The Servlet instance to register

Returns:

The registration object that enables further configuration

Since:

servlet-api-3.0

setInitParameter

public boolean setInitParameter(String name,
 String value)

Deprecated.

Description copied from interface: ServletContext

Set the given initialisation parameter to the given value.

Specified by:

setInitParameter in interface ServletContext

Overrides:

setInitParameter in class ContextHandler.Context

Parameters:

name - Name of initialisation parameter

value - Value for initialisation parameter

Returns:

true if the call succeeds or false if the call fails because an initialisation parameter with the same name has already been set

destroyFilter

public <T extends Filter> void destroyFilter(T f)

Deprecated.

destroyServlet

public <T extends Servlet> void destroyServlet(T s)

Deprecated.

getDefaultSessionTrackingModes

public Set<SessionTrackingMode> getDefaultSessionTrackingModes()

Deprecated.

Description copied from interface: ServletContext

Obtains the default session tracking modes for this web application. By default SessionTrackingMode.URL is always supported, SessionTrackingMode.COOKIE is supported unless the cookies attribute has been set to false for the context and SessionTrackingMode.SSL is supported if at least one of the connectors used by this context has the attribute secure set to true.

Specified by:

getDefaultSessionTrackingModes in interface ServletContext

Overrides:

getDefaultSessionTrackingModes in class ContextHandler.StaticContext

Returns:

The set of default session tracking modes for this web application

getEffectiveSessionTrackingModes

public Set<SessionTrackingMode> getEffectiveSessionTrackingModes()

Deprecated.

Description copied from interface: ServletContext

Obtains the currently enabled session tracking modes for this web application.

Specified by:

getEffectiveSessionTrackingModes in interface ServletContext

Overrides:

getEffectiveSessionTrackingModes in class ContextHandler.StaticContext

Returns:

The value supplied via ServletContext.setSessionTrackingModes(Set) if one was previously set, else return the defaults

getFilterRegistration

public FilterRegistration getFilterRegistration(String filterName)

Deprecated.

Description copied from interface: ServletContext

TODO SERVLET3 - Add comments

Specified by:

getFilterRegistration in interface ServletContext

Overrides:

getFilterRegistration in class ContextHandler.StaticContext

Parameters:

filterName - TODO

Returns:

TODO

getFilterRegistrations

public Map<String,? extends FilterRegistration> getFilterRegistrations()

Deprecated.

Specified by:

getFilterRegistrations in interface ServletContext

Overrides:

getFilterRegistrations in class ContextHandler.StaticContext

Returns:

TODO

getServletRegistration

public ServletRegistration getServletRegistration(String servletName)

Deprecated.

Description copied from interface: ServletContext

Obtain the details of the named servlet.

Specified by:

getServletRegistration in interface ServletContext

Overrides:

getServletRegistration in class ContextHandler.StaticContext

Parameters:

servletName - The name of the Servlet of interest

Returns:

The registration details for the named Servlet or null if no Servlet has been registered with the given name

getServletRegistrations

public Map<String,? extends ServletRegistration> getServletRegistrations()

Deprecated.

Description copied from interface: ServletContext

TODO SERVLET3 - Add comments

Specified by:

getServletRegistrations in interface ServletContext

Overrides:

getServletRegistrations in class ContextHandler.StaticContext

Returns:

TODO

getSessionCookieConfig

public SessionCookieConfig getSessionCookieConfig()

Deprecated.

Specified by:

getSessionCookieConfig in interface ServletContext

Overrides:

getSessionCookieConfig in class ContextHandler.StaticContext

Returns:

TODO

setSessionTrackingModes

public void setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)

Deprecated.

Description copied from interface: ServletContext

Configures the available session tracking modes for this web application.

Specified by:

setSessionTrackingModes in interface ServletContext

Overrides:

setSessionTrackingModes in class ContextHandler.StaticContext

Parameters:

sessionTrackingModes - The session tracking modes to use for this web application

addListener

public void addListener(String className)

Deprecated.

Description copied from interface: ServletContext

TODO SERVLET3 - Add comments

Specified by:

addListener in interface ServletContext

Overrides:

addListener in class ContextHandler.Context

Parameters:

className - TODO

addListener

public <T extends EventListener> void addListener(T t)

Deprecated.

Description copied from interface: ServletContext

TODO SERVLET3 - Add comments

Specified by:

addListener in interface ServletContext

Overrides:

addListener in class ContextHandler.Context

Type Parameters:

T - TODO

Parameters:

t - TODO

addListener

public void addListener(Class<? extends EventListener> listenerClass)

Deprecated.

Description copied from interface: ServletContext

TODO SERVLET3 - Add comments

Specified by:

addListener in interface ServletContext

Overrides:

addListener in class ContextHandler.Context

Parameters:

listenerClass - TODO

getJspConfigDescriptor

public JspConfigDescriptor getJspConfigDescriptor()

Deprecated.

Specified by:

getJspConfigDescriptor in interface ServletContext

Overrides:

getJspConfigDescriptor in class ContextHandler.Context

Returns:

TODO

setJspConfigDescriptor

public void setJspConfigDescriptor(JspConfigDescriptor d)

Deprecated.

Overrides:

setJspConfigDescriptor in class ContextHandler.Context

declareRoles

public void declareRoles(String... roleNames)

Deprecated.

Description copied from interface: ServletContext

Add to the declared roles for this ServletContext.

Specified by:

declareRoles in interface ServletContext

Overrides:

declareRoles in class ContextHandler.Context

Parameters:

roleNames - The roles to add