Interface SwitchConnectionConfig

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<SwitchConnectionConfig>, 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;
         }
       }
       container threads {
         leaf boss-threads {
           type uint16;
         }
         leaf worker-threads {
           type uint16;
         }
       }
     }
     
    The schema path to identify an instance is openflow-switch-connection-config/switch-connection-config

    To create instances of this class use SwitchConnectionConfigBuilder.

    See Also:
    SwitchConnectionConfigBuilder, SwitchConnectionConfigKey
    • Field Detail

      • QNAME

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

      • implementedInterface

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

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

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

        TransportProtocol getTransportProtocol()
        Return transportProtocol, or null if it is not present.
             
                 Transport protocol used for communication.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.config.rev140630.TransportProtocol transportProtocol, or null if it 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:
        org.opendaylight.yangtools.yang.common.Uint16 channelOutboundQueueSize, or null if it 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:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress address, or null if it is not present.
      • getUseBarrier

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

        @Deprecated(forRemoval=true)
        default Boolean isUseBarrier()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getGroupAddModEnabled

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

        @Deprecated(forRemoval=true)
        default Boolean isGroupAddModEnabled()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getSwitchIdleTimeout

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

        Tls getTls()
        Return tls, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow._switch.connection.config.rev160506._switch.connection.config.Tls tls, or null if it is not present.
      • getThreads

        Threads getThreads()
        Return threads, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow._switch.connection.config.rev160506._switch.connection.config.Threads threads, or null if it is not present.