The modifySSOData method

Description

Corrects single sign-on authentication information. If the specified user does not exist, an exception occurs.

When authentication information listeners for single sign-on are registered in this object, the ssoDataModfied method is called for all such listeners.

With the modifySSOData method, existing information is overwritten with only the modified authentication information that is specified after creation of the SSOData object.

Suppose, for example, the existing single sign-on authentication information in the repository includes the elements shown below.

Authentication information name	SecretData	PublicData	Mapping
			Realm	User ID
Value	secret	public	RealmA	user1
			RealmB	admin

In the parameter of this method, the following code is used to specify the created SSOData object:

SSOData data = new SSOData();
data.setMapping("RealmA", "user2");

The repository stores the following new single sign-on authentication information:

Authentication information name	SecretData	PublicData	Mapping
			Realm	User ID
Value	secret	public	RealmA	user2
	--	--	--	--

To Page Top

Syntax

public void modifySSOData(String uid,
                               SSOData SSOData)
  throws SSODataListenerException, NamingException,
  CryptoException, UnsatisfiedLinkError, SecurityException;

To Page Top

Parameters

uid:

Specifies the user ID.

ssoData:

Specifies the SSOData object that holds the single sign-on authentication information.

To Page Top

Exceptions

com.cosminexus.admin.auth.api.repository.event.SSODataListenerException:

An attempt to update authentication information for another system has failed.

com.cosminexus.admin.auth.CryptoException:

An attempt to read the encryption key file has failed or an attempt to decrypt SecretData has failed due to the use of the wrong encryption key file.

java.lang.UnsatisfiedLinkError:

An attempt to read the single sign-on library has failed.

java.lang.SecurityException:

SecurityManager is present, and read access to the file using SecurityManager's checkRead method has been rejected.

javax.naming.CommunicationException:

An attempt to connect to the LDAP directory server has failed.

javax.naming.NameNotFoundException:

The specified user ID is missing.

Other JNDI exceptions:

Events such as a bind DN specification error

To Page Top

Return value

None

To Page Top