Module org.eclipse.jetty.ee10.servlet

Package org.eclipse.jetty.ee10.servlet

Class ServletContextHandler.ServletContextApi

java.lang.Object

org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletContextApi

All Implemented Interfaces:

jakarta.servlet.ServletContext

Enclosing class:

ServletContextHandler

public class ServletContextHandler.ServletContextApi
extends Object
implements jakarta.servlet.ServletContext

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_enabled
protected boolean	_extendedListenerTypes
static final int	SERVLET_MAJOR_VERSION
static final int	SERVLET_MINOR_VERSION

Fields inherited from interface jakarta.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors

Constructor	Description
ServletContextApi()

Method Summary

Modifier and Type	Method	Description
jakarta.servlet.FilterRegistration.Dynamic	addFilter(String filterName, jakarta.servlet.Filter filter)
jakarta.servlet.FilterRegistration.Dynamic	addFilter(String filterName, Class<? extends jakarta.servlet.Filter> filterClass)
jakarta.servlet.FilterRegistration.Dynamic	addFilter(String filterName, String className)
jakarta.servlet.ServletRegistration.Dynamic	addJspFile(String servletName, String jspFile)
void	addListener(Class<? extends EventListener> listenerClass)
void	addListener(String className)
<T extends EventListener> void	addListener(T t)
jakarta.servlet.ServletRegistration.Dynamic	addServlet(String servletName, jakarta.servlet.Servlet servlet)
jakarta.servlet.ServletRegistration.Dynamic	addServlet(String servletName, Class<? extends jakarta.servlet.Servlet> servletClass)
jakarta.servlet.ServletRegistration.Dynamic	addServlet(String servletName, String className)
void	checkListener(Class<? extends EventListener> listener)
<T extends jakarta.servlet.Filter> T	createFilter(Class<T> clazz)
<T> T	createInstance(Class<T> clazz)
<T extends EventListener> T	createListener(Class<T> clazz)
<T extends jakarta.servlet.Servlet> T	createServlet(Class<T> clazz)
void	declareRoles(String... roleNames)
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
ClassLoader	getClassLoader()
ServletContextHandler.ServletScopedContext	getContext()
jakarta.servlet.ServletContext	getContext(String path)
org.eclipse.jetty.server.handler.ContextHandler	getContextHandler()
String	getContextPath()
Set<jakarta.servlet.SessionTrackingMode>	getDefaultSessionTrackingModes()
int	getEffectiveMajorVersion()
int	getEffectiveMinorVersion()
Set<jakarta.servlet.SessionTrackingMode>	getEffectiveSessionTrackingModes()
jakarta.servlet.FilterRegistration	getFilterRegistration(String filterName)
Map<String,? extends jakarta.servlet.FilterRegistration>	getFilterRegistrations()
String	getInitParameter(String name)
Enumeration<String>	getInitParameterNames()
jakarta.servlet.descriptor.JspConfigDescriptor	getJspConfigDescriptor()
int	getMajorVersion()
String	getMimeType(String file)
int	getMinorVersion()
jakarta.servlet.RequestDispatcher	getNamedDispatcher(String name)
String	getRealPath(String path)
String	getRequestCharacterEncoding()
jakarta.servlet.RequestDispatcher	getRequestDispatcher(String uriInContext)
URL	getResource(String path)
InputStream	getResourceAsStream(String path)
Set<String>	getResourcePaths(String path)
String	getResponseCharacterEncoding()
String	getServerInfo()
String	getServletContextName()
jakarta.servlet.ServletRegistration	getServletRegistration(String servletName)
Map<String,? extends jakarta.servlet.ServletRegistration>	getServletRegistrations()
jakarta.servlet.SessionCookieConfig	getSessionCookieConfig()
int	getSessionTimeout()
String	getVirtualServerName()
boolean	isEnabled()
boolean	isExtendedListenerTypes()
void	log(String msg)
void	log(String message, Throwable throwable)
void	removeAttribute(String name)
void	setAttribute(String name, Object value)
void	setEffectiveMajorVersion(int v)
void	setEffectiveMinorVersion(int v)
void	setEnabled(boolean enabled)
void	setExtendedListenerTypes(boolean extended)
boolean	setInitParameter(String name, String value)
void	setJspConfigDescriptor(jakarta.servlet.descriptor.JspConfigDescriptor d)
void	setRequestCharacterEncoding(String encoding)
void	setResponseCharacterEncoding(String encoding)
void	setSessionTimeout(int sessionTimeout)
void	setSessionTrackingModes(Set<jakarta.servlet.SessionTrackingMode> sessionTrackingModes)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

