Class SokletServletContext

java.lang.Object

com.soklet.servlet.jakarta.SokletServletContext

All Implemented Interfaces:

ServletContext

@ThreadSafe
public final class SokletServletContext
extends Object
implements ServletContext

Soklet integration implementation of ServletContext.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SokletServletContext.Builder	Builder used to construct instances of SokletServletContext.

Field Summary

Fields inherited from interface ServletContext

ORDERED_LIBS, TEMPDIR

Method Summary

Modifier and Type	Method	Description
@Nullable FilterRegistration.Dynamic	addFilter(@Nullable String filterName, @Nullable Filter filter)
@Nullable FilterRegistration.Dynamic	addFilter(@Nullable String filterName, @Nullable Class<? extends Filter> filterClass)
@Nullable FilterRegistration.Dynamic	addFilter(@Nullable String filterName, @Nullable String className)
@Nullable ServletRegistration.Dynamic	addJspFile(@Nullable String servletName, @Nullable String jspFile)
<T extends EventListener> void	addListener(@Nullable T t)
void	addListener(@Nullable Class<? extends EventListener> listenerClass)
void	addListener(@Nullable String className)
@Nullable ServletRegistration.Dynamic	addServlet(@Nullable String servletName, @Nullable Servlet servlet)
@Nullable ServletRegistration.Dynamic	addServlet(@Nullable String servletName, @Nullable Class<? extends Servlet> servletClass)
@Nullable ServletRegistration.Dynamic	addServlet(@Nullable String servletName, @Nullable String className)
static @NonNull SokletServletContext.Builder	builder()
<T extends Filter> @Nullable T	createFilter(@Nullable Class<T> clazz)
<T extends EventListener> @Nullable T	createListener(@Nullable Class<T> clazz)
<T extends Servlet> @Nullable T	createServlet(@Nullable Class<T> clazz)
void	declareRoles(@Nullable String @Nullable ... strings)
static SokletServletContext	fromDefaults()
@Nullable Object	getAttribute(@Nullable String name)
@NonNull Enumeration<@NonNull String>	getAttributeNames()
@NonNull ClassLoader	getClassLoader()
@Nullable ServletContext	getContext(@Nullable String uripath)
@Nullable String	getContextPath()
@NonNull Set<@NonNull SessionTrackingMode>	getDefaultSessionTrackingModes()
int	getEffectiveMajorVersion()
int	getEffectiveMinorVersion()
@NonNull Set<@NonNull SessionTrackingMode>	getEffectiveSessionTrackingModes()
@Nullable FilterRegistration	getFilterRegistration(@Nullable String filterName)
@NonNull Map<@NonNull String, ? extends @NonNull FilterRegistration>	getFilterRegistrations()
@Nullable String	getInitParameter(String name)
@NonNull Enumeration<@NonNull String>	getInitParameterNames()
@Nullable JspConfigDescriptor	getJspConfigDescriptor()
int	getMajorVersion()
@Nullable String	getMimeType(@Nullable String file)
int	getMinorVersion()
@Nullable RequestDispatcher	getNamedDispatcher(@Nullable String name)
@Nullable String	getRealPath(@Nullable String path)
@Nullable String	getRequestCharacterEncoding()
@Nullable RequestDispatcher	getRequestDispatcher(@Nullable String path)
@Nullable URL	getResource(@Nullable String path)
@Nullable InputStream	getResourceAsStream(@Nullable String path)
@Nullable Set<@NonNull String>	getResourcePaths(@Nullable String path)
@Nullable String	getResponseCharacterEncoding()
@NonNull String	getServerInfo()
@Nullable String	getServletContextName()
@Nullable ServletRegistration	getServletRegistration(@Nullable String servletName)
@NonNull Map<@NonNull String, ? extends @NonNull ServletRegistration>	getServletRegistrations()
@Nullable SessionCookieConfig	getSessionCookieConfig()
int	getSessionTimeout()
@NonNull String	getVirtualServerName()
void	log(@Nullable String msg)
void	log(@Nullable String message, @Nullable Throwable throwable)
void	removeAttribute(@Nullable String name)
void	setAttribute(@Nullable String name, @Nullable Object object)
boolean	setInitParameter(@Nullable String name, @Nullable String value)
void	setRequestCharacterEncoding(@Nullable String encoding)
void	setResponseCharacterEncoding(@Nullable String encoding)
void	setSessionTimeout(int sessionTimeout)
void	setSessionTrackingModes(@Nullable Set<@NonNull SessionTrackingMode> sessionTrackingModes)

