io.bootique.jetty

Class JettyModuleExtender

java.lang.Object

io.bootique.ModuleExtender<JettyModuleExtender>

io.bootique.jetty.JettyModuleExtender

public class JettyModuleExtender
extends io.bootique.ModuleExtender<JettyModuleExtender>

Provides API to contribute custom extensions to JettyModule. This class is a syntactic sugar for Guice MapBinder and Multibinder.

Since:

0.20

Field Summary

Fields inherited from class io.bootique.ModuleExtender

binder

Constructor Summary

Constructors

Constructor and Description
JettyModuleExtender(com.google.inject.Binder binder)

Method Summary

Modifier and Type	Method and Description
JettyModuleExtender	addFilter(Class<? extends javax.servlet.Filter> filterType) Adds a filter of the specified type to the set of Jetty filters.
JettyModuleExtender	addFilter(javax.servlet.Filter filter, String name, int order, String... urlPatterns)
JettyModuleExtender	addListener(Class<? extends EventListener> listenerType)
JettyModuleExtender	addListener(EventListener listener)
<T extends javax.servlet.Filter> JettyModuleExtender	addMappedFilter(com.google.inject.Key<MappedFilter<T>> mappedFilterKey)
<T extends javax.servlet.Filter> JettyModuleExtender	addMappedFilter(MappedFilter<T> mappedFilter)
<T extends javax.servlet.Filter> JettyModuleExtender	addMappedFilter(com.google.inject.TypeLiteral<MappedFilter<T>> mappedFilterType)
<T extends javax.servlet.Servlet> JettyModuleExtender	addMappedServlet(com.google.inject.Key<MappedServlet<T>> mappedServletKey)
<T extends javax.servlet.Servlet> JettyModuleExtender	addMappedServlet(MappedServlet<T> mappedServlet)
<T extends javax.servlet.Servlet> JettyModuleExtender	addMappedServlet(com.google.inject.TypeLiteral<MappedServlet<T>> mappedServletType)
JettyModuleExtender	addServlet(Class<? extends javax.servlet.Servlet> servletType) Adds a servlet of the specified type to the set of Jetty servlets.
JettyModuleExtender	addServlet(javax.servlet.Servlet servlet, String name, String... urlPatterns)
JettyModuleExtender	addStaticServlet(String name, String... urlPatterns)
protected com.google.inject.multibindings.Multibinder<javax.servlet.Filter>	contributeFilters()
protected com.google.inject.multibindings.Multibinder<EventListener>	contributeListeners()
protected com.google.inject.multibindings.Multibinder<MappedFilter>	contributeMappedFilters()
protected com.google.inject.multibindings.Multibinder<MappedServlet>	contributeMappedServlets()
protected com.google.inject.multibindings.Multibinder<javax.servlet.Servlet>	contributeServlets()
JettyModuleExtender	initAllExtensions() Should be called by owning Module to initialize all contribution maps and collections.
JettyModuleExtender	useDefaultServlet()

Methods inherited from class io.bootique.ModuleExtender

newMap, newMap, newSet, newSet, newSet

Methods inherited from class java.lang.Object

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

Constructor Detail

JettyModuleExtender

public JettyModuleExtender(com.google.inject.Binder binder)

Method Detail

initAllExtensions

public JettyModuleExtender initAllExtensions()

Should be called by owning Module to initialize all contribution maps and collections. Failure to call this method may result in injection failures for empty maps and collections.

Specified by:

initAllExtensions in class io.bootique.ModuleExtender<JettyModuleExtender>

Returns:

this extender instance.

addListener

public JettyModuleExtender addListener(EventListener listener)

addListener

public JettyModuleExtender addListener(Class<? extends EventListener> listenerType)

addStaticServlet

public JettyModuleExtender addStaticServlet(String name,
                                            String... urlPatterns)

useDefaultServlet

public JettyModuleExtender useDefaultServlet()

addServlet

public JettyModuleExtender addServlet(Class<? extends javax.servlet.Servlet> servletType)

Adds a servlet of the specified type to the set of Jetty servlets. "servletType" must be annotated with WebServlet. Otherwise it should be mapped via other add(Mapped)Servlet methods, where you can explicitly specify URL patterns.

Parameters:

servletType - a class of the servlet to map.

Returns:

this extender instance.

addServlet

public JettyModuleExtender addServlet(javax.servlet.Servlet servlet,
                                      String name,
                                      String... urlPatterns)

addMappedServlet

public <T extends javax.servlet.Servlet> JettyModuleExtender addMappedServlet(MappedServlet<T> mappedServlet)

addMappedServlet

public <T extends javax.servlet.Servlet> JettyModuleExtender addMappedServlet(com.google.inject.Key<MappedServlet<T>> mappedServletKey)

addMappedServlet

public <T extends javax.servlet.Servlet> JettyModuleExtender addMappedServlet(com.google.inject.TypeLiteral<MappedServlet<T>> mappedServletType)

addFilter

public JettyModuleExtender addFilter(Class<? extends javax.servlet.Filter> filterType)

Adds a filter of the specified type to the set of Jetty filters. "filterType" must be annotated with WebFilter. Otherwise it should be mapped via other add(Mapped)Filter methods, where you can explicitly specify URL patterns, ordering, etc.

Parameters:

filterType - a class of the filter to map.

Returns:

this extender instance.

addFilter

public JettyModuleExtender addFilter(javax.servlet.Filter filter,
                                     String name,
                                     int order,
                                     String... urlPatterns)

addMappedFilter

public <T extends javax.servlet.Filter> JettyModuleExtender addMappedFilter(MappedFilter<T> mappedFilter)

addMappedFilter

public <T extends javax.servlet.Filter> JettyModuleExtender addMappedFilter(com.google.inject.Key<MappedFilter<T>> mappedFilterKey)

addMappedFilter

public <T extends javax.servlet.Filter> JettyModuleExtender addMappedFilter(com.google.inject.TypeLiteral<MappedFilter<T>> mappedFilterType)

contributeFilters

protected com.google.inject.multibindings.Multibinder<javax.servlet.Filter> contributeFilters()

contributeServlets

protected com.google.inject.multibindings.Multibinder<javax.servlet.Servlet> contributeServlets()

contributeMappedFilters

protected com.google.inject.multibindings.Multibinder<MappedFilter> contributeMappedFilters()

contributeMappedServlets

protected com.google.inject.multibindings.Multibinder<MappedServlet> contributeMappedServlets()

contributeListeners

protected com.google.inject.multibindings.Multibinder<EventListener> contributeListeners()