Package com.spec.web.expresso.router

Class PathRouter

java.lang.Object

com.spec.web.expresso.router.PathRouter

All Implemented Interfaces:

IPathRouter

Direct Known Subclasses:

Expresso

public class PathRouter
extends Object
implements IPathRouter

Following class exectues middlewares based on http url path and http methods. It can also register other routers,

Field Summary

Fields

Modifier and Type	Field	Description
protected List<MiddlewareMetaData>	middlewares	List of middleware metadata registered on this router

Constructor Summary

Constructors

Constructor	Description
PathRouter()	Constructs the class.

Method Summary

Modifier and Type	Method	Description
void	appendMiddlewareMetaData(MiddlewareMetaData middlewareMetaData)	Appends a already constructed middleware metadata object to the list.
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)	Registers a middleware metadata while also setting its path on it.
void	use(Middleware middleware, Middleware addMiddleware, Middleware... additionalMiddleware)	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... additionalRouters)	Registers routers.
void	use(String path, Middleware middleware)	Registers a middleware on a path.
void	use(String path, MiddlewareMetaData middlewareMetaData, MiddlewareMetaData... middlewareMetaDatas)	Registers a middleware metadata while also setting its path on it.
void	use(String path, Middleware middleware, Middleware addMiddleware, Middleware... additionalMiddleware)	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.

Methods inherited from class java.lang.Object

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

Field Details

middlewares

protected List<MiddlewareMetaData> middlewares

List of middleware metadata registered on this router

Constructor Details

PathRouter

public PathRouter()

Constructs the class.

Method Details

appendMiddlewareMetaData

public void appendMiddlewareMetaData(MiddlewareMetaData middlewareMetaData)

Appends a already constructed middleware metadata object to the list.

Parameters:

middlewareMetaData - The middleware metadata to add to the list.

use

public void use(Middleware middleware,
 Middleware addMiddleware,
 Middleware... additionalMiddleware)

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

Specified by:

use in interface IPathRouter

Parameters:

middleware - The primary middleware to register

addMiddleware - Additional middleware

additionalMiddleware - more middlewares it may execute

use

public void use(String path,
 Middleware middleware,
 Middleware addMiddleware,
 Middleware... additionalMiddleware)

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

Specified by:

use in interface IPathRouter

Parameters:

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

middleware - The primary middleware to register

addMiddleware - Additional middleware

additionalMiddleware - Optional. More middlewares to regiter

use

public void use(IPathRouter router,
 IPathRouter... additionalRouters)

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

Specified by:

use in interface IPathRouter

Parameters:

router - The primary router to register

additionalRouters - Optional. additional routers to register

use

public 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.

Specified by:

use in interface IPathRouter

Parameters:

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

router - The Primary router to register

addRouters - Optional. additional routers to register

get

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

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

Specified by:

get in interface IPathRouter

Parameters:

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

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

post

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

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

Specified by:

post in interface IPathRouter

Parameters:

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

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

put

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

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

Specified by:

put in interface IPathRouter

Parameters:

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

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

delete

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

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

Specified by:

delete in interface IPathRouter

Parameters:

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

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

registerRouterOnPath

public IPathRouter registerRouterOnPath(String path)

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

Specified by:

registerRouterOnPath in interface IPathRouter

Parameters:

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

Returns:

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

getMiddlewareMetadataAsList

public List<MiddlewareMetaData> getMiddlewareMetadataAsList()

Returns the list of all middlewareMetadatas registerd on the current router

Specified by:

getMiddlewareMetadataAsList in interface IPathRouter

Returns:

List of middlewareMetadata

use

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

Registers a middleware metadata while also setting its path on it.

Specified by:

use in interface IPathRouter

Parameters:

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

middlewareMetaData - Middlewaremetadata to Register.

middlewareMetaDatas - Additional Middlewaremetadata to Register.

use

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

Registers a middleware metadata while also setting its path on it.

Specified by:

use in interface IPathRouter

Parameters:

middlewareMetaData - MiddlewareMetadata to register.

middlewareMetaDatas - Additional middlewareMetadata's to register.

get

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

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

Specified by:

get in interface IPathRouter

Parameters:

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

post

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

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

Specified by:

post in interface IPathRouter

Parameters:

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

put

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

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

Specified by:

put in interface IPathRouter

Parameters:

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

delete

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

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

Specified by:

delete in interface IPathRouter

Parameters:

middleware - Primary middleware to register.

additionalMiddleware - Optional. Additional middlewares to register.

use

public 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.

Specified by:

use in interface IPathRouter

Parameters:

middleware - The middleware to register

iPathRouter - Router that should execute after the middleware.

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

use

public 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.

Specified by:

use in interface IPathRouter

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

use

public void use(Middleware middleware)

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

Specified by:

use in interface IPathRouter

Parameters:

middleware - The primary middleware to register

use

public void use(String path,
 Middleware middleware)

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

Specified by:

use in interface IPathRouter

Parameters:

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

middleware - The primary middleware to register