com.ibm.websphere.ssl

Class SSLConfigChangeEvent

java.lang.Object

com.ibm.websphere.ssl.SSLConfigChangeEvent

public class SSLConfigChangeEvent
extends java.lang.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

Version:

1.0

See Also:

JSSEHelper

Constructor Summary

Constructors

Constructor and Description
SSLConfigChangeEvent(java.lang.String alias, java.util.Properties config, java.lang.String selection, java.util.Map connInfo)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAlias() Returns the SSL alias used in the previous call to the JSSEHelper API.
java.util.Properties	getChangedSSLConfig() Return the SSL properties effective after the most recent change.
java.lang.String	getClientCertificateAlias() Returns the certificate alias used for outbound connections by the SSL configuration returned from the JSSEHelper API.
java.util.Map	getConnectionInfo() Returns the connection info Map which was passed into the JSSEHelper API, if present.
java.util.Properties	getOriginalSSLConfig() Return the SSL properties which this listener originally registered.
java.lang.String	getSelectionType() Returns the selection type made by JSSEHelper.
java.lang.String	getServerCertificateAlias() Returns the certificate alias used for inbound connections by the SSL configuration returned from the JSSEHelper API.
java.lang.String	getState() Returns the state of the SSL configuration.
void	setChangedSSLConfig(java.util.Properties config) Allows the runtime to set the new Properties after the change took place.
void	setState(java.lang.String state) Allows the runtime to set the state after the change took place.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SSLConfigChangeEvent

public SSLConfigChangeEvent(java.lang.String alias,
                    java.util.Properties config,
                    java.lang.String selection,
                    java.util.Map connInfo)

Method Detail

getSelectionType

public java.lang.String getSelectionType()

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

getConnectionInfo

public java.util.Map 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.

getAlias

public java.lang.String getAlias()

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

getClientCertificateAlias

public java.lang.String getClientCertificateAlias()

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

getServerCertificateAlias

public java.lang.String getServerCertificateAlias()

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

getState

public java.lang.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.

getOriginalSSLConfig

public java.util.Properties getOriginalSSLConfig()

Return the SSL properties which this listener originally registered.

getChangedSSLConfig

public java.util.Properties getChangedSSLConfig()

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

setChangedSSLConfig

public void setChangedSSLConfig(java.util.Properties config)

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

Parameters:

java.util.Properties -

setState

public void setState(java.lang.String state)

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

Parameters:

String - currentState

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object