Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.nat.traversal

Interface NatTraversal

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<NatTraversal>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<LispAddress>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface NatTraversal
extends org.opendaylight.yangtools.yang.binding.ChildOf<LispAddress>, org.opendaylight.yangtools.yang.binding.Augmentable<NatTraversal>
    NAT-Traversal LCAF type.

    This class represents the following YANG schema fragment defined in module ietf-lisp-address-types 

     container nat-traversal {
   when "../address-type = 'laddr:nat-traversal-lcaf'" {
   }
   leaf ms-udp-port {
     type uint16;
   }
   leaf etr-udp-port {
     type uint16;
   }
   leaf global-etr-rloc {
     type simple-address;
   }
   leaf ms-rloc {
     type simple-address;
   }
   leaf private-etr-rloc {
     type simple-address;
   }
   leaf-list rtr-rlocs {
     type simple-address;
   }
 }

    To create instances of this class use NatTraversalBuilder.

    See Also:
    NatTraversalBuilder

    • 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 java.lang.Class<NatTraversal> 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 NatTraversal 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:
        java.lang.NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull NatTraversal thisObj,
                             java.lang.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:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull NatTraversal 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:
        java.lang.NullPointerException - if obj is null

      • getMsUdpPort

        org.opendaylight.yangtools.yang.common.Uint16 getMsUdpPort()
        Return msUdpPort, or null if it is not present. 
             
         Map-Server UDP port (set to 4342).
        Returns:
        Uint16 msUdpPort, or null if it is not present.

      • requireMsUdpPort

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireMsUdpPort()
        Return msUdpPort, guaranteed to be non-null. 
             
         Map-Server UDP port (set to 4342).
        Returns:
        Uint16 msUdpPort, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if msUdpPort is not present

      • getEtrUdpPort

        org.opendaylight.yangtools.yang.common.Uint16 getEtrUdpPort()
        Return etrUdpPort, or null if it is not present. 
             
         ETR UDP port.
        Returns:
        Uint16 etrUdpPort, or null if it is not present.

      • requireEtrUdpPort

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireEtrUdpPort()
        Return etrUdpPort, guaranteed to be non-null. 
             
         ETR UDP port.
        Returns:
        Uint16 etrUdpPort, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if etrUdpPort is not present

      • getGlobalEtrRloc

        SimpleAddress getGlobalEtrRloc()
        Return globalEtrRloc, or null if it is not present. 
             
         Global ETR RLOC address.
        Returns:
        SimpleAddress globalEtrRloc, or null if it is not present.

      • requireGlobalEtrRloc

        default @NonNull SimpleAddress requireGlobalEtrRloc()
        Return globalEtrRloc, guaranteed to be non-null. 
             
         Global ETR RLOC address.
        Returns:
        SimpleAddress globalEtrRloc, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if globalEtrRloc is not present

      • getMsRloc

        SimpleAddress getMsRloc()
        Return msRloc, or null if it is not present. 
             
         Map-Server RLOC address.
        Returns:
        SimpleAddress msRloc, or null if it is not present.

      • requireMsRloc

        default @NonNull SimpleAddress requireMsRloc()
        Return msRloc, guaranteed to be non-null. 
             
         Map-Server RLOC address.
        Returns:
        SimpleAddress msRloc, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if msRloc is not present

      • getPrivateEtrRloc

        SimpleAddress getPrivateEtrRloc()
        Return privateEtrRloc, or null if it is not present. 
             
         Private ETR RLOC address.
        Returns:
        SimpleAddress privateEtrRloc, or null if it is not present.

      • requirePrivateEtrRloc

        default @NonNull SimpleAddress requirePrivateEtrRloc()
        Return privateEtrRloc, guaranteed to be non-null. 
             
         Private ETR RLOC address.
        Returns:
        SimpleAddress privateEtrRloc, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if privateEtrRloc is not present

      • getRtrRlocs

        @Nullable java.util.Set<SimpleAddress> getRtrRlocs()
        Return rtrRlocs, or null if it is not present. 
             
         List of RTR RLOC addresses.
        Returns:
        Set<SimpleAddress> rtrRlocs, or null if it is not present.

      • requireRtrRlocs

        default @NonNull java.util.Set<SimpleAddress> requireRtrRlocs()
        Return rtrRlocs, guaranteed to be non-null. 
             
         List of RTR RLOC addresses.
        Returns:
        Set<SimpleAddress> rtrRlocs, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if rtrRlocs is not present