Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.aaa.rev161214

Interface User

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Users
@Generated("mdsal-binding-generator") public interface User extends org.opendaylight.yangtools.yang.binding.DataObject

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

 grouping user {
   leaf userid {
     type string;
   }
   leaf name {
     type string;
   }
   leaf description {
     type string;
     default "";
   }
   leaf enabled {
     type boolean;
     default true;
   }
   leaf email {
     type string;
     default "";
   }
   leaf password {
     type string;
   }
   leaf salt {
     type string;
   }
   leaf domainid {
     type string;
   }
 }

  • Field Details

    • QNAME

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

  • Method Details

    • implementedInterface

      Class<? extends User> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getUserid

      String getUserid()
      Return userid, or null if it is not present. 
           
         An internal wiring detail in the form 'name@domain'.
      Returns:
      String userid, or null if it is not present.

    • requireUserid

      default @NonNull String requireUserid()
      Return userid, guaranteed to be non-null. 
           
         An internal wiring detail in the form 'name@domain'.
      Returns:
      String userid, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if userid is not present

    • getName

      String getName()
      Return name, or null if it is not present. 
           
         The name of the user.
      Returns:
      String name, or null if it is not present.

    • requireName

      default @NonNull String requireName()
      Return name, guaranteed to be non-null. 
           
         The name of the user.
      Returns:
      String name, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if name is not present

    • getDescription

      String getDescription()
      Return description, or null if it is not present. 
           
         A description for the user; defaults to the empty string.
      Returns:
      String description, or null if it is not present.

    • requireDescription

      default @NonNull String requireDescription()
      Return description, guaranteed to be non-null. 
           
         A description for the user; defaults to the empty string.
      Returns:
      String description, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if description is not present

    • getEnabled

      Boolean getEnabled()
      Return enabled, or null if it is not present. 
           
         Whether or not the user is enabled; defaults to true.
      Returns:
      Boolean enabled, or null if it is not present.

    • requireEnabled

      default @NonNull Boolean requireEnabled()
      Return enabled, guaranteed to be non-null. 
           
         Whether or not the user is enabled; defaults to true.
      Returns:
      Boolean enabled, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if enabled is not present

    • getEmail

      String getEmail()
      Return email, or null if it is not present. 
           
         An email address for the user; defaults to the empty string.
      Returns:
      String email, or null if it is not present.

    • requireEmail

      default @NonNull String requireEmail()
      Return email, guaranteed to be non-null. 
           
         An email address for the user; defaults to the empty string.
      Returns:
      String email, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if email is not present

    • getPassword

      String getPassword()
      Return password, or null if it is not present. 
           
         A one-way hashed and salted version of the users password.
      Returns:
      String password, or null if it is not present.

    • requirePassword

      default @NonNull String requirePassword()
      Return password, guaranteed to be non-null. 
           
         A one-way hashed and salted version of the users password.
      Returns:
      String password, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if password is not present

    • getSalt

      String getSalt()
      Return salt, or null if it is not present. 
           
         A user-specific salt used for password hashing.
      Returns:
      String salt, or null if it is not present.

    • requireSalt

      default @NonNull String requireSalt()
      Return salt, guaranteed to be non-null. 
           
         A user-specific salt used for password hashing.
      Returns:
      String salt, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if salt is not present

    • getDomainid

      String getDomainid()
      Return domainid, or null if it is not present. 
           
         The domain to which the user belongs.
      Returns:
      String domainid, or null if it is not present.

    • requireDomainid

      default @NonNull String requireDomainid()
      Return domainid, guaranteed to be non-null. 
           
         The domain to which the user belongs.
      Returns:
      String domainid, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if domainid is not present