Class SSLConfigChangeEvent

java.lang.Object
com.ibm.websphere.ssl.SSLConfigChangeEvent

public class SSLConfigChangeEvent extends Object

This class is the event received by the SSLConfigChanceListener which components and applications register with the JSSEHelper API. An SSLConfigChangeEvent will be sent with old and new SSL alias. If the old and new SSL alias is the same, then the properties within it changed. It's up to the listener implementation to call JSSEHelper API again if it's desired to dynamically refresh the Properties, SSLContext, SSL socket factories, and/or HTTPS URLStreamHandlers.

Since:
WAS 6.1
See Also:
  • Constructor Details

    • SSLConfigChangeEvent

      public SSLConfigChangeEvent(String alias, Properties config, String selection, Map<String,Object> connInfo)
      Constructor.
      Parameters:
      alias -
      config -
      selection -
      connInfo -
  • Method Details

    • getSelectionType

      public String getSelectionType()

      Returns the selection type made by JSSEHelper. This could be "direct" or "dynamic". Refer to the JSSEHelper API JavaDoc for information on these selection types.

      Returns:
      String
    • getConnectionInfo

      public Map<String,Object> getConnectionInfo()

      Returns the connection info Map which was passed into the JSSEHelper API, if present. This is an optional parameter so null may be returned by this API. See JSSEHelper API for connection info properties.

      Returns:
      Map<String,Object - the connection info used by JSSEHelper.
    • getAlias

      public String getAlias()

      Returns the SSL alias used in the previous call to the JSSEHelper API.

      Returns:
      String
    • getClientCertificateAlias

      public String getClientCertificateAlias()

      Returns the certificate alias used for outbound connections by the SSL configuration returned from the JSSEHelper API.

      Returns:
      String
    • getServerCertificateAlias

      public String getServerCertificateAlias()

      Returns the certificate alias used for inbound connections by the SSL configuration returned from the JSSEHelper API.

      Returns:
      String
    • getState

      public String getState()

      Returns the state of the SSL configuration. This will be either "changed" or "deleted". If the SSL configuration is deleted and direct specification was the selection type, then a new alias will need to be selected or group/dynamic selection should be used. If the state is "deleted", this listener will be automatically de-registered since the configuration has gone away.

      Returns:
      String
    • getOriginalSSLConfig

      public Properties getOriginalSSLConfig()

      Return the SSL properties which this listener originally registered.

      Returns:
      Properties
    • getChangedSSLConfig

      public Properties getChangedSSLConfig()

      Return the SSL properties effective after the most recent change. This will be null if the getState() method returns "deleted".

      Returns:
      Properties
    • setChangedSSLConfig

      public void setChangedSSLConfig(Properties config)

      Allows the runtime to set the new Properties after the change took place.

      Parameters:
      config -
    • setState

      public void setState(String state)

      Allows the runtime to set the state after the change took place.

      Parameters:
      state -
    • toString

      public String toString()
      Overrides:
      toString in class Object