Package com.spec.web.expresso.router

Interface IPathRouter

All Known Implementing Classes:

Expresso, PathRouter

public interface IPathRouter

Defines guidelines on what methods are required on a router

Method Summary

Modifier and Type	Method	Description
void	delete(Middleware middleware, Middleware... additionalMiddleware)	Registers middlewares on a path which will only execute for HTTP DELETE methods.
void	delete(String path, Middleware middleware, Middleware... additionalMiddleware)	Registers middlewares on a path which will only execute for HTTP DELETE methods.
void	get(Middleware middleware, Middleware... additionalMiddleware)	Registers middlewares on empty path which will only execute for HTTP get methods.
void	get(String path, Middleware middleware, Middleware... additionalMiddleware)	Registers middlewares on a path which will only execute for HTTP get methods.
List<MiddlewareMetaData>	getMiddlewareMetadataAsList()	Returns the list of all middlewareMetadatas registerd on the current router
void	post(Middleware middleware, Middleware... additionalMiddleware)	Registers middlewares on empty path which will only execute for HTTP POST methods.
void	post(String path, Middleware middleware, Middleware... additionalMiddleware)	Registers middlewares on a path which will only execute for HTTP POST methods.
void	put(Middleware middleware, Middleware... additionalMiddleware)	Registers middlewares on a path which will only execute for HTTP PUT methods.
void	put(String path, Middleware middleware, Middleware... additionalMiddleware)	Registers middlewares on a path which will only execute for HTTP PUT methods.
IPathRouter	registerRouterOnPath(String path)	Creates a clone of current router and registers it on a path.
void	use(Middleware middleware)	Registers a middleware.
void	use(MiddlewareMetaData middlewareMetaData, MiddlewareMetaData... middlewareMetaDatas)	Method will register a middlewareMetadata on a specific path.
void	use(Middleware middleware, Middleware addMiddleware, Middleware... additionalMiddlewares)	Registers middlewares.
void	use(Middleware middleware, IPathRouter iPathRouter, IPathRouter... additionalRouters)	Registers one middleware which will execute before the routers being registerd.
void	use(IPathRouter router, IPathRouter... addRouters)	Registers routers.
void	use(String path, Middleware middleware)	Registers a middleware on a path.
void	use(String path, MiddlewareMetaData middlewareMetaData, MiddlewareMetaData... middlewareMetaDatas)	Method will register a middlewareMetadata on a specific path.
void	use(String path, Middleware middleware, Middleware addMiddleware, Middleware... additionalMiddlewares)	Registers middlewares on a path.
void	use(String path, Middleware middleware, IPathRouter iPathRouter, IPathRouter... addRouters)	Registers one middleware which will execute before the routers being registerd.
void	use(String path, IPathRouter router, IPathRouter... addRouters)	Registers routers on a path.

Method Details

use

void use(Middleware middleware)

Registers a middleware. The middleware will execute regardless of http method.

Parameters:

middleware - The primary middleware to register

use

void use(String path,
 Middleware middleware)

Registers a middleware on a path. The middlewares will execute regardless of http method.

Parameters:

path - The path on which the middlewares will be registered.

middleware - The primary middleware to register

use

void use(Middleware middleware,
 Middleware addMiddleware,
 Middleware... additionalMiddlewares)

Registers middlewares. The middlewares will execute regardless of http method.

Parameters:

middleware - The primary middleware to register

addMiddleware - Additional middleware

additionalMiddlewares - more middlewares it may execute

use

void use(String path,
 Middleware middleware,
 Middleware addMiddleware,
 Middleware... additionalMiddlewares)

Registers middlewares on a path. The middlewares will execute regardless of http method.

Parameters:

path - The path on which the middlewares will be registered.

middleware - The primary middleware to register

addMiddleware - Additional middleware

additionalMiddlewares - Optional. More middlewares to regiter

use

void use(IPathRouter router,
 IPathRouter... addRouters)

