public class AclFilter extends Filter<AclFilter>
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
Rule.RuleMatcher| Modifier and Type | Field and Description |
|---|---|
protected java.util.List<AclRule> |
aclRules |
ALL_METHODS, configMap, description, excludeMatchers, excludeOn, includeMatchers, includeOn, log, name, order, params| Constructor and Description |
|---|
AclFilter() |
| 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) |
configureOp, doDelete, doGet, doPatch, doPost, doPut, getFullIncludePaths, getIncludePaths, isDecoration, joinPaths, joinPaths0, run0, withDecorationafterWiringComplete, 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, withParamsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddResponse, 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, removeReadOnlyPropertiesprotected final java.util.List<AclRule> aclRules
public AclFilter orRequireAllPerms(java.lang.String ruleMatcherSpec, java.lang.String permission1, java.lang.String... permissionsN)
public AclFilter orRequireOnePerm(java.lang.String ruleMatcherSpec, java.lang.String permission1, java.lang.String... permissionsN)
public AclFilter orRequireAllRoles(java.lang.String ruleMatcherSpec, java.lang.String role1, java.lang.String... rolesN)
public AclFilter orRequireOneRole(java.lang.String ruleMatcherSpec, java.lang.String role1, java.lang.String... rolesN)
public AclFilter orRequireAllScopes(java.lang.String ruleMatcherSpec, java.lang.String scope1, java.lang.String... scopeN)
public AclFilter orRequireOneScope(java.lang.String ruleMatcherSpec, java.lang.String scope1, java.lang.String... scopeN)
public java.util.List<AclRule> getAclRules()
public void run(Request req, Response resp) throws ApiException
Actionrun in class Action<AclFilter>req - the Request being servicedresp - the Reponse being generatedApiExceptionCopyright © 2023 Rocket Partners, LLC. All rights reserved.