water.server

Interface ServletProvider

All Known Implementing Classes:

CoreServletProvider

public interface ServletProvider

Method Summary

Modifier and Type	Method and Description
default int	priority() Provider priority, providers with higher priority will be used first.
java.util.List<ServletMeta>	servlets() Provides a collection of Servlets that should be registered.
default java.util.List<WebsocketMeta>	websockets()

Method Detail

servlets

java.util.List<ServletMeta> servlets()

Provides a collection of Servlets that should be registered.

Returns:

a map of context path to a Servlet class

websockets

default java.util.List<WebsocketMeta> websockets()

priority

default int priority()

Provider priority, providers with higher priority will be used first. H2O Core Provider will be used last and will override any mappings previously registered with the same context path. It is thus not possible to override the H2O Core Servlets. A typical application will have just one custom provider and users don't need to worry about setting a priority. If your use case requires multiple Servlet Providers, please make sure your priorities are set properly and or the context paths do not overlap.

Returns:

a positive integer number (0 priority is reserved for H2O Core servlets)