io.jooby

Class WebVariables

java.lang.Object

io.jooby.WebVariables

All Implemented Interfaces:

Route.Aware, Route.Decorator

public class WebVariables
extends Object
implements Route.Decorator

Add common variables to as Context attributes so they are accessible from template engine. Usage:

    decorator(new WebVariables());

   get("/", ctx -> new ModelAndView("index.ftl"));
 

Template engine will be able to access to the following attributes: - contextPath. Empty when context path is set to / or actual context path. - path. Current request path, as defined by Context.getRequestPath(). - user. Current user (if any) as defined by Context.getUser().

Since:

2.4.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
WebVariables() Creates a new web variables.
WebVariables(String scope) Creates a web variables under the given scope.

Method Summary

Modifier and Type	Method and Description
Route.Handler	apply(Route.Handler next) Chain the decorator within next handler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jooby.Route.Decorator

then, then

Methods inherited from interface io.jooby.Route.Aware

setRoute

Constructor Detail

WebVariables

public WebVariables(@Nonnull
                    String scope)

Creates a web variables under the given scope.

Parameters:

scope - Scope to use.

WebVariables

public WebVariables()

Creates a new web variables.

Method Detail

apply

@Nonnull
public Route.Handler apply(@Nonnull
                                    Route.Handler next)

Description copied from interface: Route.Decorator

Chain the decorator within next handler.

Specified by:

apply in interface Route.Decorator

Parameters:

next - Next handler.

Returns:

A new handler.