com.jetdrone.vertx.yoke

Class GYoke

java.lang.Object

com.jetdrone.vertx.yoke.GYoke

public class GYoke
extends java.lang.Object

Yoke is a chain executor of middleware for Vert.x 2.x. The goal of this library is not to provide a web application framework but the backbone that helps the creation of web applications. Yoke works in a similar way to Connect middleware. Users start by declaring which middleware components want to use and then start an http server either managed by Yoke or provided by the user (say when you need https). Yoke has no extra dependencies than Vert.x itself so it is self contained.

Constructor Summary

Constructors

Constructor and Description
GYoke(org.vertx.groovy.core.Vertx vertx) Creates a Yoke instance.

Method Summary

Methods

Modifier and Type	Method and Description
GYoke	engine(java.lang.String extension, Engine engine) Adds a Render Engine to the library.
GYoke	listen(org.vertx.groovy.core.http.HttpServer gserver) Starts listening at a already created server.
GYoke	listen(int port) Starts the server listening at a given port bind to all available interfaces.
GYoke	listen(int port, java.lang.String address) Starts the server listening at a given port and given address.
GYoke	set(java.lang.String key, java.lang.Object value) When you need to share global properties with your requests you can add them to Yoke and on every request they will be available as request.get(String)
GYoke	use(groovy.lang.Closure closure) Adds a middleware to the chain with the prefix "/".
GYoke	use(Middleware middleware) Adds a middleware to the chain with the prefix "/".
GYoke	use(java.lang.String route, groovy.lang.Closure closure) Adds a Middleware to the chain.
GYoke	use(java.lang.String route, Middleware middleware) Adds a Middleware to the chain.

Methods inherited from class java.lang.Object

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

Constructor Detail

GYoke

public GYoke(org.vertx.groovy.core.Vertx vertx)

Creates a Yoke instance. This constructor should be called from a verticle and pass a valid Vertx instance. This instance will be shared with all registered middleware. The reason behind this is to allow middleware to use Vertx features such as file system and timers.

Parameters:

vertx - The Vertx instance

Method Detail

use

public GYoke use(java.lang.String route,
        groovy.lang.Closure closure)

Adds a Middleware to the chain. If the middleware is an Error Handler Middleware then it is treated differently and only the last error handler is kept. You might want to add a middleware that is only supposed to run on a specific route (path prefix). In this case if the request path does not match the prefix the middleware is skipped automatically.

Parameters:

route - The route prefix for the middleware

closure - The closure add to the chain

use

public GYoke use(groovy.lang.Closure closure)

Adds a middleware to the chain with the prefix "/".

Parameters:

closure - The closure add to the chain

See Also:

Yoke.use(String, Middleware)

use

public GYoke use(java.lang.String route,
        Middleware middleware)

Adds a Middleware to the chain. If the middleware is an Error Handler Middleware then it is treated differently and only the last error handler is kept. You might want to add a middleware that is only supposed to run on a specific route (path prefix). In this case if the request path does not match the prefix the middleware is skipped automatically.

Parameters:

route - The route prefix for the middleware

middleware - The middleware add to the chain

use

public GYoke use(Middleware middleware)

Adds a middleware to the chain with the prefix "/".

Parameters:

middleware - The middleware add to the chain

See Also:

Yoke.use(String, Middleware)

engine

public GYoke engine(java.lang.String extension,
           Engine engine)

Adds a Render Engine to the library. Render Engines are Template engines you might want to use to speed the development of your application. Once they are registered you can use the method render in the YokeResponse to render a template.

Parameters:

extension - The file extension for this template engine e.g.: .jsp

engine - The implementation of the engine

set

public GYoke set(java.lang.String key,
        java.lang.Object value)

When you need to share global properties with your requests you can add them to Yoke and on every request they will be available as request.get(String)

Parameters:

key - unique identifier

value - Any non null value, nulls are not saved

listen

public GYoke listen(int port)

Starts the server listening at a given port bind to all available interfaces.

Parameters:

port - the server TCP port

Returns:

Yoke

listen

public GYoke listen(int port,
           java.lang.String address)

Starts the server listening at a given port and given address.

Parameters:

port - the server TCP port

Returns:

Yoke

listen

public GYoke listen(org.vertx.groovy.core.http.HttpServer gserver)

Starts listening at a already created server.

Returns:

Yoke