com.jetdrone.vertx.yoke

Class Middleware

java.lang.Object

com.jetdrone.vertx.yoke.Middleware

Direct Known Subclasses:

BasicAuth, BodyParser, CookieParser, Csrf, ErrorHandler, Favicon, GRouter, Limit, Logger, MethodOverride, ResponseTime, Router, Session, Static, Timeout, Vhost

public abstract class Middleware
extends java.lang.Object

Abstract class that needs to be implemented when creating a new middleware piece. The class provides access to the Vertx object and by default is not marked as a error handler middleware. If there is a need to create a new error handler middleware the isErrorHandler method should be overridden to return true.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.vertx.java.core.Vertx	vertx

Constructor Summary

Constructors

Constructor and Description
Middleware()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	handle(YokeRequest request, org.vertx.java.core.Handler<java.lang.Object> next) Handles a request.
boolean	isErrorHandler()
Middleware	setVertx(org.vertx.java.core.Vertx vertx)

Methods inherited from class java.lang.Object

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

Field Detail

vertx

protected org.vertx.java.core.Vertx vertx

Constructor Detail

Middleware

public Middleware()

Method Detail

setVertx

public Middleware setVertx(org.vertx.java.core.Vertx vertx)

isErrorHandler

public boolean isErrorHandler()

handle

public abstract void handle(YokeRequest request,
          org.vertx.java.core.Handler<java.lang.Object> next)

Handles a request.

Parameters:

request - A YokeRequest which in practice is a extended HttpServerRequest

next - The callback to inform that the next middleware in the chain should be used. A value different from null represents an error and in that case the error handler middleware will be executed.