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

Interface Tls

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

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

 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;
   }
 }

To create instances of this class use TlsBuilder.

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<Tls> 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 Tls 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 Tls 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 Tls 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

    • getKeystore

      String getKeystore()
      Return keystore, or null if it is not present. 
           
         keystore location
      Returns:
      String keystore, or null if it is not present.

    • requireKeystore

      default @NonNull String requireKeystore()
      Return keystore, guaranteed to be non-null. 
           
         keystore location
      Returns:
      String keystore, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if keystore is not present

    • getKeystoreType

      KeystoreType getKeystoreType()
      Return keystoreType, or null if it is not present. 
           
         keystore type (JKS or PKCS12)
      Returns:
      KeystoreType keystoreType, or null if it is not present.

    • requireKeystoreType

      default @NonNull KeystoreType requireKeystoreType()
      Return keystoreType, guaranteed to be non-null. 
           
         keystore type (JKS or PKCS12)
      Returns:
      KeystoreType keystoreType, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if keystoreType is not present

    • getKeystorePathType

      PathType getKeystorePathType()
      Return keystorePathType, or null if it is not present. 
           
         keystore path type (CLASSPATH or PATH)
      Returns:
      PathType keystorePathType, or null if it is not present.

    • requireKeystorePathType

      default @NonNull PathType requireKeystorePathType()
      Return keystorePathType, guaranteed to be non-null. 
           
         keystore path type (CLASSPATH or PATH)
      Returns:
      PathType keystorePathType, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if keystorePathType is not present

    • getKeystorePassword

      String getKeystorePassword()
      Return keystorePassword, or null if it is not present. 
           
         password protecting keystore
      Returns:
      String keystorePassword, or null if it is not present.

    • requireKeystorePassword

      default @NonNull String requireKeystorePassword()
      Return keystorePassword, guaranteed to be non-null. 
           
         password protecting keystore
      Returns:
      String keystorePassword, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if keystorePassword is not present

    • getCertificatePassword

      String getCertificatePassword()
      Return certificatePassword, or null if it is not present. 
           
         password protecting certificate
      Returns:
      String certificatePassword, or null if it is not present.

    • requireCertificatePassword

      default @NonNull String requireCertificatePassword()
      Return certificatePassword, guaranteed to be non-null. 
           
         password protecting certificate
      Returns:
      String certificatePassword, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if certificatePassword is not present

    • getTruststore

      String getTruststore()
      Return truststore, or null if it is not present. 
           
         truststore location
      Returns:
      String truststore, or null if it is not present.

    • requireTruststore

      default @NonNull String requireTruststore()
      Return truststore, guaranteed to be non-null. 
           
         truststore location
      Returns:
      String truststore, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if truststore is not present

    • getTruststoreType

      KeystoreType getTruststoreType()
      Return truststoreType, or null if it is not present. 
           
         truststore type (JKS or PKCS12)
      Returns:
      KeystoreType truststoreType, or null if it is not present.

    • requireTruststoreType

      default @NonNull KeystoreType requireTruststoreType()
      Return truststoreType, guaranteed to be non-null. 
           
         truststore type (JKS or PKCS12)
      Returns:
      KeystoreType truststoreType, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if truststoreType is not present

    • getTruststorePathType

      PathType getTruststorePathType()
      Return truststorePathType, or null if it is not present. 
           
         truststore path type (CLASSPATH or PATH)
      Returns:
      PathType truststorePathType, or null if it is not present.

    • requireTruststorePathType

      default @NonNull PathType requireTruststorePathType()
      Return truststorePathType, guaranteed to be non-null. 
           
         truststore path type (CLASSPATH or PATH)
      Returns:
      PathType truststorePathType, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if truststorePathType is not present

    • getTruststorePassword

      String getTruststorePassword()
      Return truststorePassword, or null if it is not present. 
           
         password protecting truststore
      Returns:
      String truststorePassword, or null if it is not present.

    • requireTruststorePassword

      default @NonNull String requireTruststorePassword()
      Return truststorePassword, guaranteed to be non-null. 
           
         password protecting truststore
      Returns:
      String truststorePassword, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if truststorePassword is not present

    • getCipherSuites

      @Nullable List<String> getCipherSuites()
      Return cipherSuites, or null if it is not present. 
           
         combination of cryptographic algorithms used by TLS connection
      Returns:
      List<String> cipherSuites, or null if it is not present.

    • requireCipherSuites

      default @NonNull List<String> requireCipherSuites()
      Return cipherSuites, guaranteed to be non-null. 
           
         combination of cryptographic algorithms used by TLS connection
      Returns:
      List<String> cipherSuites, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if cipherSuites is not present