org.eclipse.jetty.servlet.listener

Class ContainerInitializer.ServletContainerInitializerServletContextListener

java.lang.Object

org.eclipse.jetty.servlet.listener.ContainerInitializer.ServletContainerInitializerServletContextListener

All Implemented Interfaces:

java.util.EventListener, ServletContextListener

Enclosing class:

ContainerInitializer

public static class ContainerInitializer.ServletContainerInitializerServletContextListener
extends java.lang.Object
implements ServletContextListener

Constructor Summary

Constructors

Constructor and Description
ServletContainerInitializerServletContextListener(ServletContainerInitializer sci)

Method Summary

Modifier and Type	Method and Description
ContainerInitializer.ServletContainerInitializerServletContextListener	addClasses(java.lang.Class<?>... classes) Add classes to be passed to the ServletContainerInitializer.onStartup(Set, ServletContext) call.
ContainerInitializer.ServletContainerInitializerServletContextListener	addClasses(java.lang.String... classNames) Add classes to be passed to the ServletContainerInitializer.onStartup(Set, ServletContext) call.
ContainerInitializer.ServletContainerInitializerServletContextListener	afterStartup(java.util.function.Consumer<ServletContext> consumer) Add a optional consumer to execute once the ServletContainerInitializer.onStartup(Set, ServletContext) has been called successfully.
void	contextDestroyed(ServletContextEvent sce) Notification that the servlet context is about to be shut down.
void	contextInitialized(ServletContextEvent sce) Notification that the web application initialization process is starting.
java.util.Set<java.lang.Class<?>>	getClasses()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletContainerInitializerServletContextListener

public ServletContainerInitializerServletContextListener(ServletContainerInitializer sci)

Method Detail

addClasses

public ContainerInitializer.ServletContainerInitializerServletContextListener addClasses(java.lang.String... classNames)

Add classes to be passed to the ServletContainerInitializer.onStartup(Set, ServletContext) call.

Note that these classes will be loaded using the context classloader for the ServletContext initialization phase.

Parameters:

classNames - the class names to load and pass into the ServletContainerInitializer.onStartup(Set, ServletContext) call

Returns:

this configured ContainerInitializer.ServletContainerInitializerServletContextListener instance.

addClasses

public ContainerInitializer.ServletContainerInitializerServletContextListener addClasses(java.lang.Class<?>... classes)

Add classes to be passed to the ServletContainerInitializer.onStartup(Set, ServletContext) call.

Note that these classes will exist on the classloader that was used to call this method. If you want the classes to be loaded using the context classloader for the ServletContext then use the String form of the classes via the addClasses(String...) method.

Parameters:

classes - the classes to pass into the ServletContainerInitializer.onStartup(Set, ServletContext) call

Returns:

this configured ContainerInitializer.ServletContainerInitializerServletContextListener instance.

afterStartup

public ContainerInitializer.ServletContainerInitializerServletContextListener afterStartup(java.util.function.Consumer<ServletContext> consumer)

Add a optional consumer to execute once the ServletContainerInitializer.onStartup(Set, ServletContext) has been called successfully.

This would be for actions to perform on a ServletContext once this specific SCI has completed its execution. Actions that would require specific configurations that the SCI provides to be present on the ServletContext to function properly.

This consumer is typically used for Embedded Jetty users to configure Jetty for their specific needs.

Parameters:

consumer - the consumer to execute after the SCI has executed

Returns:

this configured ContainerInitializer.ServletContainerInitializerServletContextListener instance.

contextInitialized

public void contextInitialized(ServletContextEvent sce)

Description copied from interface: ServletContextListener

Notification that the web application initialization process is starting. All ServletContextListeners are notified of context initialization before any filter or servlet in the web application is initialized.

Specified by:

contextInitialized in interface ServletContextListener

getClasses

public java.util.Set<java.lang.Class<?>> getClasses()

contextDestroyed

public void contextDestroyed(ServletContextEvent sce)

Description copied from interface: ServletContextListener

Notification that the servlet context is about to be shut down. All servlets and filters have been destroy()ed before any ServletContextListeners are notified of context destruction.

Specified by:

contextDestroyed in interface ServletContextListener