io.dropwizard.assets

Class AssetsBundle

java.lang.Object

io.dropwizard.assets.AssetsBundle

All Implemented Interfaces:

Bundle

public class AssetsBundle
extends Object
implements Bundle

A bundle for serving static asset files from the classpath.

Constructor Summary

Constructors

Constructor and Description
AssetsBundle() Creates a new AssetsBundle which serves up static assets from src/main/resources/assets/* as /assets/*.
AssetsBundle(String path) Creates a new AssetsBundle which will configure the application to serve the static files located in src/main/resources/${path} as /${path}.
AssetsBundle(String resourcePath, String uriPath) Creates a new AssetsBundle which will configure the application to serve the static files located in src/main/resources/${resourcePath} as /${uriPath}.
AssetsBundle(String resourcePath, String uriPath, String indexFile) Creates a new AssetsBundle which will configure the application to serve the static files located in src/main/resources/${resourcePath} as /${uriPath}.
AssetsBundle(String resourcePath, String uriPath, String indexFile, String assetsName) Creates a new AssetsBundle which will configure the application to serve the static files located in src/main/resources/${resourcePath} as /${uriPath}.

Method Summary

Modifier and Type	Method and Description
protected AssetServlet	createServlet()
String	getIndexFile()
String	getResourcePath()
String	getUriPath()
void	initialize(Bootstrap<?> bootstrap)
void	run(Environment environment)

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetsBundle

public AssetsBundle()

Creates a new AssetsBundle which serves up static assets from src/main/resources/assets/* as /assets/*.

See Also:

AssetsBundle(String, String, String)

AssetsBundle

public AssetsBundle(String path)

Creates a new AssetsBundle which will configure the application to serve the static files located in src/main/resources/${path} as /${path}. For example, given a path of "/assets", src/main/resources/assets/example.js would be served up from /assets/example.js.

Parameters:

path - the classpath and URI root of the static asset files

See Also:

AssetsBundle(String, String, String)

AssetsBundle

public AssetsBundle(String resourcePath,
                    String uriPath)

Creates a new AssetsBundle which will configure the application to serve the static files located in src/main/resources/${resourcePath} as /${uriPath}. For example, given a resourcePath of "/assets" and a uriPath of "/js", src/main/resources/assets/example.js would be served up from /js/example.js.

Parameters:

resourcePath - the resource path (in the classpath) of the static asset files

uriPath - the uri path for the static asset files

See Also:

AssetsBundle(String, String, String)

AssetsBundle

public AssetsBundle(String resourcePath,
                    String uriPath,
                    String indexFile)

Creates a new AssetsBundle which will configure the application to serve the static files located in src/main/resources/${resourcePath} as /${uriPath}. If no file name is in ${uriPath}, ${indexFile} is appended before serving. For example, given a resourcePath of "/assets" and a uriPath of "/js", src/main/resources/assets/example.js would be served up from /js/example.js.

Parameters:

resourcePath - the resource path (in the classpath) of the static asset files

uriPath - the uri path for the static asset files

indexFile - the name of the index file to use

AssetsBundle

public AssetsBundle(String resourcePath,
                    String uriPath,
                    String indexFile,
                    String assetsName)

Creates a new AssetsBundle which will configure the application to serve the static files located in src/main/resources/${resourcePath} as /${uriPath}. If no file name is in ${uriPath}, ${indexFile} is appended before serving. For example, given a resourcePath of "/assets" and a uriPath of "/js", src/main/resources/assets/example.js would be served up from /js/example.js.

Parameters:

resourcePath - the resource path (in the classpath) of the static asset files

uriPath - the uri path for the static asset files

indexFile - the name of the index file to use

assetsName - the name of servlet mapping used for this assets bundle

Method Detail

initialize

public void initialize(Bootstrap<?> bootstrap)

Specified by:

initialize in interface Bundle

run

public void run(Environment environment)

Specified by:

run in interface Bundle

getResourcePath

public String getResourcePath()

getUriPath

public String getUriPath()

getIndexFile

public String getIndexFile()

createServlet

protected AssetServlet createServlet()