15.15 The SSODataListener interface

Description

This interface should be implemented in the authentication information listener class for single sign-on, which receives notifications when single sign-on authentication information is updated.

If you want to update authentication information for other systems simultaneously by using single sign-on authentication information, create a class that implements this interface. Also, use the addSSODataListener method to register an instance (object) of the created class in the LdapSSODataManager object.

The package name of the SSODataListener interface is com.cosminexus.admin.auth.api.repository.event.

The methods of the SSODataListener interface can be called by using the methods of the LdapSSODataManager class. In such cases, SSODataEvent objects are passed as parameters.

The table below lists the calling methods of the LdapSSODataManager class and the called methods of the SSODataListener interface. It also lists the values stored in SSODataEvent objects passed as parameters.

Table 15‒2: Values stored in SSODataEvent objects
Calling method of the LdapSSODataManager class	Called method of the SSODataListener interface	Values stored in the SSODataEvent object
Calling method of the LdapSSODataManager class	Called method of the SSODataListener interface	User ID	SecretData	PublicData	Old SecretData	Old PublicData
`addSSOData` method	`ssoDataAdded` method	Yes	Yes	Yes	--	--
`modifySSOData` method	`ssoDataModified` method	Yes	Yes	Yes	Yes	Yes
`removeSSOData` method	`ssoDataRemoved` method	Yes	Yes	Yes	--	--

Legend:

Yes: Stored.

--: Not stored.

Create a class to throw a ChangeDataFailedException that contains a message indicating the cause of a problem with the ssoDataAdded, ssoDataModified, or ssoDataRemoved method. An SSODataListenerException that contains the exception object occurs in the caller of the LdapSSODataManager method.

Syntax

interface SSODataListener extends java.util.EventListener
{
  public void SSODataAdded(SSODataEvent event)
    throws ChangeDataFailedException;
  public void SSODataModified(SSODataEvent event)
    throws ChangeDataFailedException;
  public void SSODataRemoved(SSODataEvent event)
    throws ChangeDataFailedException;
}

Methods

Method name	Functionality
`ssoDataAdded` method	Called when adding single sign-on authentication information.
`ssoDataModified` method	Called when changing single sign-on authentication information.
`ssoDataRemoved` method	Called when deleting single sign-on authentication information.

Organization of this section

To Page Top