SERVLET_MAJOR_VERSION

public static final int SERVLET_MAJOR_VERSION

See Also:

• Constant Field Values

SERVLET_MINOR_VERSION

public static final int SERVLET_MINOR_VERSION

See Also:

• Constant Field Values

_enabled

protected boolean _enabled

_extendedListenerTypes

protected boolean _extendedListenerTypes

Constructor Details

ServletContextApi

public ServletContextApi()

Method Details

getServerInfo

public String getServerInfo()

Specified by:

getServerInfo in interface jakarta.servlet.ServletContext

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface jakarta.servlet.ServletContext

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface jakarta.servlet.ServletContext

getEffectiveMajorVersion

public int getEffectiveMajorVersion()

Specified by:

getEffectiveMajorVersion in interface jakarta.servlet.ServletContext

getEffectiveMinorVersion

public int getEffectiveMinorVersion()

Specified by:

getEffectiveMinorVersion in interface jakarta.servlet.ServletContext

setEffectiveMajorVersion

public void setEffectiveMajorVersion(int v)

setEffectiveMinorVersion

public void setEffectiveMinorVersion(int v)

getContext

public ServletContextHandler.ServletScopedContext getContext()

getNamedDispatcher

public jakarta.servlet.RequestDispatcher getNamedDispatcher(String name)

Specified by:

getNamedDispatcher in interface jakarta.servlet.ServletContext

addFilter

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

Specified by:

addFilter in interface jakarta.servlet.ServletContext

Since:

servlet-api-3.0

addFilter

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

Specified by:

addFilter in interface jakarta.servlet.ServletContext

Since:

servlet-api-3.0

addFilter

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

Specified by:

addFilter in interface jakarta.servlet.ServletContext

Since:

servlet-api-3.0

addServlet

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

Specified by:

addServlet in interface jakarta.servlet.ServletContext

Since:

servlet-api-3.0

addServlet

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

Specified by:

addServlet in interface jakarta.servlet.ServletContext

Since:

servlet-api-3.0

addServlet

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

Specified by:

addServlet in interface jakarta.servlet.ServletContext

Since:

servlet-api-3.0

addJspFile

public jakarta.servlet.ServletRegistration.Dynamic addJspFile(String servletName,
 String jspFile)

Specified by:

addJspFile in interface jakarta.servlet.ServletContext

getInitParameter

public String getInitParameter(String name)

Specified by:

getInitParameter in interface jakarta.servlet.ServletContext

setInitParameter

public boolean setInitParameter(String name,
 String value)

Specified by:

setInitParameter in interface jakarta.servlet.ServletContext

createInstance

public <T> T createInstance(Class<T> clazz)
                     throws jakarta.servlet.ServletException

Throws:

jakarta.servlet.ServletException

getDefaultSessionTrackingModes

public Set<jakarta.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()

Specified by:

getDefaultSessionTrackingModes in interface jakarta.servlet.ServletContext

getEffectiveSessionTrackingModes

public Set<jakarta.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()

Specified by:

getEffectiveSessionTrackingModes in interface jakarta.servlet.ServletContext

getFilterRegistration

public jakarta.servlet.FilterRegistration getFilterRegistration(String filterName)

Specified by:

getFilterRegistration in interface jakarta.servlet.ServletContext

getFilterRegistrations

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

Specified by:

getFilterRegistrations in interface jakarta.servlet.ServletContext

getServletRegistration

public jakarta.servlet.ServletRegistration getServletRegistration(String servletName)

Specified by:

getServletRegistration in interface jakarta.servlet.ServletContext

getServletRegistrations

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

Specified by:

getServletRegistrations in interface jakarta.servlet.ServletContext

getSessionCookieConfig

public jakarta.servlet.SessionCookieConfig getSessionCookieConfig()

Specified by:

getSessionCookieConfig in interface jakarta.servlet.ServletContext

setSessionTrackingModes

public void setSessionTrackingModes(Set<jakarta.servlet.SessionTrackingMode> sessionTrackingModes)

Specified by:

setSessionTrackingModes in interface jakarta.servlet.ServletContext

getSessionTimeout

public int getSessionTimeout()

Specified by:

getSessionTimeout in interface jakarta.servlet.ServletContext

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

Specified by:

setSessionTimeout in interface jakarta.servlet.ServletContext

createServlet

