Package org.springframework.boot.ssl.pem

Record Class PemSslStoreDetails

java.lang.Object
java.lang.Record
org.springframework.boot.ssl.pem.PemSslStoreDetails
Record Components:
type - the key store type, for example JKS or PKCS11. A null value will use KeyStore.getDefaultType()).
certificate - the certificate content (either the PEM content itself or something that can be loaded by ResourceUtils.getURL(java.lang.String))
privateKey - the private key content (either the PEM content itself or something that can be loaded by ResourceUtils.getURL(java.lang.String))
privateKeyPassword - a password used to decrypt an encrypted private key
public record PemSslStoreDetails(String type, String certificate, String privateKey, String privateKeyPassword) extends Record
Details for an individual trust or key store in a PemSslStoreBundle.
Since:
3.1.0
Author:
Scott Frederick, Phillip Webb

  • Constructor Details

    • PemSslStoreDetails

      public PemSslStoreDetails(String type, String certificate, String privateKey)

    • PemSslStoreDetails

      public PemSslStoreDetails(String type, String certificate, String privateKey, String privateKeyPassword)
      Creates an instance of a PemSslStoreDetails record class.
      Parameters:
      type - the value for the type record component
      certificate - the value for the certificate record component
      privateKey - the value for the privateKey record component
      privateKeyPassword - the value for the privateKeyPassword record component

  • Method Details

    • withPrivateKey

      public PemSslStoreDetails withPrivateKey(String privateKey)
      Return a new PemSslStoreDetails instance with a new private key.
      Parameters:
      privateKey - the new private key
      Returns:
      a new PemSslStoreDetails instance

    • withPrivateKeyPassword

      public PemSslStoreDetails withPrivateKeyPassword(String password)
      Return a new PemSslStoreDetails instance with a new private key password.
      Parameters:
      password - the new private key password
      Returns:
      a new PemSslStoreDetails instance

    • forCertificate

      public static PemSslStoreDetails forCertificate(String certificate)
      Factory method to create a new PemSslStoreDetails instance for the given certificate.
      Parameters:
      certificate - the certificate
      Returns:
      a new PemSslStoreDetails instance.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • certificate

      public String certificate()
      Returns the value of the certificate record component.
      Returns:
      the value of the certificate record component

    • privateKey

      public String privateKey()
      Returns the value of the privateKey record component.
      Returns:
      the value of the privateKey record component

    • privateKeyPassword

      public String privateKeyPassword()
      Returns the value of the privateKeyPassword record component.
      Returns:
      the value of the privateKeyPassword record component