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

Interface Nacm

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Nacm>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<IetfNetconfAcmData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface Nacm
extends org.opendaylight.yangtools.yang.binding.ChildOf<IetfNetconfAcmData>, org.opendaylight.yangtools.yang.binding.Augmentable<Nacm>
    Parameters for NETCONF access control model.

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

     container nacm {
   nacm:default-deny-all;
   leaf enable-nacm {
     type boolean;
     default true;
   }
   leaf read-default {
     type action-type;
     default permit;
   }
   leaf write-default {
     type action-type;
     default deny;
   }
   leaf exec-default {
     type action-type;
     default permit;
   }
   leaf enable-external-groups {
     type boolean;
     default true;
   }
   leaf denied-operations {
     type yang:zero-based-counter32;
     config false;
   }
   leaf denied-data-writes {
     type yang:zero-based-counter32;
     config false;
   }
   leaf denied-notifications {
     type yang:zero-based-counter32;
     config false;
   }
   container groups {
     list group {
       key name;
       leaf name {
         type group-name-type;
       }
       leaf-list user-name {
         type user-name-type;
       }
     }
   }
   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-acmnacm

    To create instances of this class use NacmBuilder.

    See Also:
    NacmBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<Nacm> 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 Nacm 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 Nacm 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 Nacm 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

      • getEnableNacm

        Boolean getEnableNacm()
        Return enableNacm, or null if it is not present. 
             
         Enables or disables all NETCONF access control enforcement. If 'true', then
         enforcement is enabled. If 'false', then enforcement is disabled.
        Returns:
        Boolean enableNacm, or null if it is not present.

      • requireEnableNacm

        default @NonNull Boolean requireEnableNacm()
        Return enableNacm, guaranteed to be non-null. 
             
         Enables or disables all NETCONF access control enforcement. If 'true', then
         enforcement is enabled. If 'false', then enforcement is disabled.
        Returns:
        Boolean enableNacm, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if enableNacm is not present

      • getReadDefault

        ActionType getReadDefault()
        Return readDefault, or null if it is not present. 
             
         Controls whether read access is granted if no appropriate rule is found for a
         particular read request.
        Returns:
        ActionType readDefault, or null if it is not present.

      • requireReadDefault

        default @NonNull ActionType requireReadDefault()
        Return readDefault, guaranteed to be non-null. 
             
         Controls whether read access is granted if no appropriate rule is found for a
         particular read request.
        Returns:
        ActionType readDefault, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if readDefault is not present

      • getWriteDefault

        ActionType getWriteDefault()
        Return writeDefault, or null if it is not present. 
             
         Controls whether create, update, or delete access is granted if no appropriate
         rule is found for a particular write request.
        Returns:
        ActionType writeDefault, or null if it is not present.

      • requireWriteDefault

        default @NonNull ActionType requireWriteDefault()
        Return writeDefault, guaranteed to be non-null. 
             
         Controls whether create, update, or delete access is granted if no appropriate
         rule is found for a particular write request.
        Returns:
        ActionType writeDefault, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if writeDefault is not present

      • getExecDefault

        ActionType getExecDefault()
        Return execDefault, or null if it is not present. 
             
         Controls whether exec access is granted if no appropriate rule is found for a
         particular protocol operation request.
        Returns:
        ActionType execDefault, or null if it is not present.

      • requireExecDefault

        default @NonNull ActionType requireExecDefault()
        Return execDefault, guaranteed to be non-null. 
             
         Controls whether exec access is granted if no appropriate rule is found for a
         particular protocol operation request.
        Returns:
        ActionType execDefault, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if execDefault is not present

      • getEnableExternalGroups

        Boolean getEnableExternalGroups()
        Return enableExternalGroups, or null if it is not present. 
             
         Controls whether the server uses the groups reported by the NETCONF transport
         layer when it assigns the user to a set of NACM groups. If this leaf has the
         value 'false', any group names reported by the transport layer are ignored by
         the server.
        Returns:
        Boolean enableExternalGroups, or null if it is not present.

      • requireEnableExternalGroups

        default @NonNull Boolean requireEnableExternalGroups()
        Return enableExternalGroups, guaranteed to be non-null. 
             
         Controls whether the server uses the groups reported by the NETCONF transport
         layer when it assigns the user to a set of NACM groups. If this leaf has the
         value 'false', any group names reported by the transport layer are ignored by
         the server.
        Returns:
        Boolean enableExternalGroups, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if enableExternalGroups is not present

      • getDeniedOperations

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.ZeroBasedCounter32 getDeniedOperations()
        Return deniedOperations, or null if it is not present. 
             
         Number of times since the server last restarted that a protocol operation
         request was denied.
        Returns:
        ZeroBasedCounter32 deniedOperations, or null if it is not present.

      • requireDeniedOperations

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.ZeroBasedCounter32 requireDeniedOperations()
        Return deniedOperations, guaranteed to be non-null. 
             
         Number of times since the server last restarted that a protocol operation
         request was denied.
        Returns:
        ZeroBasedCounter32 deniedOperations, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if deniedOperations is not present

      • getDeniedDataWrites

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.ZeroBasedCounter32 getDeniedDataWrites()
        Return deniedDataWrites, or null if it is not present. 
             
         Number of times since the server last restarted that a protocol operation
         request to alter a configuration datastore was denied.
        Returns:
        ZeroBasedCounter32 deniedDataWrites, or null if it is not present.

      • requireDeniedDataWrites

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.ZeroBasedCounter32 requireDeniedDataWrites()
        Return deniedDataWrites, guaranteed to be non-null. 
             
         Number of times since the server last restarted that a protocol operation
         request to alter a configuration datastore was denied.
        Returns:
        ZeroBasedCounter32 deniedDataWrites, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if deniedDataWrites is not present

      • getDeniedNotifications

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.ZeroBasedCounter32 getDeniedNotifications()
        Return deniedNotifications, or null if it is not present. 
             
         Number of times since the server last restarted that a notification was dropped
         for a subscription because access to the event type was denied.
        Returns:
        ZeroBasedCounter32 deniedNotifications, or null if it is not present.

      • requireDeniedNotifications

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.ZeroBasedCounter32 requireDeniedNotifications()
        Return deniedNotifications, guaranteed to be non-null. 
             
         Number of times since the server last restarted that a notification was dropped
         for a subscription because access to the event type was denied.
        Returns:
        ZeroBasedCounter32 deniedNotifications, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if deniedNotifications is not present

      • getGroups

        Groups getGroups()
        Return groups, or null if it is not present. 
             
         NETCONF access control groups.
        Returns:
        Groups groups, or null if it is not present.

      • getRuleList

        @Nullable List<RuleList> getRuleList()
        Return ruleList, or null if it is not present. 
             
         An ordered collection of access control rules.
        Returns:
        List<RuleList> ruleList, or null if it is not present.

      • nonnullRuleList

        default @NonNull List<RuleList> nonnullRuleList()
        Return ruleList, or an empty list if it is not present.
        Returns:
        List<RuleList> ruleList, or an empty list if it is not present.