Package com.inductiveautomation.perspective.gateway.comm

Class Routes.AuthenticatedRouteHandlerWrapper

java.lang.Object

com.inductiveautomation.perspective.gateway.comm.Routes.AuthenticatedRouteHandlerWrapper

All Implemented Interfaces:

RouteHandler

Enclosing class:

Routes

public static class Routes.AuthenticatedRouteHandlerWrapper
extends Object
implements RouteHandler

Constructor Summary

Constructors

Constructor	Description
AuthenticatedRouteHandlerWrapper(Routes.AuthenticatedRouteHandler delegate)
AuthenticatedRouteHandlerWrapper(Routes.AuthenticatedRouteHandler delegate, boolean runningSessionRequired)

Method Summary

Modifier and Type	Method	Description
Object	handle(RequestContext req, jakarta.servlet.http.HttpServletResponse res)	Called when the route this handler is attached to is matched in an incoming HTTP request.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticatedRouteHandlerWrapper

public AuthenticatedRouteHandlerWrapper(Routes.AuthenticatedRouteHandler delegate)

AuthenticatedRouteHandlerWrapper

public AuthenticatedRouteHandlerWrapper(Routes.AuthenticatedRouteHandler delegate,
 boolean runningSessionRequired)

Method Details

handle

public Object handle(RequestContext req,
 jakarta.servlet.http.HttpServletResponse res)
              throws Exception

Description copied from interface: RouteHandler

Called when the route this handler is attached to is matched in an incoming HTTP request.

Specified by:

handle in interface RouteHandler

Returns:

Return an object if your handler should result in a string body returned. Optionally transform the object if it is not already a string by adding a ResponseRenderer to your mounted route. Return null if you have handled the response yourself by directly manipulating the HttpServletResponse.

Throws:

Exception