public <T extends jakarta.servlet.Servlet> T createServlet(Class<T> clazz)
                                                    throws jakarta.servlet.ServletException

Specified by:

createServlet in interface jakarta.servlet.ServletContext

Throws:

jakarta.servlet.ServletException

createFilter

public <T extends jakarta.servlet.Filter> T createFilter(Class<T> clazz)
                                                  throws jakarta.servlet.ServletException

Specified by:

createFilter in interface jakarta.servlet.ServletContext

Throws:

jakarta.servlet.ServletException

createListener

public <T extends EventListener> T createListener(Class<T> clazz)
                                           throws jakarta.servlet.ServletException

Specified by:

createListener in interface jakarta.servlet.ServletContext

Throws:

jakarta.servlet.ServletException

addListener

public void addListener(String className)

Specified by:

addListener in interface jakarta.servlet.ServletContext

addListener

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

Specified by:

addListener in interface jakarta.servlet.ServletContext

addListener

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

Specified by:

addListener in interface jakarta.servlet.ServletContext

getJspConfigDescriptor

public jakarta.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()

Specified by:

getJspConfigDescriptor in interface jakarta.servlet.ServletContext

setJspConfigDescriptor

public void setJspConfigDescriptor(jakarta.servlet.descriptor.JspConfigDescriptor d)

declareRoles

public void declareRoles(String... roleNames)

Specified by:

declareRoles in interface jakarta.servlet.ServletContext

getRequestCharacterEncoding

public String getRequestCharacterEncoding()

Specified by:

getRequestCharacterEncoding in interface jakarta.servlet.ServletContext

setRequestCharacterEncoding

public void setRequestCharacterEncoding(String encoding)

Specified by:

setRequestCharacterEncoding in interface jakarta.servlet.ServletContext

getResponseCharacterEncoding

public String getResponseCharacterEncoding()

Specified by:

getResponseCharacterEncoding in interface jakarta.servlet.ServletContext

setResponseCharacterEncoding

public void setResponseCharacterEncoding(String encoding)

Specified by:

setResponseCharacterEncoding in interface jakarta.servlet.ServletContext

getContextHandler

public org.eclipse.jetty.server.handler.ContextHandler getContextHandler()

getContext

public jakarta.servlet.ServletContext getContext(String path)

Specified by:

getContext in interface jakarta.servlet.ServletContext

getMimeType

public String getMimeType(String file)

Specified by:

getMimeType in interface jakarta.servlet.ServletContext

getRequestDispatcher

public jakarta.servlet.RequestDispatcher getRequestDispatcher(String uriInContext)

Specified by:

getRequestDispatcher in interface jakarta.servlet.ServletContext

getRealPath

public String getRealPath(String path)

Specified by:

getRealPath in interface jakarta.servlet.ServletContext

getResource

public URL getResource(String path)
                throws MalformedURLException

Specified by:

getResource in interface jakarta.servlet.ServletContext

Throws:

MalformedURLException

getResourceAsStream

public InputStream getResourceAsStream(String path)

Specified by:

getResourceAsStream in interface jakarta.servlet.ServletContext

getResourcePaths

public Set<String> getResourcePaths(String path)

Specified by:

getResourcePaths in interface jakarta.servlet.ServletContext

log

public void log(String msg)

Specified by:

log in interface jakarta.servlet.ServletContext

log

public void log(String message,
 Throwable throwable)

Specified by:

log in interface jakarta.servlet.ServletContext

getInitParameterNames

public Enumeration<String> getInitParameterNames()

Specified by:

getInitParameterNames in interface jakarta.servlet.ServletContext

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface jakarta.servlet.ServletContext

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface jakarta.servlet.ServletContext

setAttribute

public void setAttribute(String name,
 Object value)

Specified by:

setAttribute in interface jakarta.servlet.ServletContext

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface jakarta.servlet.ServletContext

getServletContextName

public String getServletContextName()

Specified by:

getServletContextName in interface jakarta.servlet.ServletContext

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface jakarta.servlet.ServletContext

toString

public String toString()

Overrides:

toString in class Object

checkListener

public void checkListener(Class<? extends EventListener> listener)
                   throws IllegalStateException

Throws:

IllegalStateException

setExtendedListenerTypes

public void setExtendedListenerTypes(boolean extended)

isExtendedListenerTypes

public boolean isExtendedListenerTypes()

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface jakarta.servlet.ServletContext

setEnabled

public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()

getVirtualServerName

public String getVirtualServerName()

Specified by:

getVirtualServerName in interface jakarta.servlet.ServletContext