Package dev.voidframework.web.http.controller

Class AbstractStaticAssetsController

java.lang.Object

dev.voidframework.web.http.controller.AbstractStaticAssetsController

All Implemented Interfaces:

HttpContentType

public abstract class AbstractStaticAssetsController
extends Object
implements HttpContentType

Abstraction to facilitate the use of static and webjar assets.

Field Summary

Fields inherited from interface dev.voidframework.web.http.HttpContentType

APPLICATION_JSON, APPLICATION_OCTET_STREAM, APPLICATION_X_FORM_URLENCODED, APPLICATION_XML, APPLICATION_ZIP, IMAGE_ICON, IMAGE_JPEG, IMAGE_PNG, MULTIPART_FORM_DATA, TEXT_HTML, TEXT_YAML

Constructor Summary

Constructors

Constructor	Description
AbstractStaticAssetsController(com.typesafe.config.Config configuration)	Build a new instance;

Method Summary

Modifier and Type	Method	Description
Result	staticAsset(Context context)	Retrieves a static asset.
Result	staticAsset(String fileName)	Retrieves a static asset.
Result	webjarAsset(String fileName)	Retrieves a webjar asset.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractStaticAssetsController

@Inject
public AbstractStaticAssetsController(com.typesafe.config.Config configuration)

Build a new instance;

Parameters:

configuration - The application configuration

Method Details

webjarAsset

@NoCSRF
@RequestRoute(method=GET,
              route="/webjars/(?<fileName>.*)")
public Result webjarAsset(@RequestPath("fileName")
 String fileName)

Retrieves a webjar asset.

Parameters:

fileName - Requested webjar asset file name

Returns:

A result containing the requested webjar asset

Throws:

HttpException.NotFound - If requested asset does not exist

staticAsset

@NoCSRF
@RequestRoute(method=GET,
              route="/(favicon.ico|robots.txt)")
public Result staticAsset(Context context)

Retrieves a static asset.

Parameters:

context - The current context

Returns:

A result containing the requested static asset

Throws:

HttpException.NotFound - If requested asset does not exist

staticAsset

@NoCSRF
@RequestRoute(method=GET,
              route="/static/(?<fileName>.*)")
public Result staticAsset(@RequestPath("fileName")
 String fileName)

Retrieves a static asset.

Parameters:

fileName - Requested static asset file name

Returns:

A result containing the requested static asset

Throws:

HttpException.NotFound - If requested asset does not exist