Methods inherited from class Object

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

Methods inherited from interface ServletContext

setRequestCharacterEncoding, setResponseCharacterEncoding

Method Details

fromDefaults

public static SokletServletContext fromDefaults()

builder

public static @NonNull SokletServletContext.Builder builder()

getContextPath

public @Nullable String getContextPath()

Specified by:

getContextPath in interface ServletContext

getContext

public @Nullable ServletContext getContext(@Nullable String uripath)

Specified by:

getContext in interface ServletContext

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface ServletContext

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface ServletContext

getEffectiveMajorVersion

public int getEffectiveMajorVersion()

Specified by:

getEffectiveMajorVersion in interface ServletContext

getEffectiveMinorVersion

public int getEffectiveMinorVersion()

Specified by:

getEffectiveMinorVersion in interface ServletContext

getMimeType

public @Nullable String getMimeType(@Nullable String file)

Specified by:

getMimeType in interface ServletContext

getResourcePaths

public @Nullable Set<@NonNull String> getResourcePaths(@Nullable String path)

Specified by:

getResourcePaths in interface ServletContext

getResource

public @Nullable URL getResource(@Nullable String path)
                          throws MalformedURLException

Specified by:

getResource in interface ServletContext

Throws:

MalformedURLException

getResourceAsStream

public @Nullable InputStream getResourceAsStream(@Nullable String path)

Specified by:

getResourceAsStream in interface ServletContext

getRequestDispatcher

public @Nullable RequestDispatcher getRequestDispatcher(@Nullable String path)

Specified by:

getRequestDispatcher in interface ServletContext

getNamedDispatcher

public @Nullable RequestDispatcher getNamedDispatcher(@Nullable String name)

Specified by:

getNamedDispatcher in interface ServletContext

log

public void log(@Nullable String msg)

Specified by:

log in interface ServletContext

log

public void log(@Nullable String message,
 @Nullable Throwable throwable)

Specified by:

log in interface ServletContext

getRealPath

public @Nullable String getRealPath(@Nullable String path)

Specified by:

getRealPath in interface ServletContext

getServerInfo

public @NonNull String getServerInfo()

Specified by:

getServerInfo in interface ServletContext

getInitParameter

public @Nullable String getInitParameter(String name)

Specified by:

getInitParameter in interface ServletContext

getInitParameterNames

public @NonNull Enumeration<@NonNull String> getInitParameterNames()

Specified by:

getInitParameterNames in interface ServletContext

setInitParameter

public boolean setInitParameter(@Nullable String name,
 @Nullable String value)

Specified by:

setInitParameter in interface ServletContext

getAttribute

public @Nullable Object getAttribute(@Nullable String name)

Specified by:

getAttribute in interface ServletContext

getAttributeNames

public @NonNull Enumeration<@NonNull String> getAttributeNames()

Specified by:

getAttributeNames in interface ServletContext

setAttribute

public void setAttribute(@Nullable String name,
 @Nullable Object object)

Specified by:

setAttribute in interface ServletContext

removeAttribute

public void removeAttribute(@Nullable String name)

Specified by:

removeAttribute in interface ServletContext

getServletContextName

public @Nullable String getServletContextName()

Specified by:

getServletContextName in interface ServletContext

addServlet

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

Specified by:

addServlet in interface ServletContext

addServlet

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

Specified by:

