Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.acm.rev180214.nacm

Interface RuleList

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<RuleList>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Nacm>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<RuleListKey>
    @Generated("mdsal-binding-generator")
public interface RuleList
extends org.opendaylight.yangtools.yang.binding.ChildOf<Nacm>, org.opendaylight.yangtools.yang.binding.Augmentable<RuleList>, org.opendaylight.yangtools.yang.binding.Identifiable<RuleListKey>
    An ordered collection of access control rules.

    This class represents the following YANG schema fragment defined in module ietf-netconf-acm 

     list rule-list {
   key name;
   ordered-by user;
   leaf name {
     type string {
       length 1..max;
     }
   }
   leaf-list group {
     type union {
       type matchall-string-type;
       type group-name-type;
     }
   }
   list rule {
     key name;
     ordered-by user;
     leaf name {
       type string {
         length 1..max;
       }
     }
     leaf module-name {
       type union {
         type matchall-string-type;
         type string;
       }
       default *;
     }
     choice rule-type {
       case protocol-operation {
         leaf rpc-name {
           type union {
             type matchall-string-type;
             type string;
           }
         }
       }
       case notification {
         leaf notification-name {
           type union {
             type matchall-string-type;
             type string;
           }
         }
       }
       case data-node {
         leaf path {
           type node-instance-identifier;
         }
       }
     }
     leaf access-operations {
       type union {
         type matchall-string-type;
         type access-operations-type;
       }
       default *;
     }
     leaf action {
       type action-type;
     }
     leaf comment {
       type string;
     }
   }
 }
    The schema path to identify an instance is ietf-netconf-acmnacmrule-list

    To create instances of this class use RuleListBuilder.

    See Also:
    RuleListBuilder, RuleListKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        default Class<RuleList> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull RuleList obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull RuleList thisObj,
                             Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull RuleList obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • key

        RuleListKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<RuleListKey>

      • getName

        String getName()
        Return name, or null if it is not present. 
             
         Arbitrary name assigned to the rule-list.
        Returns:
        String name, or null if it is not present.

      • requireName

        default @NonNull String requireName()
        Return name, guaranteed to be non-null. 
             
         Arbitrary name assigned to the rule-list.
        Returns:
        String name, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if name is not present

      • getGroup

        @Nullable List<RuleList.Group> getGroup()
        Return group, or null if it is not present. 
             
         List of administrative groups that will be assigned the associated access rights
         defined by the 'rule' list. The string '*' indicates that all groups apply to
         the entry.
        Returns:
        List<Group> group, or null if it is not present.

      • requireGroup

        default @NonNull List<RuleList.Group> requireGroup()
        Return group, guaranteed to be non-null. 
             
         List of administrative groups that will be assigned the associated access rights
         defined by the 'rule' list. The string '*' indicates that all groups apply to
         the entry.
        Returns:
        List<Group> group, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if group is not present

      • getRule

        @Nullable List<Rule> getRule()
        Return rule, or null if it is not present. 
             
         One access control rule. Rules are processed in user-defined order until a match
         is found. A rule matches if 'module-name', 'rule-type', and 'access-operations'
         match the request. If a rule matches, the 'action' leaf determines whether or
         not access is granted.
        Returns:
        List<Rule> rule, or null if it is not present.

      • nonnullRule

        default @NonNull List<Rule> nonnullRule()
        Return rule, or an empty list if it is not present.
        Returns:
        List<Rule> rule, or an empty list if it is not present.