Package com.inductiveautomation.ignition.gateway.dataroutes

Interface ItemListRouteHandler<T>

Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface ItemListRouteHandler<T>
Handler for a route that returns a list of items. By using this specialized route handler, the route system can automatically provide filtering, sorting, paging and searching capabilities.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<T>
    handle(RequestContext req, jakarta.servlet.http.HttpServletResponse resp)
    Called when the route that this handler is attached to is matched in an incoming HTTP request.

  • Method Details

    • handle

      List<T> handle(RequestContext req, jakarta.servlet.http.HttpServletResponse resp) throws Exception
      Called when the route that this handler is attached to is matched in an incoming HTTP request.
      Returns:
      Return a List of items. The list should have a predictable natural order. Return null if you have handled the response yourself by directly manipulating the HttpServletResponse.
      Throws:
      Exception