Package com.pushtechnology.diffusion.api.config

Interface KeyStoreConfig

All Superinterfaces:
Config
public interface KeyStoreConfig extends Config
KeyStore configuration for a connector.

Values can not be changed once the server has started.

Since:
4.4

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFile()
    Gets the file name.
    String
    getPassword()
    Gets the password.
    boolean
    isMandatory()
    Is keyStore mandatory?
    void
    setFile(String keyStoreFile)
    Sets the file path of the KeyStore.
    void
    setMandatory(boolean mandatory)
    Sets if keyStore is mandatory.
    void
    setPassword(String password)
    Sets the keyStore password.

    Methods inherited from interface com.pushtechnology.diffusion.api.config.Config

    isLocked

  • Method Details

    • setFile

      void setFile(String keyStoreFile) throws ConfigException
      Sets the file path of the KeyStore.

      If this is not set then no KeyStore is used and so the connector would not be able to accept SSL connections.

      Parameters:
      keyStoreFile - the file
      Throws:
      ConfigException - if unable to set the property

    • getFile

      String getFile()
      Gets the file name.
      Returns:
      file name or null if no keyStore specified

    • setPassword

      void setPassword(String password) throws ConfigException
      Sets the keyStore password.

      This must be set of a KeyStore is specified.

      Parameters:
      password - keyStore password
      Throws:
      ConfigException - if unable to set the property

    • getPassword

      String getPassword()
      Gets the password.
      Returns:
      keyStore password or null if not set.

    • setMandatory

      void setMandatory(boolean mandatory) throws ConfigException
      Sets if keyStore is mandatory.

      If true, all connections must use this KeyStore (i.e. SSL connection is mandatory).

      By default this is false meaning that (assuming KeyStore file is set) the the connector could accept either SSL or non SSL connections.

      Parameters:
      mandatory - true if SSL is mandatory
      Throws:
      ConfigException - if unable to set the property

    • isMandatory

      boolean isMandatory()
      Is keyStore mandatory?
      Returns:
      true if mandatory.