io.dropwizard.bundles.webjars

Class WebJarServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

io.dropwizard.bundles.webjars.WebJarServlet

All Implemented Interfaces:

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

public class WebJarServlet
extends javax.servlet.http.HttpServlet

A servlet that will load resources from WebJars found in the classpath. In order to make it more convenient to use a WebJar, this servlet will automatically determine the version of the WebJar present in the classpath and make it so that you don't need to explicitly specify a version number as part of the URL. This allows WebJars to be upgraded entirely via maven dependencies without having to update all of the references to the WebJar in your UI code.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_MAVEN_GROUPS The default maven group(s) that WebJars are searched for in.
static String	DEFAULT_URL_PREFIX The default URL prefix that webjars are served out of.

Constructor Summary

Constructors

Constructor and Description
WebJarServlet(com.google.common.cache.CacheBuilder<io.dropwizard.bundles.webjars.AssetId,io.dropwizard.bundles.webjars.Asset> builder, Iterable<String> groups, String urlPrefix) Construct the actual servlet that this bundle will install.

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)

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

Field Detail

DEFAULT_URL_PREFIX

public static final String DEFAULT_URL_PREFIX

The default URL prefix that webjars are served out of.

See Also:

Constant Field Values

DEFAULT_MAVEN_GROUPS

public static final String[] DEFAULT_MAVEN_GROUPS

The default maven group(s) that WebJars are searched for in.

Constructor Detail

WebJarServlet

public WebJarServlet(com.google.common.cache.CacheBuilder<io.dropwizard.bundles.webjars.AssetId,io.dropwizard.bundles.webjars.Asset> builder,
                     Iterable<String> groups,
                     String urlPrefix)

Construct the actual servlet that this bundle will install.

Parameters:

builder - The cache definition for our webjar bundle.

groups - The allowed maven groups of webjars to look for and match against.

Method Detail

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