io.bootique.jetty

Class JettyModule

java.lang.Object

io.bootique.ConfigModule

io.bootique.jetty.JettyModule

All Implemented Interfaces:

com.google.inject.Module

public class JettyModule
extends io.bootique.ConfigModule

Field Summary

Fields inherited from class io.bootique.ConfigModule

CONFIG_PREFIX_BUILDER, configPrefix

Constructor Summary

Constructors

Constructor and Description
JettyModule()
JettyModule(String configPrefix)

Method Summary

Modifier and Type	Method and Description
void	configure(com.google.inject.Binder binder)
JettyModule	context(String context)
static void	contributeDefaultServlet(com.google.inject.Binder binder) Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.useDefaultServlet().
static com.google.inject.multibindings.Multibinder<javax.servlet.Filter>	contributeFilters(com.google.inject.Binder binder) Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addFilter(Class) or similar methods.
static com.google.inject.multibindings.Multibinder<EventListener>	contributeListeners(com.google.inject.Binder binder) Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addListener(Class)or similar methods.
static com.google.inject.multibindings.Multibinder<MappedFilter>	contributeMappedFilters(com.google.inject.Binder binder) Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addMappedFilter(MappedFilter) or similar methods.
static com.google.inject.multibindings.Multibinder<MappedServlet>	contributeMappedServlets(com.google.inject.Binder binder) Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addMappedServlet(MappedServlet) or similar methods.
static com.google.inject.multibindings.Multibinder<javax.servlet.Servlet>	contributeServlets(com.google.inject.Binder binder) Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addServlet(Class) or similar methods.
static void	contributeStaticServlet(com.google.inject.Binder binder, String name, String... urlPatterns) Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addStaticServlet(String, String...).
static JettyModuleExtender	extend(com.google.inject.Binder binder) Returns an instance of JettyModuleExtender used by downstream modules to load custom extensions of services declared in the JettyModule.
JettyModule	port(int port)

Methods inherited from class io.bootique.ConfigModule

defaultConfigPrefix

Methods inherited from class java.lang.Object

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

Constructor Detail

JettyModule

public JettyModule(String configPrefix)

JettyModule

public JettyModule()

Method Detail

extend

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

Returns an instance of JettyModuleExtender used by downstream modules to load custom extensions of services declared in the JettyModule. Should be invoked from a downstream Module's "configure" method.

Parameters:

binder - DI binder passed to the Module that invokes this method.

Returns:

an instance of JettyModuleExtender that can be used to load Jetty custom extensions.

Since:

0.20

contributeMappedServlets

@Deprecated
public static com.google.inject.multibindings.Multibinder<MappedServlet> contributeMappedServlets(com.google.inject.Binder binder)

Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addMappedServlet(MappedServlet) or similar methods.

Parameters:

binder - DI binder passed to the Module that invokes this method.

Returns:

returns a Multibinder for servlets.

Since:

0.14

contributeServlets

@Deprecated
public static com.google.inject.multibindings.Multibinder<javax.servlet.Servlet> contributeServlets(com.google.inject.Binder binder)

Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addServlet(Class) or similar methods.

Returns a Multibinder for container servlets. Servlets must be annotated with WebServlet. Otherwise they should be mapped via contributeMappedServlets(Binder).

Parameters:

binder - DI binder passed to the Module that invokes this method.

Returns:

returns a Multibinder for servlets.

Since:

0.14

contributeStaticServlet

@Deprecated
public static void contributeStaticServlet(com.google.inject.Binder binder,
                                                       String name,
                                                       String... urlPatterns)

Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addStaticServlet(String, String...).

Adds a servlet for serving static resources for a given URL. The actual servlet used is Jetty DefaultServlet, and it can be configured further via servlet parameters. Static resources will be resolved relative to ServerFactory's "staticResourceBase" , with URL path used to locate a subfolder, unless servlet-specific configuration is explicitly provided.

Parameters:

binder - DI binder.

name - servlet name that can be referenced in YAML to pass parameters.

urlPatterns - url patterns

Since:

0.15

See Also:

DefaultServlet.

contributeDefaultServlet

@Deprecated
public static void contributeDefaultServlet(com.google.inject.Binder binder)

Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.useDefaultServlet().

Adds a default servlet to Jetty, as specified in servlet spec. Equivalent to 'contributeStaticServlet(binder, "/", "default")'.

Parameters:

binder - DI binder.

Since:

0.15

contributeFilters

@Deprecated
public static com.google.inject.multibindings.Multibinder<javax.servlet.Filter> contributeFilters(com.google.inject.Binder binder)

Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addFilter(Class) or similar methods.

Returns a Multibinder for servlet filters. Filters must be annotated with WebFilter. Otherwise they should be mapped via contributeMappedFilters(Binder), where you can explicitly specify URL patterns, etc.

Parameters:

binder - DI binder passed to the Module that invokes this method.

Returns:

returns a Multibinder for container filters.

Since:

0.14

contributeMappedFilters

@Deprecated
public static com.google.inject.multibindings.Multibinder<MappedFilter> contributeMappedFilters(com.google.inject.Binder binder)

Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addMappedFilter(MappedFilter) or similar methods.

Parameters:

binder - DI binder passed to the Module that invokes this method.

Returns:

returns a Multibinder for servlet filters.

Since:

0.14

contributeListeners

@Deprecated
public static com.google.inject.multibindings.Multibinder<EventListener> contributeListeners(com.google.inject.Binder binder)

Deprecated. since 0.20 call extend(Binder) and then call JettyModuleExtender.addListener(Class)or similar methods.

Parameters:

binder - DI binder passed to the Module that invokes this method.

Returns:

returns a Multibinder for web listeners.

Since:

0.12

context

public JettyModule context(String context)

port

public JettyModule port(int port)

configure

public void configure(com.google.inject.Binder binder)

Specified by:

configure in interface com.google.inject.Module

Overrides:

configure in class io.bootique.ConfigModule