Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow._switch.connection.config.rev160506

Interface SwitchConnectionConfig

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<SwitchConnectionConfig>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OpenflowSwitchConnectionConfigData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<SwitchConnectionConfigKey>
@Generated("mdsal-binding-generator") public interface SwitchConnectionConfig extends org.opendaylight.yangtools.yang.binding.ChildOf<OpenflowSwitchConnectionConfigData>, org.opendaylight.yangtools.yang.binding.Augmentable<SwitchConnectionConfig>, org.opendaylight.yangtools.yang.binding.Identifiable<SwitchConnectionConfigKey>

This class represents the following YANG schema fragment defined in module openflow-switch-connection-config 

 list switch-connection-config {
   key instance-name;
   leaf instance-name {
     type string;
   }
   leaf port {
     type uint16;
   }
   leaf transport-protocol {
     type of-config:transport-protocol;
   }
   leaf channel-outbound-queue-size {
     type uint16;
     default 1024;
   }
   leaf address {
     type ietf-inet:ip-address;
   }
   leaf use-barrier {
     type boolean;
     default true;
   }
   leaf group-add-mod-enabled {
     type boolean;
     default false;
   }
   leaf switch-idle-timeout {
     type uint32;
     default 15000;
   }
   container tls {
     leaf keystore {
       type string;
     }
     leaf keystore-type {
       type of-config:keystore-type;
     }
     leaf keystore-path-type {
       type of-config:path-type;
     }
     leaf keystore-password {
       type string;
     }
     leaf certificate-password {
       type string;
     }
     leaf truststore {
       type string;
     }
     leaf truststore-type {
       type of-config:keystore-type;
     }
     leaf truststore-path-type {
       type of-config:path-type;
     }
     leaf truststore-password {
       type string;
     }
     leaf-list cipher-suites {
       type string;
       ordered-by user;
     }
   }
   container threads {
     leaf boss-threads {
       type uint16;
     }
     leaf worker-threads {
       type uint16;
     }
   }
 }

To create instances of this class use SwitchConnectionConfigBuilder.

See Also:

  • 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

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

    • bindingHashCode

      static int bindingHashCode(@NonNull SwitchConnectionConfig 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 SwitchConnectionConfig 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 SwitchConnectionConfig 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

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

    • getInstanceName

      String getInstanceName()
      Return instanceName, or null if it is not present. 
           
         Name of the switch connection instance.
      Returns:
      String instanceName, or null if it is not present.

    • requireInstanceName

      default @NonNull String requireInstanceName()
      Return instanceName, guaranteed to be non-null. 
           
         Name of the switch connection instance.
      Returns:
      String instanceName, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if instanceName is not present

    • getPort

      org.opendaylight.yangtools.yang.common.Uint16 getPort()
      Return port, or null if it is not present. 
           
         local listening port
      Returns:
      Uint16 port, or null if it is not present.

    • requirePort

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requirePort()
      Return port, guaranteed to be non-null. 
           
         local listening port
      Returns:
      Uint16 port, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if port is not present

    • getTransportProtocol

      TransportProtocol getTransportProtocol()
      Return transportProtocol, or null if it is not present. 
           
         Transport protocol used for communication.
      Returns:
      TransportProtocol transportProtocol, or null if it is not present.

    • requireTransportProtocol

      default @NonNull TransportProtocol requireTransportProtocol()
      Return transportProtocol, guaranteed to be non-null. 
           
         Transport protocol used for communication.
      Returns:
      TransportProtocol transportProtocol, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if transportProtocol is not present

    • getChannelOutboundQueueSize

      org.opendaylight.yangtools.yang.common.Uint16 getChannelOutboundQueueSize()
      Return channelOutboundQueueSize, or null if it is not present. 
           
         Channel outbound queue size
      Returns:
      Uint16 channelOutboundQueueSize, or null if it is not present.

    • requireChannelOutboundQueueSize

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireChannelOutboundQueueSize()
      Return channelOutboundQueueSize, guaranteed to be non-null. 
           
         Channel outbound queue size
      Returns:
      Uint16 channelOutboundQueueSize, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if channelOutboundQueueSize is not present

    • getAddress

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAddress()
      Return address, or null if it is not present. 
           
         address of local listening interface
      Returns:
      IpAddress address, or null if it is not present.

    • requireAddress

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireAddress()
      Return address, guaranteed to be non-null. 
           
         address of local listening interface
      Returns:
      IpAddress address, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if address is not present

    • getUseBarrier

      Boolean getUseBarrier()
      Return useBarrier, or null if it is not present. 
           
         Enable barrier in Openflow java
      Returns:
      Boolean useBarrier, or null if it is not present.

    • requireUseBarrier

      default @NonNull Boolean requireUseBarrier()
      Return useBarrier, guaranteed to be non-null. 
           
         Enable barrier in Openflow java
      Returns:
      Boolean useBarrier, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if useBarrier is not present

    • getGroupAddModEnabled

      Boolean getGroupAddModEnabled()
      Return groupAddModEnabled, or null if it is not present. 
           
         Group Add Mod Enabled
      Returns:
      Boolean groupAddModEnabled, or null if it is not present.

    • requireGroupAddModEnabled

      default @NonNull Boolean requireGroupAddModEnabled()
      Return groupAddModEnabled, guaranteed to be non-null. 
           
         Group Add Mod Enabled
      Returns:
      Boolean groupAddModEnabled, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if groupAddModEnabled is not present

    • getSwitchIdleTimeout

      org.opendaylight.yangtools.yang.common.Uint32 getSwitchIdleTimeout()
      Return switchIdleTimeout, or null if it is not present. 
           
         idle timeout in [ms]
      Returns:
      Uint32 switchIdleTimeout, or null if it is not present.

    • requireSwitchIdleTimeout

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireSwitchIdleTimeout()
      Return switchIdleTimeout, guaranteed to be non-null. 
           
         idle timeout in [ms]
      Returns:
      Uint32 switchIdleTimeout, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if switchIdleTimeout is not present

    • getTls

      Tls getTls()
      Return tls, or null if it is not present.
      Returns:
      Tls tls, or null if it is not present.

    • nonnullTls

      @NonNull Tls nonnullTls()
      Return tls, or an empty instance if it is not present.
      Returns:
      Tls tls, or an empty instance if it is not present.

    • getThreads

      Threads getThreads()
      Return threads, or null if it is not present.
      Returns:
      Threads threads, or null if it is not present.

    • nonnullThreads

      @NonNull Threads nonnullThreads()
      Return threads, or an empty instance if it is not present.
      Returns:
      Threads threads, or an empty instance if it is not present.