io.inversion.action.security

Class AclFilter

java.lang.Object

io.inversion.Rule<A>

io.inversion.Action<A>

io.inversion.Filter<AclFilter>

io.inversion.action.security.AclFilter

All Implemented Interfaces:

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

public class AclFilter
extends Filter<AclFilter>

The AclAction secures an API by making sure that a requests matches one or more declared AclRules

AclRules specify the roles and permissions that a user must have to access specific method/path combinations and can also specify input/output parameters that are either required or restricted

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.util.List<AclRule>	aclRules

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

Method Summary

Modifier and Type	Method and Description
java.util.List<AclRule>	getAclRules()
AclFilter	orRequireAllPerms(java.lang.String ruleMatcherSpec, java.lang.String permission1, java.lang.String... permissionsN)
AclFilter	orRequireAllRoles(java.lang.String ruleMatcherSpec, java.lang.String role1, java.lang.String... rolesN)
AclFilter	orRequireAllScopes(java.lang.String ruleMatcherSpec, java.lang.String scope1, java.lang.String... scopeN)
AclFilter	orRequireOnePerm(java.lang.String ruleMatcherSpec, java.lang.String permission1, java.lang.String... permissionsN)
AclFilter	orRequireOneRole(java.lang.String ruleMatcherSpec, java.lang.String role1, java.lang.String... rolesN)
AclFilter	orRequireOneScope(java.lang.String ruleMatcherSpec, java.lang.String scope1, java.lang.String... scopeN)
void	run(Request req, Response resp) Override this method with your custom business logic or override one of the http method "doMETHOD" specific handlers.
AclFilter	withAclRules(AclRule... acls)

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, hook_documentOp, newComponentRefSchema, newHrefSchema, newTypeSchema, removeReadOnlyProperties

Field Detail

aclRules

protected final java.util.List<AclRule> aclRules

Constructor Detail

AclFilter

public AclFilter()

Method Detail

orRequireAllPerms

public AclFilter orRequireAllPerms(java.lang.String ruleMatcherSpec,
                                   java.lang.String permission1,
                                   java.lang.String... permissionsN)

orRequireOnePerm

public AclFilter orRequireOnePerm(java.lang.String ruleMatcherSpec,
                                  java.lang.String permission1,
                                  java.lang.String... permissionsN)

orRequireAllRoles

public AclFilter orRequireAllRoles(java.lang.String ruleMatcherSpec,
                                   java.lang.String role1,
                                   java.lang.String... rolesN)

orRequireOneRole

public AclFilter orRequireOneRole(java.lang.String ruleMatcherSpec,
                                  java.lang.String role1,
                                  java.lang.String... rolesN)

orRequireAllScopes

public AclFilter orRequireAllScopes(java.lang.String ruleMatcherSpec,
                                    java.lang.String scope1,
                                    java.lang.String... scopeN)

orRequireOneScope

public AclFilter orRequireOneScope(java.lang.String ruleMatcherSpec,
                                   java.lang.String scope1,
                                   java.lang.String... scopeN)

withAclRules

public AclFilter withAclRules(AclRule... acls)

getAclRules

public java.util.List<AclRule> getAclRules()

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<AclFilter>

Parameters:

req - the Request being serviced

resp - the Reponse being generated

Throws:

ApiException