io.inversion.action.security

Class AuthFilter

java.lang.Object

io.inversion.Rule<A>

io.inversion.Action<A>

io.inversion.Filter<AuthFilter>

io.inversion.action.security.AuthFilter

All Implemented Interfaces:

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

public class AuthFilter
extends Filter<AuthFilter>

Nested Class Summary

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

Rule.RuleMatcher

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTH_ACTION_DEFAULT_ORDER_IS_100
protected java.util.List<AuthScheme>	schemes

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
AuthFilter()

Method Summary

Modifier and Type	Method and Description
protected void	documentSecurity(io.swagger.v3.oas.models.OpenAPI openApi, Op op)
java.util.List<AuthScheme>	getAuthSchemes()
io.swagger.v3.oas.models.Operation	hook_documentOp(io.inversion.utils.Task docChain, io.swagger.v3.oas.models.OpenAPI openApi, java.util.List<Op> ops, Op op, java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)
void	run(Request req, Response resp) Override this method with your custom business logic or override one of the http method "doMETHOD" specific handlers.
AuthFilter	withAuthScheme(AuthScheme scheme)
AuthFilter	withAuthSchemes(java.util.List<AuthScheme> schemes)

Methods inherited from class io.inversion.Action

configureOp, doDelete, doGet, doPatch, doPost, doPut, getFullIncludePaths, getIncludePaths, isDecoration, joinPaths, joinPaths0, 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, newComponentRefSchema, newHrefSchema, newTypeSchema, removeReadOnlyProperties

Field Detail

AUTH_ACTION_DEFAULT_ORDER_IS_100

public static final int AUTH_ACTION_DEFAULT_ORDER_IS_100

See Also:

Constant Field Values

schemes

protected java.util.List<AuthScheme> schemes

Constructor Detail

AuthFilter

public AuthFilter()

Method Detail

run

public void run(Request req,
                Response resp)
         throws ApiException

Description copied from class: Action

Override this method with your custom business logic or override one of the http method "doMETHOD" specific handlers.

Overrides:

run in class Action<AuthFilter>

Parameters:

req - the Request being serviced

resp - the Reponse being generated

Throws:

ApiException

getAuthSchemes

public java.util.List<AuthScheme> getAuthSchemes()

withAuthSchemes

public AuthFilter withAuthSchemes(java.util.List<AuthScheme> schemes)

withAuthScheme

public AuthFilter withAuthScheme(AuthScheme scheme)

hook_documentOp

public io.swagger.v3.oas.models.Operation hook_documentOp(io.inversion.utils.Task docChain,
                                                          io.swagger.v3.oas.models.OpenAPI openApi,
                                                          java.util.List<Op> ops,
                                                          Op op,
                                                          java.util.Map<java.lang.Object,io.swagger.v3.oas.models.media.Schema> schemas)

documentSecurity

protected void documentSecurity(io.swagger.v3.oas.models.OpenAPI openApi,
                                Op op)