Package 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 Bootique MapBuilder and SetBuilder.

Field Summary

Fields inherited from class io.bootique.ModuleExtender

binder

Constructor Summary

Constructors

Constructor	Description
JettyModuleExtender(io.bootique.di.Binder binder)

Method Summary

Modifier and Type	Method	Description
JettyModuleExtender	addContextHandlerExtender(ServletContextHandlerExtender extender)	Registers an extender of the Jetty ServletContextHandler.
JettyModuleExtender	addContextHandlerExtender(Class<? extends ServletContextHandlerExtender> type)	Registers an extender of the Jetty ServletContextHandler.
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(io.bootique.di.Key<MappedFilter<T>> mappedFilterKey)
<T extends javax.servlet.Filter> JettyModuleExtender	addMappedFilter(io.bootique.di.TypeLiteral<MappedFilter<T>> mappedFilterType)
<T extends javax.servlet.Filter> JettyModuleExtender	addMappedFilter(MappedFilter<T> mappedFilter)
<T extends EventListener> JettyModuleExtender	addMappedListener(io.bootique.di.Key<MappedListener<T>> mappedListenerKey)
<T extends EventListener> JettyModuleExtender	addMappedListener(io.bootique.di.TypeLiteral<MappedListener<T>> mappedListenerType)
<T extends EventListener> JettyModuleExtender	addMappedListener(MappedListener<T> mappedListener)
<T extends javax.servlet.Servlet> JettyModuleExtender	addMappedServlet(io.bootique.di.Key<MappedServlet<T>> mappedServletKey)
<T extends javax.servlet.Servlet> JettyModuleExtender	addMappedServlet(io.bootique.di.TypeLiteral<MappedServlet<T>> mappedServletType)
<T extends javax.servlet.Servlet> JettyModuleExtender	addMappedServlet(MappedServlet<T> mappedServlet)
JettyModuleExtender	addRequestMDCItem(String mdcKey, RequestMDCItem item)
JettyModuleExtender	addRequestMDCItem(String mdcKey, Class<? extends RequestMDCItem> itemType)
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 io.bootique.di.SetBuilder<ServletContextHandlerExtender>	contributeContextHandlerExtenders()
protected io.bootique.di.SetBuilder<javax.servlet.Filter>	contributeFilters()
protected io.bootique.di.SetBuilder<EventListener>	contributeListeners()
protected io.bootique.di.SetBuilder<MappedFilter>	contributeMappedFilters()
protected io.bootique.di.SetBuilder<MappedListener>	contributeMappedListeners()
protected io.bootique.di.SetBuilder<MappedServlet>	contributeMappedServlets()
protected io.bootique.di.MapBuilder<String,RequestMDCItem>	contributeMdcItems()
protected io.bootique.di.SetBuilder<javax.servlet.Servlet>	contributeServlets()
JettyModuleExtender	initAllExtensions()	Should be called by owning Module to initialize all contribution maps and collections.
JettyModuleExtender	setServletParam(String servletName, String propertyName, String propertyValue)	Sets an init parameter of a named servlet.
JettyModuleExtender	useDefaultServlet()

Methods inherited from class io.bootique.ModuleExtender

newMap, newMap, newMap, newMap, newSet, 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(io.bootique.di.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.

addRequestMDCItem

public JettyModuleExtender addRequestMDCItem(String mdcKey,
                                             RequestMDCItem item)

Since:

2.0.B1

addRequestMDCItem

public JettyModuleExtender addRequestMDCItem(String mdcKey,
                                             Class<? extends RequestMDCItem> itemType)

Since:

2.0.B1

addListener

public JettyModuleExtender addListener(EventListener listener)

addListener

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

addMappedListener

public <T extends EventListener> JettyModuleExtender addMappedListener(MappedListener<T> mappedListener)

Type Parameters:

T -

Parameters:

mappedListener -

Returns:

addMappedListener

public <T extends EventListener> JettyModuleExtender addMappedListener(io.bootique.di.Key<MappedListener<T>> mappedListenerKey)

Type Parameters:

T -

Parameters:

mappedListenerKey -

Returns:

addMappedListener

public <T extends EventListener> JettyModuleExtender addMappedListener(io.bootique.di.TypeLiteral<MappedListener<T>> mappedListenerType)

Type Parameters:

T -

Parameters:

mappedListenerType -

Returns:

this extender instance

addStaticServlet

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

useDefaultServlet

public JettyModuleExtender useDefaultServlet()

setServletParam

public JettyModuleExtender setServletParam(String servletName,
                                           String propertyName,
                                           String propertyValue)

Sets an init parameter of a named servlet. Same thing can be achieved via configuration.

Returns:

this extender instance

Since:

2.0

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(io.bootique.di.Key<MappedServlet<T>> mappedServletKey)

addMappedServlet

public <T extends javax.servlet.Servlet> JettyModuleExtender addMappedServlet(io.bootique.di.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(io.bootique.di.Key<MappedFilter<T>> mappedFilterKey)

addMappedFilter

public <T extends javax.servlet.Filter> JettyModuleExtender addMappedFilter(io.bootique.di.TypeLiteral<MappedFilter<T>> mappedFilterType)

addContextHandlerExtender

public JettyModuleExtender addContextHandlerExtender(ServletContextHandlerExtender extender)

Registers an extender of the Jetty ServletContextHandler. This is a low-level extension point that allows to install some Jetty extensions like the WebSockets engine. This should be usually of no interest to regular bootique-jetty users.

Parameters:

extender - an "extender" object that can customize ServletContextHandler.

Returns:

this extender instance

addContextHandlerExtender

public JettyModuleExtender addContextHandlerExtender(Class<? extends ServletContextHandlerExtender> type)

Registers an extender of the Jetty ServletContextHandler. This is a low-level extension point that allows to install some Jetty extensions like the WebSockets engine. This should be usually of no interest to regular bootique-jetty users.

Parameters:

type - a class of an "extender" object that can customize ServletContextHandler.

Returns:

this extender instance

contributeFilters

protected io.bootique.di.SetBuilder<javax.servlet.Filter> contributeFilters()

contributeServlets

protected io.bootique.di.SetBuilder<javax.servlet.Servlet> contributeServlets()

contributeListeners

protected io.bootique.di.SetBuilder<EventListener> contributeListeners()

contributeMappedFilters

protected io.bootique.di.SetBuilder<MappedFilter> contributeMappedFilters()

contributeMappedServlets

protected io.bootique.di.SetBuilder<MappedServlet> contributeMappedServlets()

contributeMappedListeners

protected io.bootique.di.SetBuilder<MappedListener> contributeMappedListeners()

contributeMdcItems

protected io.bootique.di.MapBuilder<String,RequestMDCItem> contributeMdcItems()

contributeContextHandlerExtenders

protected io.bootique.di.SetBuilder<ServletContextHandlerExtender> contributeContextHandlerExtenders()