Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.authentication.user.top.users

Interface User

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<User>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Users>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<UserKey>
    @Generated("mdsal-binding-generator")
public interface User
extends org.opendaylight.yangtools.yang.binding.ChildOf<Users>, org.opendaylight.yangtools.yang.binding.Augmentable<User>, org.opendaylight.yangtools.yang.binding.Identifiable<UserKey>
    List of local users on the system

    This class represents the following YANG schema fragment defined in module openconfig-aaa 

     list user {
   key username;
   leaf username {
     type leafref {
       path ../config/username;
     }
   }
   container config {
     uses aaa-authentication-user-config;
   }
   container state {
     config false;
     uses aaa-authentication-user-config;
     uses aaa-authentication-user-state;
   }
 }

    To create instances of this class use UserBuilder.

    See Also:
    UserBuilder, UserKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.

    • Method Detail

      • implementedInterface

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

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

      • getUsername

        String getUsername()
        Return username, or null if it is not present. 
             
         References the configured username for the user
        Returns:
        String username, or null if it is not present.

      • requireUsername

        default @NonNull String requireUsername()
        Return username, guaranteed to be non-null. 
             
         References the configured username for the user
        Returns:
        String username, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if username is not present

      • getConfig

        Config getConfig()
        Return config, or null if it is not present. 
             
         Configuration data for local users
        Returns:
        Config config, or null if it is not present.

      • getState

        State getState()
        Return state, or null if it is not present. 
             
         Operational state data for local users
        Returns:
        State state, or null if it is not present.