org.jooby.handlers

Class AssetHandler

java.lang.Object

org.jooby.handlers.AssetHandler

All Implemented Interfaces:

Route.Filter, Route.Handler

public class AssetHandler
extends Object
implements Route.Handler

Serve static resources, via Jooby.assets(String) or variants.

e-tag support

It generates ETag headers using Asset.etag(). It handles If-None-Match header automatically.

ETag handling is enabled by default. If you want to disabled etag support etag(boolean).

modified since support

It generates Last-Modified header using Asset.lastModified(). It handles If-Modified-Since header automatically.

CDN support

Asset can be serve from a content delivery network (a.k.a cdn). All you have to do is to set the assets.cdn property.

 assets.cdn = "http://http://d7471vfo50fqt.cloudfront.net"
 

Resolved assets are redirected to the cdn.

Since:

0.1.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
AssetHandler(String pattern) Creates a new AssetHandler.
AssetHandler(String pattern, ClassLoader loader) Creates a new AssetHandler.

Method Summary

Modifier and Type	Method and Description
AssetHandler	cdn(String cdn)
AssetHandler	etag(boolean etag)
void	handle(Request req, Response rsp) Callback method for a HTTP request.
AssetHandler	lastModified(boolean enabled)
AssetHandler	maxAge(Duration maxAge)
AssetHandler	maxAge(long maxAge)
protected URL	resolve(String path) Resolve a path as a URL.
protected void	send(Request req, Response rsp, Asset asset) Send an asset to the client.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooby.Route.Handler

handle

Constructor Detail

AssetHandler

public AssetHandler(String pattern,
                    ClassLoader loader)

Creates a new AssetHandler. The handler accepts a location pattern, that serve for locating the static resource.

Given assets("/assets/**", "/") with:

   GET /assets/js/index.js it translates the path to: /assets/js/index.js
 

Given assets("/js/**", "/assets") with:

   GET /js/index.js it translate the path to: /assets/js/index.js
 

Given assets("/webjars/**", "/META-INF/resources/webjars/{0}") with:

   GET /webjars/jquery/2.1.3/jquery.js it translate the path to: /META-INF/resources/webjars/jquery/2.1.3/jquery.js
 

Parameters:

pattern - Pattern to locate static resources.

loader - The one who load the static resources.

AssetHandler

public AssetHandler(String pattern)

Creates a new AssetHandler. The location pattern can be one of.

Given / like in assets("/assets/**", "/") with:

   GET /assets/js/index.js it translates the path to: /assets/js/index.js
 

Given /assets like in assets("/js/**", "/assets") with:

   GET /js/index.js it translate the path to: /assets/js/index.js
 

Given /META-INF/resources/webjars/{0} like in assets("/webjars/**", "/META-INF/resources/webjars/{0}") with:

   GET /webjars/jquery/2.1.3/jquery.js it translate the path to: /META-INF/resources/webjars/jquery/2.1.3/jquery.js
 

Parameters:

pattern - Pattern to locate static resources.

Method Detail

etag

public AssetHandler etag(boolean etag)

Parameters:

etag - Turn on/off etag support.

Returns:

This handler.

lastModified

public AssetHandler lastModified(boolean enabled)

Parameters:

enabled - Turn on/off last modified support.

Returns:

This handler.

cdn

public AssetHandler cdn(String cdn)

Parameters:

cdn - If set, every resolved asset will be serve from it.

Returns:

This handler.

maxAge

public AssetHandler maxAge(Duration maxAge)

Parameters:

maxAge - Set the cache header max-age value.

Returns:

This handler.

maxAge

public AssetHandler maxAge(long maxAge)

Parameters:

maxAge - Set the cache header max-age value in seconds.

Returns:

This handler.

handle

public void handle(Request req,
                   Response rsp)
            throws Throwable

Description copied from interface: Route.Handler

Callback method for a HTTP request.

Specified by:

handle in interface Route.Handler

Parameters:

req - A HTTP request.

rsp - A HTTP response.

Throws:

Throwable - If something goes wrong. The exception will processed by Jooby.

send

protected void send(Request req,
                    Response rsp,
                    Asset asset)
             throws Throwable

Send an asset to the client.

Parameters:

req - Request.

rsp - Response.

asset - Resolve asset.

Throws:

Exception - If send fails.

Throwable

resolve

protected URL resolve(String path)
               throws Exception

Resolve a path as a URL.

Parameters:

path - Path of resource to resolve.

Returns:

A URL or null for unresolved resource.

Throws:

Exception - If something goes wrong.