Class SubjectRulesReviewStatus

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model

    public class SubjectRulesReviewStatus
    extends java.lang.Object
    implements com.marcnuri.yakc.model.Model
    SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.
    • Constructor Detail

      • SubjectRulesReviewStatus

        public SubjectRulesReviewStatus​(java.lang.String evaluationError,
                                        @NonNull
                                        @NonNull java.lang.Boolean incomplete,
                                        @NonNull
                                        @NonNull java.util.List<NonResourceRule> nonResourceRules,
                                        @NonNull
                                        @NonNull java.util.List<ResourceRule> resourceRules)
      • SubjectRulesReviewStatus

        public SubjectRulesReviewStatus()
    • Method Detail

      • getEvaluationError

        public java.lang.String getEvaluationError()
        EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
      • getIncomplete

        @NonNull
        public @NonNull java.lang.Boolean getIncomplete()
        Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
      • getNonResourceRules

        @NonNull
        public @NonNull java.util.List<NonResourceRule> getNonResourceRules()
        NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
      • getResourceRules

        @NonNull
        public @NonNull java.util.List<ResourceRule> getResourceRules()
        ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
      • setEvaluationError

        public void setEvaluationError​(java.lang.String evaluationError)
        EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
      • setIncomplete

        public void setIncomplete​(@NonNull
                                  @NonNull java.lang.Boolean incomplete)
        Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
      • setNonResourceRules

        public void setNonResourceRules​(@NonNull
                                        @NonNull java.util.List<NonResourceRule> nonResourceRules)
        NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
      • setResourceRules

        public void setResourceRules​(@NonNull
                                     @NonNull java.util.List<ResourceRule> resourceRules)
        ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • canEqual

        protected boolean canEqual​(java.lang.Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object