net.leanix.dropkit.swagger

Class ApiDocsAssetServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

net.leanix.dropkit.swagger.ApiDocsAssetServlet

All Implemented Interfaces:

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

public class ApiDocsAssetServlet
extends javax.servlet.http.HttpServlet

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
String	getIndexFile()
URL	getResourceURL()
String	getUriPath()

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

ApiDocsAssetServlet

public ApiDocsAssetServlet(String resourcePath,
                   String uriPath,
                   String indexFile,
                   Charset defaultCharset,
                   String basePath)

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

basePath - the basePath to be used for swagger - if none is given, then derive basePath from current request

Method Detail

getResourceURL

public URL getResourceURL()

getUriPath

public String getUriPath()

getIndexFile

public String getIndexFile()

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