Rule class abstract

Rule

Properties:

  • authenticators - Authenticators is a list of authentication handlers that will try and authenticate the provided credentials. Authenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive result will be the one used. If you want the rule to first check a specific authenticator before "falling back" to others, have that authenticator as the first item in the array.
  • authorizer
  • description - Description is a human readable description of this rule.
  • id - ID is the unique id of the rule. It can be at most 190 characters long, but the layout of the ID is up to you. You will need this ID later on to update or delete the rule.
  • match
  • mutators - Mutators is a list of mutation handlers that transform the HTTP request. A common use case is generating a new set of credentials (e.g. JWT) which then will be forwarded to the upstream server. Mutations are performed iteratively from index 0 to n and should all succeed in order for the HTTP request to be forwarded.
  • upstream
Annotations
  • @BuiltValue()

Constructors

Rule([void updates(RuleBuilder b)])
factory

Properties

authenticators → BuiltList<RuleHandler>?
Authenticators is a list of authentication handlers that will try and authenticate the provided credentials. Authenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive result will be the one used. If you want the rule to first check a specific authenticator before "falling back" to others, have that authenticator as the first item in the array.
no setter
authorizer → RuleHandler?
no setter
description → String?
Description is a human readable description of this rule.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String?
ID is the unique id of the rule. It can be at most 190 characters long, but the layout of the ID is up to you. You will need this ID later on to update or delete the rule.
no setter
match → RuleMatch?
no setter
mutators → BuiltList<RuleHandler>?
Mutators is a list of mutation handlers that transform the HTTP request. A common use case is generating a new set of credentials (e.g. JWT) which then will be forwarded to the upstream server. Mutations are performed iteratively from index 0 to n and should all succeed in order for the HTTP request to be forwarded.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
upstream → Upstream?
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(RuleBuilder)) → Rule
Rebuilds the instance.
inherited
toBuilder() → RuleBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<Rule>
no setter