io.jooby

Class AssetHandler

java.lang.Object

io.jooby.AssetHandler

All Implemented Interfaces:

Route.Aware, Route.Handler, Serializable

public class AssetHandler
extends Object
implements Route.Handler

Handler for static resources represented by the Asset contract. It has built-in support for static-static as well as SPAs (single page applications).

Since:

2.0.0

Author:

edgar

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AssetHandler(AssetSource... sources) Creates a new asset handler.
AssetHandler(String fallback, AssetSource... sources) Creates a new asset handler that fallback to the given fallback asset when the asset is not found.

Method Summary

Modifier and Type	Method and Description
Object	apply(Context ctx) Execute application code.
AssetHandler	setETag(boolean etag) Turn on/off e-tag support.
AssetHandler	setLastModified(boolean lastModified) Turn on/off handling of If-Modified-Since header.
AssetHandler	setMaxAge(Duration maxAge) Set cache-control header with the given max-age value.
AssetHandler	setMaxAge(long maxAge) Set cache-control header with the given max-age value.
void	setRoute(Route route) Allows a handler to listen for route metadata.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jooby.Route.Handler

then

Constructor Detail

AssetHandler

public AssetHandler(@Nonnull
                    String fallback,
                    AssetSource... sources)

Creates a new asset handler that fallback to the given fallback asset when the asset is not found. Instead of produces a 404 its fallback to the given asset.

 {
    assets("/?*", new AssetHandler("index.html", AssetSource.create(Paths.get("...")));
 }
 

The fallback option makes the asset handler to work like a SPA (Single-Application-Page).

Parameters:

fallback - Fallback asset.

sources - Asset sources.

AssetHandler

public AssetHandler(AssetSource... sources)

Creates a new asset handler.

Parameters:

sources - Asset sources.

Method Detail

apply

@Nonnull
public Object apply(@Nonnull
                             Context ctx)
                      throws Exception

Description copied from interface: Route.Handler

Execute application code.

Specified by:

apply in interface Route.Handler

Parameters:

ctx - Web context.

Returns:

Route response.

Throws:

Exception - If something goes wrong.

setETag

public AssetHandler setETag(boolean etag)

Turn on/off e-tag support.

Parameters:

etag - True for turning on.

Returns:

This handler.

setLastModified

public AssetHandler setLastModified(boolean lastModified)

Turn on/off handling of If-Modified-Since header.

Parameters:

lastModified - True for turning on. Default is: true.

Returns:

This handler.

setMaxAge

public AssetHandler setMaxAge(long maxAge)

Set cache-control header with the given max-age value. If max-age is greater than 0.

Parameters:

maxAge - Max-age value in seconds.

Returns:

This handler.

setMaxAge

public AssetHandler setMaxAge(Duration maxAge)

Set cache-control header with the given max-age value. If max-age is greater than 0.

Parameters:

maxAge - Max-age value in seconds.

Returns:

This handler.

setRoute

public void setRoute(Route route)

Description copied from interface: Route.Aware

Allows a handler to listen for route metadata.

Specified by:

setRoute in interface Route.Aware

Parameters:

route - Route metadata.