Registers routers. All the middlewares registered on these routers will execute on current router path.

Parameters:

router - The primary router to register

addRouters - Optional. additional routers to register

use

void use(String path,
 IPathRouter router,
 IPathRouter... addRouters)

Registers routers on a path. All the middlewares registered on these routers will execute on current router path + the registered path.

Parameters:

path - The path on which the routers will be registered.

router - The Primary router to register

addRouters - Optional. additional routers to register

get

void get(String path,
 Middleware middleware,
 Middleware... additionalMiddleware)

Registers middlewares on a path which will only execute for HTTP get methods.

Parameters:

path - The path on which the middleware will be registered.

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

get

void get(Middleware middleware,
 Middleware... additionalMiddleware)

Registers middlewares on empty path which will only execute for HTTP get methods.

Parameters:

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

post

void post(String path,
 Middleware middleware,
 Middleware... additionalMiddleware)

Registers middlewares on a path which will only execute for HTTP POST methods.

Parameters:

path - The path on which the middleware will be registered.

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

post

void post(Middleware middleware,
 Middleware... additionalMiddleware)

Registers middlewares on empty path which will only execute for HTTP POST methods.

Parameters:

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

put

void put(String path,
 Middleware middleware,
 Middleware... additionalMiddleware)

Registers middlewares on a path which will only execute for HTTP PUT methods.

Parameters:

path - The path on which the middleware will be registered.

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

put

void put(Middleware middleware,
 Middleware... additionalMiddleware)

Registers middlewares on a path which will only execute for HTTP PUT methods.

Parameters:

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

delete

void delete(String path,
 Middleware middleware,
 Middleware... additionalMiddleware)

Registers middlewares on a path which will only execute for HTTP DELETE methods.

Parameters:

path - The path on which the middleware will be registered.

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

delete

void delete(Middleware middleware,
 Middleware... additionalMiddleware)

Registers middlewares on a path which will only execute for HTTP DELETE methods.

Parameters:

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

registerRouterOnPath

IPathRouter registerRouterOnPath(String path)

Creates a clone of current router and registers it on a path. The current router is unchanged.

Parameters:

path - The path on which the router should be registered.

Returns:

The new router on which is registered on the provided path.

getMiddlewareMetadataAsList

List<MiddlewareMetaData> getMiddlewareMetadataAsList()

Returns the list of all middlewareMetadatas registerd on the current router

Returns:

List of middlewareMetadata

use

void use(String path,
 MiddlewareMetaData middlewareMetaData,
 MiddlewareMetaData... middlewareMetaDatas)

Method will register a middlewareMetadata on a specific path.

Parameters:

path - The path on which the middlewareMetadata should be registered.

middlewareMetaData - Middlewaremetadata to Register.

middlewareMetaDatas - Additional Middlewaremetadata to Register.

use

void use(MiddlewareMetaData middlewareMetaData,
 MiddlewareMetaData... middlewareMetaDatas)

Method will register a middlewareMetadata on a specific path.

Parameters:

middlewareMetaData - MiddlewareMetadata to register.

middlewareMetaDatas - Additional middlewareMetadata's to register.

use

void use(Middleware middleware,
 IPathRouter iPathRouter,
 IPathRouter... additionalRouters)

Registers one middleware which will execute before the routers being registerd. All the middlewares registered on these routers will execute on current router path.

Parameters:

middleware - The middleware to register

iPathRouter - Router to register on this path.

additionalRouters - Optional. List of routers to registers with the current middleware

use

void use(String path,
 Middleware middleware,
 IPathRouter iPathRouter,
 IPathRouter... addRouters)

Registers one middleware which will execute before the routers being registerd. All of these are registered on the a path. All the middlewares registered on these routers will execute on current router path.

Parameters:

path - Path on which middleware and router's should execute.

middleware - The middleware to register

iPathRouter - First router that should be registerd after the middleware.

addRouters - Optional. List of routers to registers with the current middleware