addServlet in interface ServletContext

addServlet

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

Specified by:

addServlet in interface ServletContext

addJspFile

public @Nullable ServletRegistration.Dynamic addJspFile(@Nullable String servletName,
 @Nullable String jspFile)

Specified by:

addJspFile in interface ServletContext

createServlet

public <T extends Servlet> @Nullable T createServlet(@Nullable Class<T> clazz)
                                              throws ServletException

Specified by:

createServlet in interface ServletContext

Throws:

ServletException

getServletRegistration

public @Nullable ServletRegistration getServletRegistration(@Nullable String servletName)

Specified by:

getServletRegistration in interface ServletContext

getServletRegistrations

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

Specified by:

getServletRegistrations in interface ServletContext

addFilter

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

Specified by:

addFilter in interface ServletContext

addFilter

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

Specified by:

addFilter in interface ServletContext

addFilter

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

Specified by:

addFilter in interface ServletContext

createFilter

public <T extends Filter> @Nullable T createFilter(@Nullable Class<T> clazz)
                                            throws ServletException

Specified by:

createFilter in interface ServletContext

Throws:

ServletException

getFilterRegistration

public @Nullable FilterRegistration getFilterRegistration(@Nullable String filterName)

Specified by:

getFilterRegistration in interface ServletContext

getFilterRegistrations

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

Specified by:

getFilterRegistrations in interface ServletContext

getSessionCookieConfig

public @Nullable SessionCookieConfig getSessionCookieConfig()

Specified by:

getSessionCookieConfig in interface ServletContext

setSessionTrackingModes

public void setSessionTrackingModes(@Nullable Set<@NonNull SessionTrackingMode> sessionTrackingModes)

Specified by:

setSessionTrackingModes in interface ServletContext

getDefaultSessionTrackingModes

public @NonNull Set<@NonNull SessionTrackingMode> getDefaultSessionTrackingModes()

Specified by:

getDefaultSessionTrackingModes in interface ServletContext

getEffectiveSessionTrackingModes

public @NonNull Set<@NonNull SessionTrackingMode> getEffectiveSessionTrackingModes()

Specified by:

getEffectiveSessionTrackingModes in interface ServletContext

addListener

public void addListener(@Nullable String className)

Specified by:

addListener in interface ServletContext

addListener

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

Specified by:

addListener in interface ServletContext

addListener

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

Specified by:

addListener in interface ServletContext

createListener

public <T extends EventListener> @Nullable T createListener(@Nullable Class<T> clazz)
                                                     throws ServletException

Specified by:

createListener in interface ServletContext

Throws:

ServletException

getJspConfigDescriptor

public @Nullable JspConfigDescriptor getJspConfigDescriptor()

Specified by:

getJspConfigDescriptor in interface ServletContext

getClassLoader

public @NonNull ClassLoader getClassLoader()

Specified by:

getClassLoader in interface ServletContext

declareRoles

public void declareRoles(@Nullable String @Nullable ... strings)

Specified by:

declareRoles in interface ServletContext

getVirtualServerName

public @NonNull String getVirtualServerName()

Specified by:

getVirtualServerName in interface ServletContext

getSessionTimeout

public int getSessionTimeout()

Specified by:

getSessionTimeout in interface ServletContext

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

Specified by:

setSessionTimeout in interface ServletContext

getRequestCharacterEncoding

public @Nullable String getRequestCharacterEncoding()

Specified by:

getRequestCharacterEncoding in interface ServletContext

setRequestCharacterEncoding

public void setRequestCharacterEncoding(@Nullable String encoding)

Specified by:

setRequestCharacterEncoding in interface ServletContext

getResponseCharacterEncoding

public @Nullable String getResponseCharacterEncoding()

Specified by:

getResponseCharacterEncoding in interface ServletContext

setResponseCharacterEncoding

public void setResponseCharacterEncoding(@Nullable String encoding)

Specified by:

setResponseCharacterEncoding in interface ServletContext