io.dropwizard.servlets.assets

Class AssetServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

io.dropwizard.servlets.assets.AssetServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class AssetServlet
extends javax.servlet.http.HttpServlet

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AssetServlet(String resourcePath, String uriPath, String indexFile, Charset defaultCharset) Creates a new AssetServlet that serves static assets loaded from resourceURL (typically a file: or jar: URL).
AssetServlet(String resourcePath, String uriPath, String indexFile, String defaultMediaType, Charset defaultCharset) Creates a new AssetServlet that serves static assets loaded from resourceURL (typically a file: or jar: URL).

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
Charset	getDefaultCharset()
String	getDefaultMediaType()
String	getIndexFile()
URL	getResourceURL()
protected URL	getResourceUrl(String absoluteRequestedResourcePath) Deprecated. use/override getResourceURL(String) instead
protected URL	getResourceURL(String absoluteRequestedResourcePath)
String	getUriPath()
protected byte[]	readResource(URL requestedResourceURL)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetServlet

public AssetServlet(String resourcePath,
                    String uriPath,
                    @Nullable
                    String indexFile,
                    @Nullable
                    Charset defaultCharset)

Creates a new AssetServlet that serves static assets loaded from resourceURL (typically a file: or jar: URL). The assets are served at URIs rooted at uriPath. For example, given a resourceURL of "file:/data/assets" and a uriPath of "/js", an AssetServlet would serve the contents of /data/assets/example.js in response to a request for /js/example.js. If a directory is requested and indexFile is defined, then AssetServlet will attempt to serve a file with that name in that directory. If a directory is requested and indexFile is null, it will serve a 404.

Parameters:

resourcePath - the base URL from which assets are loaded

uriPath - the URI path fragment in which all requests are rooted

indexFile - the filename to use when directories are requested, or null to serve no indexes

defaultCharset - the default character set

AssetServlet

public AssetServlet(String resourcePath,
                    String uriPath,
                    @Nullable
                    String indexFile,
                    @Nullable
                    String defaultMediaType,
                    @Nullable
                    Charset defaultCharset)

Creates a new AssetServlet that serves static assets loaded from resourceURL (typically a file: or jar: URL). The assets are served at URIs rooted at uriPath. For example, given a resourceURL of "file:/data/assets" and a uriPath of "/js", an AssetServlet would serve the contents of /data/assets/example.js in response to a request for /js/example.js. If a directory is requested and indexFile is defined, then AssetServlet will attempt to serve a file with that name in that directory. If a directory is requested and indexFile is null, it will serve a 404.

Parameters:

resourcePath - the base URL from which assets are loaded

uriPath - the URI path fragment in which all requests are rooted

indexFile - the filename to use when directories are requested, or null to serve no indexes

defaultMediaType - the default media type

defaultCharset - the default character set

Since:

2.0

Method Detail

getResourceURL

public URL getResourceURL()

getUriPath

public String getUriPath()

getIndexFile

@Nullable
public String getIndexFile()

getDefaultMediaType

public String getDefaultMediaType()

Since:

2.0

getDefaultCharset

@Nullable
public Charset getDefaultCharset()

Since:

2.0

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse resp)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

getResourceUrl

@Deprecated
protected URL getResourceUrl(String absoluteRequestedResourcePath)

Deprecated. use/override getResourceURL(String) instead

getResourceURL

protected URL getResourceURL(String absoluteRequestedResourcePath)

readResource

protected byte[] readResource(URL requestedResourceURL)
                       throws IOException

Throws:

IOException