Package spark

Class Routable

  • Direct Known Subclasses:
    Service

    abstract class Routable
    extends java.lang.Object
    Routable abstract class. Lets extending classes inherit default routable functionality.
    • Constructor Summary

      Constructors 
      Constructor Description
      Routable()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected abstract void addFilter​(java.lang.String httpMethod, FilterImpl filter)
      Deprecated.
      protected abstract void addFilter​(HttpMethod httpMethod, FilterImpl filter)
      Adds a filter
      protected abstract void addRoute​(java.lang.String httpMethod, RouteImpl route)
      Deprecated.
      protected abstract void addRoute​(HttpMethod httpMethod, RouteImpl route)
      Adds a route
      void after​(java.lang.String path, java.lang.String acceptType, Filter filter)
      Maps a filter to be executed after any matching routes
      void after​(java.lang.String path, Filter filter)
      Maps a filter to be executed after any matching routes
      void after​(Filter filter)
      Maps a filter to be executed after any matching routes
      void afterAfter​(java.lang.String path, Filter filter)
      Maps a filter to be executed after any matching routes even if the route throws any exception
      void afterAfter​(Filter filter)
      Maps a filter to be executed after any matching routes even if the route throws any exception
      void before​(java.lang.String path, java.lang.String acceptType, Filter filter)
      Maps a filter to be executed before any matching routes
      void before​(java.lang.String path, Filter filter)
      Maps a filter to be executed before any matching routes
      void before​(Filter filter)
      Maps a filter to be executed before any matching routes
      void connect​(java.lang.String path, java.lang.String acceptType, Route route)
      Map the route for HTTP CONNECT requests
      void connect​(java.lang.String path, java.lang.String acceptType, Route route, ResponseTransformer transformer)
      Map the route for HTTP CONNECT requests
      void connect​(java.lang.String path, java.lang.String acceptType, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP CONNECT requests
      void connect​(java.lang.String path, Route route)
      Map the route for HTTP CONNECT requests
      void connect​(java.lang.String path, Route route, ResponseTransformer transformer)
      Map the route for HTTP CONNECT requests
      void connect​(java.lang.String path, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP CONNECT requests
      private RouteImpl createRouteImpl​(java.lang.String path, java.lang.String acceptType, Route route)
      Create route implementation or use default response transformer
      private RouteImpl createRouteImpl​(java.lang.String path, Route route)
      Create route implementation or use default response transformer
      void defaultResponseTransformer​(ResponseTransformer transformer)
      Sets default response transformer
      void delete​(java.lang.String path, java.lang.String acceptType, Route route)
      Map the route for HTTP DELETE requests
      void delete​(java.lang.String path, java.lang.String acceptType, Route route, ResponseTransformer transformer)
      Map the route for HTTP DELETE requests
      void delete​(java.lang.String path, java.lang.String acceptType, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP DELETE requests
      void delete​(java.lang.String path, Route route)
      Map the route for HTTP DELETE requests
      void delete​(java.lang.String path, Route route, ResponseTransformer transformer)
      Map the route for HTTP DELETE requests
      void delete​(java.lang.String path, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP DELETE requests
      void get​(java.lang.String path, java.lang.String acceptType, Route route)
      Map the route for HTTP GET requests
      void get​(java.lang.String path, java.lang.String acceptType, Route route, ResponseTransformer transformer)
      Map the route for HTTP GET requests
      void get​(java.lang.String path, java.lang.String acceptType, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP GET requests
      void get​(java.lang.String path, Route route)
      Map the route for HTTP GET requests
      void get​(java.lang.String path, Route route, ResponseTransformer transformer)
      Map the route for HTTP GET requests
      void get​(java.lang.String path, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP GET requests
      void head​(java.lang.String path, java.lang.String acceptType, Route route)
      Map the route for HTTP HEAD requests
      void head​(java.lang.String path, java.lang.String acceptType, Route route, ResponseTransformer transformer)
      Map the route for HTTP HEAD requests
      void head​(java.lang.String path, java.lang.String acceptType, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP HEAD requests
      void head​(java.lang.String path, Route route)
      Map the route for HTTP HEAD requests
      void head​(java.lang.String path, Route route, ResponseTransformer transformer)
      Map the route for HTTP HEAD requests
      void head​(java.lang.String path, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP HEAD requests
      void options​(java.lang.String path, java.lang.String acceptType, Route route)
      Map the route for HTTP OPTIONS requests
      void options​(java.lang.String path, java.lang.String acceptType, Route route, ResponseTransformer transformer)
      Map the route for HTTP OPTIONS requests
      void options​(java.lang.String path, java.lang.String acceptType, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP OPTIONS requests
      void options​(java.lang.String path, Route route)
      Map the route for HTTP OPTIONS requests
      void options​(java.lang.String path, Route route, ResponseTransformer transformer)
      Map the route for HTTP OPTIONS requests
      void options​(java.lang.String path, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP OPTIONS requests
      void patch​(java.lang.String path, java.lang.String acceptType, Route route)
      Map the route for HTTP PATCH requests
      void patch​(java.lang.String path, java.lang.String acceptType, Route route, ResponseTransformer transformer)
      Map the route for HTTP PATCH requests
      void patch​(java.lang.String path, java.lang.String acceptType, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP PATCH requests
      void patch​(java.lang.String path, Route route)
      Map the route for HTTP PATCH requests
      void patch​(java.lang.String path, Route route, ResponseTransformer transformer)
      Map the route for HTTP PATCH requests
      void patch​(java.lang.String path, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP PATCH requests
      void post​(java.lang.String path, java.lang.String acceptType, Route route)
      Map the route for HTTP POST requests
      void post​(java.lang.String path, java.lang.String acceptType, Route route, ResponseTransformer transformer)
      Map the route for HTTP POST requests
      void post​(java.lang.String path, java.lang.String acceptType, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP POST requests
      void post​(java.lang.String path, Route route)
      Map the route for HTTP POST requests
      void post​(java.lang.String path, Route route, ResponseTransformer transformer)
      Map the route for HTTP POST requests
      void post​(java.lang.String path, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP POST requests
      void put​(java.lang.String path, java.lang.String acceptType, Route route)
      Map the route for HTTP PUT requests
      void put​(java.lang.String path, java.lang.String acceptType, Route route, ResponseTransformer transformer)
      Map the route for HTTP PUT requests
      void put​(java.lang.String path, java.lang.String acceptType, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP PUT requests
      void put​(java.lang.String path, Route route)
      Map the route for HTTP PUT requests
      void put​(java.lang.String path, Route route, ResponseTransformer transformer)
      Map the route for HTTP PUT requests
      void put​(java.lang.String path, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP PUT requests
      void trace​(java.lang.String path, java.lang.String acceptType, Route route)
      Map the route for HTTP TRACE requests
      void trace​(java.lang.String path, java.lang.String acceptType, Route route, ResponseTransformer transformer)
      Map the route for HTTP TRACE requests
      void trace​(java.lang.String path, java.lang.String acceptType, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP TRACE requests
      void trace​(java.lang.String path, Route route)
      Map the route for HTTP TRACE requests
      void trace​(java.lang.String path, Route route, ResponseTransformer transformer)
      Map the route for HTTP TRACE requests
      void trace​(java.lang.String path, TemplateViewRoute route, TemplateEngine engine)
      Map the route for HTTP TRACE requests
      • Methods inherited from class java.lang.Object

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

      • Routable

        Routable()
    • Method Detail

      • addRoute

        protected abstract void addRoute​(HttpMethod httpMethod,
                                         RouteImpl route)
        Adds a route
        Parameters:
        httpMethod - the HTTP method
        route - the route implementation
      • addRoute

        @Deprecated
        protected abstract void addRoute​(java.lang.String httpMethod,
                                         RouteImpl route)
        Deprecated.
      • addFilter

        protected abstract void addFilter​(HttpMethod httpMethod,
                                          FilterImpl filter)
        Adds a filter
        Parameters:
        httpMethod - the HTTP method
        filter - the route implementation
      • addFilter

        @Deprecated
        protected abstract void addFilter​(java.lang.String httpMethod,
                                          FilterImpl filter)
        Deprecated.
      • get

        public void get​(java.lang.String path,
                        Route route)
        Map the route for HTTP GET requests
        Parameters:
        path - the path
        route - The route
      • post

        public void post​(java.lang.String path,
                         Route route)
        Map the route for HTTP POST requests
        Parameters:
        path - the path
        route - The route
      • put

        public void put​(java.lang.String path,
                        Route route)
        Map the route for HTTP PUT requests
        Parameters:
        path - the path
        route - The route
      • patch

        public void patch​(java.lang.String path,
                          Route route)
        Map the route for HTTP PATCH requests
        Parameters:
        path - the path
        route - The route
      • delete

        public void delete​(java.lang.String path,
                           Route route)
        Map the route for HTTP DELETE requests
        Parameters:
        path - the path
        route - The route
      • head

        public void head​(java.lang.String path,
                         Route route)
        Map the route for HTTP HEAD requests
        Parameters:
        path - the path
        route - The route
      • trace

        public void trace​(java.lang.String path,
                          Route route)
        Map the route for HTTP TRACE requests
        Parameters:
        path - the path
        route - The route
      • connect

        public void connect​(java.lang.String path,
                            Route route)
        Map the route for HTTP CONNECT requests
        Parameters:
        path - the path
        route - The route
      • options

        public void options​(java.lang.String path,
                            Route route)
        Map the route for HTTP OPTIONS requests
        Parameters:
        path - the path
        route - The route
      • before

        public void before​(java.lang.String path,
                           Filter filter)
        Maps a filter to be executed before any matching routes
        Parameters:
        path - the path
        filter - The filter
      • after

        public void after​(java.lang.String path,
                          Filter filter)
        Maps a filter to be executed after any matching routes
        Parameters:
        path - the path
        filter - The filter
      • get

        public void get​(java.lang.String path,
                        java.lang.String acceptType,
                        Route route)
        Map the route for HTTP GET requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
      • post

        public void post​(java.lang.String path,
                         java.lang.String acceptType,
                         Route route)
        Map the route for HTTP POST requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
      • put

        public void put​(java.lang.String path,
                        java.lang.String acceptType,
                        Route route)
        Map the route for HTTP PUT requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
      • patch

        public void patch​(java.lang.String path,
                          java.lang.String acceptType,
                          Route route)
        Map the route for HTTP PATCH requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
      • delete

        public void delete​(java.lang.String path,
                           java.lang.String acceptType,
                           Route route)
        Map the route for HTTP DELETE requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
      • head

        public void head​(java.lang.String path,
                         java.lang.String acceptType,
                         Route route)
        Map the route for HTTP HEAD requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
      • trace

        public void trace​(java.lang.String path,
                          java.lang.String acceptType,
                          Route route)
        Map the route for HTTP TRACE requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
      • connect

        public void connect​(java.lang.String path,
                            java.lang.String acceptType,
                            Route route)
        Map the route for HTTP CONNECT requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
      • options

        public void options​(java.lang.String path,
                            java.lang.String acceptType,
                            Route route)
        Map the route for HTTP OPTIONS requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
      • before

        public void before​(Filter filter)
        Maps a filter to be executed before any matching routes
        Parameters:
        filter - The filter
      • after

        public void after​(Filter filter)
        Maps a filter to be executed after any matching routes
        Parameters:
        filter - The filter
      • before

        public void before​(java.lang.String path,
                           java.lang.String acceptType,
                           Filter filter)
        Maps a filter to be executed before any matching routes
        Parameters:
        path - the path
        acceptType - the accept type
        filter - The filter
      • after

        public void after​(java.lang.String path,
                          java.lang.String acceptType,
                          Filter filter)
        Maps a filter to be executed after any matching routes
        Parameters:
        path - the path
        acceptType - the accept type
        filter - The filter
      • afterAfter

        public void afterAfter​(Filter filter)
        Maps a filter to be executed after any matching routes even if the route throws any exception
        Parameters:
        filter - The filter
      • afterAfter

        public void afterAfter​(java.lang.String path,
                               Filter filter)
        Maps a filter to be executed after any matching routes even if the route throws any exception
        Parameters:
        filter - The filter
      • get

        public void get​(java.lang.String path,
                        TemplateViewRoute route,
                        TemplateEngine engine)
        Map the route for HTTP GET requests
        Parameters:
        path - the path
        route - The route
        engine - the template engine
      • get

        public void get​(java.lang.String path,
                        java.lang.String acceptType,
                        TemplateViewRoute route,
                        TemplateEngine engine)
        Map the route for HTTP GET requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        engine - the template engine
      • post

        public void post​(java.lang.String path,
                         TemplateViewRoute route,
                         TemplateEngine engine)
        Map the route for HTTP POST requests
        Parameters:
        path - the path
        route - The route
        engine - the template engine
      • post

        public void post​(java.lang.String path,
                         java.lang.String acceptType,
                         TemplateViewRoute route,
                         TemplateEngine engine)
        Map the route for HTTP POST requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        engine - the template engine
      • put

        public void put​(java.lang.String path,
                        TemplateViewRoute route,
                        TemplateEngine engine)
        Map the route for HTTP PUT requests
        Parameters:
        path - the path
        route - The route
        engine - the template engine
      • put

        public void put​(java.lang.String path,
                        java.lang.String acceptType,
                        TemplateViewRoute route,
                        TemplateEngine engine)
        Map the route for HTTP PUT requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        engine - the template engine
      • delete

        public void delete​(java.lang.String path,
                           TemplateViewRoute route,
                           TemplateEngine engine)
        Map the route for HTTP DELETE requests
        Parameters:
        path - the path
        route - The route
        engine - the template engine
      • delete

        public void delete​(java.lang.String path,
                           java.lang.String acceptType,
                           TemplateViewRoute route,
                           TemplateEngine engine)
        Map the route for HTTP DELETE requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        engine - the template engine
      • patch

        public void patch​(java.lang.String path,
                          TemplateViewRoute route,
                          TemplateEngine engine)
        Map the route for HTTP PATCH requests
        Parameters:
        path - the path
        route - The route
        engine - the template engine
      • patch

        public void patch​(java.lang.String path,
                          java.lang.String acceptType,
                          TemplateViewRoute route,
                          TemplateEngine engine)
        Map the route for HTTP PATCH requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        engine - the template engine
      • head

        public void head​(java.lang.String path,
                         TemplateViewRoute route,
                         TemplateEngine engine)
        Map the route for HTTP HEAD requests
        Parameters:
        path - the path
        route - The route
        engine - the template engine
      • head

        public void head​(java.lang.String path,
                         java.lang.String acceptType,
                         TemplateViewRoute route,
                         TemplateEngine engine)
        Map the route for HTTP HEAD requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        engine - the template engine
      • trace

        public void trace​(java.lang.String path,
                          TemplateViewRoute route,
                          TemplateEngine engine)
        Map the route for HTTP TRACE requests
        Parameters:
        path - the path
        route - The route
        engine - the template engine
      • trace

        public void trace​(java.lang.String path,
                          java.lang.String acceptType,
                          TemplateViewRoute route,
                          TemplateEngine engine)
        Map the route for HTTP TRACE requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        engine - the template engine
      • connect

        public void connect​(java.lang.String path,
                            TemplateViewRoute route,
                            TemplateEngine engine)
        Map the route for HTTP CONNECT requests
        Parameters:
        path - the path
        route - The route
        engine - the template engine
      • connect

        public void connect​(java.lang.String path,
                            java.lang.String acceptType,
                            TemplateViewRoute route,
                            TemplateEngine engine)
        Map the route for HTTP CONNECT requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        engine - the template engine
      • options

        public void options​(java.lang.String path,
                            TemplateViewRoute route,
                            TemplateEngine engine)
        Map the route for HTTP OPTIONS requests
        Parameters:
        path - the path
        route - The route
        engine - the template engine
      • options

        public void options​(java.lang.String path,
                            java.lang.String acceptType,
                            TemplateViewRoute route,
                            TemplateEngine engine)
        Map the route for HTTP OPTIONS requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        engine - the template engine
      • get

        public void get​(java.lang.String path,
                        Route route,
                        ResponseTransformer transformer)
        Map the route for HTTP GET requests
        Parameters:
        path - the path
        route - The route
        transformer - the response transformer
      • get

        public void get​(java.lang.String path,
                        java.lang.String acceptType,
                        Route route,
                        ResponseTransformer transformer)
        Map the route for HTTP GET requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        transformer - the response transformer
      • post

        public void post​(java.lang.String path,
                         Route route,
                         ResponseTransformer transformer)
        Map the route for HTTP POST requests
        Parameters:
        path - the path
        route - The route
        transformer - the response transformer
      • post

        public void post​(java.lang.String path,
                         java.lang.String acceptType,
                         Route route,
                         ResponseTransformer transformer)
        Map the route for HTTP POST requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        transformer - the response transformer
      • put

        public void put​(java.lang.String path,
                        Route route,
                        ResponseTransformer transformer)
        Map the route for HTTP PUT requests
        Parameters:
        path - the path
        route - The route
        transformer - the response transformer
      • put

        public void put​(java.lang.String path,
                        java.lang.String acceptType,
                        Route route,
                        ResponseTransformer transformer)
        Map the route for HTTP PUT requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        transformer - the response transformer
      • delete

        public void delete​(java.lang.String path,
                           Route route,
                           ResponseTransformer transformer)
        Map the route for HTTP DELETE requests
        Parameters:
        path - the path
        route - The route
        transformer - the response transformer
      • delete

        public void delete​(java.lang.String path,
                           java.lang.String acceptType,
                           Route route,
                           ResponseTransformer transformer)
        Map the route for HTTP DELETE requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        transformer - the response transformer
      • head

        public void head​(java.lang.String path,
                         Route route,
                         ResponseTransformer transformer)
        Map the route for HTTP HEAD requests
        Parameters:
        path - the path
        route - The route
        transformer - the response transformer
      • head

        public void head​(java.lang.String path,
                         java.lang.String acceptType,
                         Route route,
                         ResponseTransformer transformer)
        Map the route for HTTP HEAD requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        transformer - the response transformer
      • connect

        public void connect​(java.lang.String path,
                            Route route,
                            ResponseTransformer transformer)
        Map the route for HTTP CONNECT requests
        Parameters:
        path - the path
        route - The route
        transformer - the response transformer
      • connect

        public void connect​(java.lang.String path,
                            java.lang.String acceptType,
                            Route route,
                            ResponseTransformer transformer)
        Map the route for HTTP CONNECT requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        transformer - the response transformer
      • trace

        public void trace​(java.lang.String path,
                          Route route,
                          ResponseTransformer transformer)
        Map the route for HTTP TRACE requests
        Parameters:
        path - the path
        route - The route
        transformer - the response transformer
      • trace

        public void trace​(java.lang.String path,
                          java.lang.String acceptType,
                          Route route,
                          ResponseTransformer transformer)
        Map the route for HTTP TRACE requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        transformer - the response transformer
      • options

        public void options​(java.lang.String path,
                            Route route,
                            ResponseTransformer transformer)
        Map the route for HTTP OPTIONS requests
        Parameters:
        path - the path
        route - The route
        transformer - the response transformer
      • options

        public void options​(java.lang.String path,
                            java.lang.String acceptType,
                            Route route,
                            ResponseTransformer transformer)
        Map the route for HTTP OPTIONS requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        transformer - the response transformer
      • patch

        public void patch​(java.lang.String path,
                          Route route,
                          ResponseTransformer transformer)
        Map the route for HTTP PATCH requests
        Parameters:
        path - the path
        route - The route
        transformer - the response transformer
      • patch

        public void patch​(java.lang.String path,
                          java.lang.String acceptType,
                          Route route,
                          ResponseTransformer transformer)
        Map the route for HTTP PATCH requests
        Parameters:
        path - the path
        acceptType - the accept type
        route - The route
        transformer - the response transformer
      • createRouteImpl

        private RouteImpl createRouteImpl​(java.lang.String path,
                                          java.lang.String acceptType,
                                          Route route)
        Create route implementation or use default response transformer
        Parameters:
        path - the path
        acceptType - the accept type
        route - the route
        Returns:
        ResponseTransformerRouteImpl or RouteImpl
      • createRouteImpl

        private RouteImpl createRouteImpl​(java.lang.String path,
                                          Route route)
        Create route implementation or use default response transformer
        Parameters:
        path - the path
        route - the route
        Returns:
        ResponseTransformerRouteImpl or RouteImpl
      • defaultResponseTransformer

        public void defaultResponseTransformer​(ResponseTransformer transformer)
        Sets default response transformer
        Parameters:
        transformer -