Interface RouteGroup
-
public interface RouteGroup
A bundle of routes mounted underneath /data/group-name/*
Each route will be activated when a web request that matches the route's method and path comes into the Ignition webserver. The route handler will then be called to provide a response. The response can then be rendered to a string via the response renderer, if desired. Some examples:
Mounts a text/plain response of "hello, world" at /data/module-id/hello_world
routeGroup.newRoute("/hello_world") .handler((request, response) -> "Hello, world!") .mount();
Mounts a json response that serializes a lits of widget objects using GSON
routeGroup.newRoute("/widgets") .handler(this::getWidgetList) .renderer(gson::toJson) .type("application/json") .mount();
Mounts a json response that fetches a specific object, using url parameter matching. For example, the URL request /data/module-id/widget/8271 would fetch widget with id=8271
routeGroup.newRoute("/widget/:id") .handler((request, response) -> findWidget(request.getParameter("id")) .renderer(gson::toJson) .type("application/json") .mount();
Mounts a plain text response that can only be accessed if the user has a session that is authorized to view the main/web/status section of the gateway web ui.
routeGroup.newRoute("/canyouseethis") .handler((request, response) -> "yes you can") .restrict(WicketAccessControl.STATUS_SECTION) .mount();
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
RouteGroup.CacheKeyGen
static interface
RouteGroup.RouteMounter
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TYPE_IMG_SVG_XML
static java.lang.String
TYPE_JSON
static java.lang.String
TYPE_PLAIN_TEXT
static java.lang.String
TYPE_TEXT_CSS
static java.lang.String
TYPE_TEXT_HTML
static java.lang.String
TYPE_XML
static java.lang.String
TYPE_ZIP
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RouteGroup.RouteMounter
newRoute(java.lang.String path)
Begin adding a route.
-
-
-
Field Detail
-
TYPE_PLAIN_TEXT
static final java.lang.String TYPE_PLAIN_TEXT
- See Also:
- Constant Field Values
-
TYPE_JSON
static final java.lang.String TYPE_JSON
- See Also:
- Constant Field Values
-
TYPE_XML
static final java.lang.String TYPE_XML
- See Also:
- Constant Field Values
-
TYPE_TEXT_HTML
static final java.lang.String TYPE_TEXT_HTML
- See Also:
- Constant Field Values
-
TYPE_TEXT_CSS
static final java.lang.String TYPE_TEXT_CSS
- See Also:
- Constant Field Values
-
TYPE_IMG_SVG_XML
static final java.lang.String TYPE_IMG_SVG_XML
- See Also:
- Constant Field Values
-
TYPE_ZIP
static final java.lang.String TYPE_ZIP
- See Also:
- Constant Field Values
-
-
Method Detail
-
newRoute
RouteGroup.RouteMounter newRoute(java.lang.String path)
Begin adding a route. Creates a RouteMounter object which helps create a valid route
-
-