Class Route


  • public class Route
    extends java.lang.Object
    A Route is a definition of how to handle incoming requests with a plugin controller. url it handles (eg: /foo/bar) method in controller to call for given url (eg index) permissions to be checked
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String method
      method in controller to call for given url (eg index)
      java.util.List<Permission> permissions
      permissions to be checked
      java.lang.String url
      the path it handles (eg: /foo/bar)
    • Constructor Summary

      Constructors 
      Constructor Description
      Route​(java.lang.String url, java.lang.String method, java.util.List<Permission> permissions)  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Route build​(java.lang.String url, java.lang.String method, Permission permission)
      Helper to build a Route with just one permission to check.
      static Route build​(java.lang.String url, java.lang.String method, java.util.List<Permission> permissions)
      Helper to build a Route with a list of permissions to check.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • url

        public java.lang.String url
        the path it handles (eg: /foo/bar)
      • method

        public java.lang.String method
        method in controller to call for given url (eg index)
      • permissions

        public java.util.List<Permission> permissions
        permissions to be checked
    • Constructor Detail

      • Route

        public Route​(java.lang.String url,
                     java.lang.String method,
                     java.util.List<Permission> permissions)
    • Method Detail

      • build

        public static Route build​(java.lang.String url,
                                  java.lang.String method,
                                  java.util.List<Permission> permissions)
        Helper to build a Route with a list of permissions to check.
        Parameters:
        url - to handle
        method - in controller to call
        permissions - to be checked
        Returns:
        Route
      • build

        public static Route build​(java.lang.String url,
                                  java.lang.String method,
                                  Permission permission)
        Helper to build a Route with just one permission to check.
        Parameters:
        url - to handle
        method - in controller to call
        permission - to be checked
        Returns:
        Route