io.inversion.action.misc

Class FileAction<A extends FileAction>

java.lang.Object

io.inversion.Rule<A>

io.inversion.Action<A>

io.inversion.action.misc.FileAction<A>

All Implemented Interfaces:

OpenAPIWriter<A>, java.lang.Comparable<A>

Direct Known Subclasses:

OpenAPIAction

public class FileAction<A extends FileAction>
extends Action<A>

Nested Class Summary

Nested classes/interfaces inherited from class io.inversion.Rule

Rule.RuleMatcher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseDir
protected java.util.Set<java.lang.String>	files

Fields inherited from class io.inversion.Rule

ALL_METHODS, configMap, description, excludeMatchers, excludeOn, includeMatchers, includeOn, log, name, order, params

Constructor Summary

Constructors

Constructor and Description
FileAction()

Method Summary

Modifier and Type	Method and Description
boolean	canServe(java.lang.String filePath)
void	doGet(Request req, Response res) Handle an HTTP GET.
protected java.io.InputStream	findStream(java.lang.String filePath)
java.lang.String	getBaseDir()
java.util.Set<java.lang.String>	getFiles()
protected void	serveFile(Request req, Response res)
protected void	serveFile(Request req, Response res, java.lang.String filePath, boolean filterMode)
FileAction	withBaseDir(java.lang.String baseDir)
FileAction	withFiles(java.lang.String... files)

Methods inherited from class io.inversion.Action

configureOp, doDelete, doPatch, doPost, doPut, getFullIncludePaths, getIncludePaths, isDecoration, joinPaths, joinPaths0, run, run0, withDecoration

Methods inherited from class io.inversion.Rule

afterWiringComplete, checkLazyConfig, compareTo, doLazyConfig, getAllExcludePaths, getAllIncludeMethods, getAllIncludePaths, getDefaultIncludeMatchers, getDescription, getExcludeMatchers, getIncludeMatchers, getName, getOrder, getParams, match, match, matches, matches, toString, withDescription, withExcludeOn, withExcludeOn, withIncludeOn, withIncludeOn, withName, withOrder, withParam, withParams

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inversion.action.openapi.OpenAPIWriter

addResponse, addResponse, beautifyTag, buildOperation, documentOpDelete, documentOperationSchema, documentOpFind, documentOpGet, documentOpPatch, documentOpPost, documentOpPut, documentOpRelated, documentParam, documentQueryParams, documentRequestSchema, documentResourceSchema, documentResponseSchema, findOp, getDescription, getSchemaRef, hasParam, hook_documentOp, newComponentRefSchema, newHrefSchema, newTypeSchema, removeReadOnlyProperties

Field Detail

baseDir

protected java.lang.String baseDir

files

protected java.util.Set<java.lang.String> files

Constructor Detail

FileAction

public FileAction()

Method Detail

doGet

public void doGet(Request req,
                  Response res)
           throws ApiException

Description copied from class: Action

Handle an HTTP GET.

Override run() to handle all requests or override this method with your business logic specifically for a GET request

Overrides:

doGet in class Action<A extends FileAction>

Parameters:

req - the request to run

res - the response to populate

Throws:

ApiException

serveFile

protected void serveFile(Request req,
                         Response res)

serveFile

protected void serveFile(Request req,
                         Response res,
                         java.lang.String filePath,
                         boolean filterMode)

findStream

protected java.io.InputStream findStream(java.lang.String filePath)

canServe

public boolean canServe(java.lang.String filePath)

getBaseDir

public java.lang.String getBaseDir()

withBaseDir

public FileAction withBaseDir(java.lang.String baseDir)

getFiles

public java.util.Set<java.lang.String> getFiles()

withFiles

public FileAction withFiles(java.lang.String... files)