Package pl.morgwai.base.servlet.guice.utils

Class StandaloneWebsocketContainerServletContext

java.lang.Object

pl.morgwai.base.servlet.guice.utils.StandaloneWebsocketContainerServletContext

All Implemented Interfaces:

ServletContext

public class StandaloneWebsocketContainerServletContext
extends Object
implements ServletContext

Fake ServletContext useful for storing attributes necessary to configure ServletModule and GuiceServerEndpointConfigurator in standalone websocket container apps where there is no "real" ServletContext. Most methods throw UnsupportedOperationException except the below:

• getContextPath()
• getServletContextName()
• getVirtualServerName()
• getAttribute(String)
• getAttributeNames()
• setAttribute(String, Object)
• removeAttribute(String)
• getInitParameter(String)
• getInitParameterNames()
• setInitParameter(String, String)

Field Summary

Fields inherited from interface jakarta.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors

Constructor	Description
StandaloneWebsocketContainerServletContext(String contextPath)	Calls this(contextPath, "app at " + contextPath, null).
StandaloneWebsocketContainerServletContext(String contextPath, String servletContextName)	Calls this(contextPath, servletContextName, null).
StandaloneWebsocketContainerServletContext(String contextPath, String servletContextName, String virtualServerName)	Initializes values to be returned by the corresponding methods.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StandaloneWebsocketContainerServletContext

public StandaloneWebsocketContainerServletContext(String contextPath)

Calls this(contextPath, "app at " + contextPath, null).

StandaloneWebsocketContainerServletContext

public StandaloneWebsocketContainerServletContext(String contextPath,
                                                  String servletContextName)

Calls this(contextPath, servletContextName, null).

StandaloneWebsocketContainerServletContext

public StandaloneWebsocketContainerServletContext(String contextPath,
                                                  String servletContextName,
                                                  String virtualServerName)

Initializes values to be returned by the corresponding methods.

Parameters:

contextPath - value returned by getContextPath().

servletContextName - value returned by getServletContextName().

virtualServerName - value returned by getVirtualServerName().

Method Detail

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface ServletContext

getServletContextName

public String getServletContextName()

Specified by:

getServletContextName in interface ServletContext

getVirtualServerName

public String getVirtualServerName()

Specified by:

getVirtualServerName in interface ServletContext

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface ServletContext

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface ServletContext

setAttribute

public void setAttribute(String name,
                         Object object)

Specified by:

setAttribute in interface ServletContext

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface ServletContext

getInitParameter

public String getInitParameter(String name)

Specified by:

getInitParameter in interface ServletContext

getInitParameterNames

public Enumeration<String> getInitParameterNames()

Specified by:

getInitParameterNames in interface ServletContext

setInitParameter

public boolean setInitParameter(String name,
                                String value)

Specified by:

setInitParameter in interface ServletContext

getContext

public ServletContext getContext(String path)

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 String getMimeType(String file)

Specified by:

getMimeType in interface ServletContext

getResourcePaths

public Set<String> getResourcePaths(String path)

Specified by:

getResourcePaths in interface ServletContext

getResource

public URL getResource(String path)

Specified by:

getResource in interface ServletContext

getResourceAsStream

public InputStream getResourceAsStream(String path)

Specified by:

getResourceAsStream in interface ServletContext

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface ServletContext

getNamedDispatcher

public RequestDispatcher getNamedDispatcher(String name)

Specified by:

getNamedDispatcher in interface ServletContext

getServlet

public Servlet getServlet(String name)

Specified by:

getServlet in interface ServletContext

getServlets

public Enumeration<Servlet> getServlets()

Specified by:

getServlets in interface ServletContext

getServletNames

public Enumeration<String> getServletNames()

Specified by:

getServletNames in interface ServletContext

log

public void log(String msg)

Specified by:

log in interface ServletContext

log

public void log(Exception exception,
                String msg)

Specified by:

log in interface ServletContext

log

public void log(String message,
                Throwable throwable)

Specified by:

log in interface ServletContext

getRealPath

public String getRealPath(String path)

Specified by:

getRealPath in interface ServletContext

getServerInfo

public String getServerInfo()

Specified by:

getServerInfo in interface ServletContext

addServlet

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

Specified by:

addServlet in interface ServletContext

addServlet

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

Specified by:

addServlet in interface ServletContext

addServlet

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

Specified by:

addServlet in interface ServletContext

addJspFile

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

Specified by:

addJspFile in interface ServletContext

createServlet

public <T extends Servlet> T createServlet(Class<T> clazz)

Specified by:

createServlet in interface ServletContext

getServletRegistration

public ServletRegistration getServletRegistration(String servletName)

Specified by:

getServletRegistration in interface ServletContext

getServletRegistrations

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

Specified by:

getServletRegistrations in interface ServletContext

addFilter

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

Specified by:

addFilter in interface ServletContext

addFilter

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

Specified by:

addFilter in interface ServletContext

addFilter

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

Specified by:

addFilter in interface ServletContext

createFilter

public <T extends Filter> T createFilter(Class<T> clazz)

Specified by:

createFilter in interface ServletContext

getFilterRegistration

public FilterRegistration getFilterRegistration(String filterName)

Specified by:

getFilterRegistration in interface ServletContext

getFilterRegistrations

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

Specified by:

getFilterRegistrations in interface ServletContext

getSessionCookieConfig

public SessionCookieConfig getSessionCookieConfig()

Specified by:

getSessionCookieConfig in interface ServletContext

setSessionTrackingModes

public void setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)

Specified by:

setSessionTrackingModes in interface ServletContext

getDefaultSessionTrackingModes

public Set<SessionTrackingMode> getDefaultSessionTrackingModes()

Specified by:

getDefaultSessionTrackingModes in interface ServletContext

getEffectiveSessionTrackingModes

public Set<SessionTrackingMode> getEffectiveSessionTrackingModes()

Specified by:

getEffectiveSessionTrackingModes in interface ServletContext

addListener

public void addListener(String className)

Specified by:

addListener in interface ServletContext

addListener

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

Specified by:

addListener in interface ServletContext

addListener

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

Specified by:

addListener in interface ServletContext

createListener

public <T extends EventListener> T createListener(Class<T> clazz)

Specified by:

createListener in interface ServletContext

getJspConfigDescriptor

public JspConfigDescriptor getJspConfigDescriptor()

Specified by:

getJspConfigDescriptor in interface ServletContext

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface ServletContext

declareRoles

public void declareRoles(String... roleNames)

Specified by:

declareRoles 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 String getRequestCharacterEncoding()

Specified by:

getRequestCharacterEncoding in interface ServletContext

setRequestCharacterEncoding

public void setRequestCharacterEncoding(String encoding)

Specified by:

setRequestCharacterEncoding in interface ServletContext

getResponseCharacterEncoding

public String getResponseCharacterEncoding()

Specified by:

getResponseCharacterEncoding in interface ServletContext

setResponseCharacterEncoding

public void setResponseCharacterEncoding(String encoding)

Specified by:

setResponseCharacterEncoding in interface ServletContext