io.werval.api

Interface Plugin<API>

Type Parameters:

API - Parameterized Plugin API type, ie. the type the Application will use.

All Known Implementing Classes:

CachePlugin, MapCachePlugin, Plugin.Void, TemplatesPlugin

public interface Plugin<API>

Application Plugin.

A Plugin is activated/passivated alongside the Application, can contribute Routes to it, is given a change to hook around interactions and can depend on other plugins.

Plugins should not create static state and their instanciation should be as close to NOOP as possible.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Plugin.Void Void Plugin exposing no type to the Application.

Method Summary

Modifier and Type	Method and Description
default void	afterInteraction(Context context) Invoked after each HTTP Interaction.
API	api() Plugin API.
Class<API>	apiType() Plugin API type.
default void	beforeInteraction(Context context) Invoked before each HTTP Interaction.
default List<Class<?>>	dependencies(Config config) Plugin dependencies.
default List<Route>	firstRoutes(Mode mode, RouteBuilder routeBuilder) Routes to prepend to the Application routes.
default List<Route>	lastRoutes(Mode mode, RouteBuilder routeBuilder) Routes to append to the Application routes.
default void	onActivate(Application application) Invoked on Application activation.
default void	onPassivate(Application application) Invoked on Application passivation.

Method Detail

apiType

Class<API> apiType()

Plugin API type.

Returns:

Plugin API type

api

API api()

Plugin API.

Returns:

Plugin API for the Application to use

dependencies

default List<Class<?>> dependencies(Config config)

Plugin dependencies.

The runtime will use this information to order the plugins activation order according to the dependency graph.

Defaults to an empty list.

Application configuration is provided to the plugin so it can decide on what to depend according to its own configuration.

Parameters:

config - Application configuration

Returns:

This plugin's dependencies

onActivate

default void onActivate(Application application)
                 throws ActivationException

Invoked on Application activation.

Defaults to no operation.

Parameters:

application - Application

Throws:

ActivationException - if something goes wrong.

firstRoutes

default List<Route> firstRoutes(Mode mode,
                                RouteBuilder routeBuilder)

Routes to prepend to the Application routes.

Defaults to no Route.

Called by Application once activated.

Parameters:

mode - Application Mode

routeBuilder - Builder for Routes

Returns:

Routes this plugin prepend to the Application routes

lastRoutes

default List<Route> lastRoutes(Mode mode,
                               RouteBuilder routeBuilder)

Routes to append to the Application routes.

Defaults to no Route.

Called by Application once activated.

Parameters:

mode - Application Mode

routeBuilder - Builder for Routes

Returns:

Routes this plugin append to the Application routes

onPassivate

default void onPassivate(Application application)

Invoked on Application passivation.

Defaults to no operation.

Parameters:

application - Application

beforeInteraction

default void beforeInteraction(Context context)

Invoked before each HTTP Interaction.

Defaults to no operation.

Parameters:

context - Interaction Context

afterInteraction

default void afterInteraction(Context context)

Invoked after each HTTP Interaction.

Defaults to no operation.

Parameters:

context - Interaction Context