com.crystaldecisions.sdk.plugin.desktop.user
Interface IUserAliases

All Superinterfaces:

java.util.Collection, ISDKSet, java.lang.Iterable, java.util.Set

public interface IUserAliases
extends ISDKSet

This interface defines a collection of IUserAlias objects. When you create a new Enterprise user, or when a member of a third-party group is mapped to the Enterprise system, an alias is automatically created for the user and added to the UserAliases collection. Use this collection to delete an alias, or to assign an available third-party alias to an existing user.

Each alias that is added to the collection can be used to log the user on to the Enterprise system. For example, a user may have both an Enterprise alias and a Windows NT alias that he or she can access the system with. If desired, the third-party NT alias can be re-assigned to a different user.

Depending on which options are enabled, when a third-party group is mapped to the system, the following will occur:

• If the SI_ALIAS_AUTOADD Property is set to true, then the third-party aliases are added to existing Enterprise users with the same name, or if a user with the same name does not exist, a new user is created. If the alias is deleted from the collection, and then the user tries to log on with it, the alias is re-created if the Enterprise user that it was previously mapped to still exists.
• If the SI_ALIAS_AUTOADD Property is set to False, then a new user is created for each third-party alias. If the alias is deleted, then the user is deleted; if the user then tries to log on with the third-party alias, then the alias is re-created as a new user.

Method Summary

IUserAlias	add(java.lang.String aliasName, java.lang.String aliasId, boolean disabled) Deprecated. This method has been deprecated. Customers should use addNew instead.
IUserAlias	addExisting(java.lang.String aliasName, java.lang.String aliasId, boolean disabled) Adds an existing alias to the collection.
IUserAlias	addNew(java.lang.String aliasName, boolean disabled) Adds a new alias to the collection.

Methods inherited from interface com.crystaldecisions.sdk.properties.ISDKSet

get

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

add

@Deprecated
IUserAlias add(java.lang.String aliasName,
                          java.lang.String aliasId,
                          boolean disabled)

Deprecated. This method has been deprecated. Customers should use addNew instead.

Adds a new alias to the collection. This method should always be used to add an alias to the end of the aliases collection.

Parameters:

aliasName - The name of the new alias, a non-null, non-empty String.

aliasId - The ID of the new alias with the format <auth_type>:<id>. For example, secLDAP:#12.

disabled - true if the new alias should be disabled, false otherwise.

Returns:

An IUserAlias object containing the newly created alias.

Throws:

java.lang.NullPointerException - If the aliasName or aliasId is null

java.lang.IllegalArgumentException - If the aliasName is an empty string or the aliasId is not compliant with the correct format.

addNew

IUserAlias addNew(java.lang.String aliasName,
                  boolean disabled)

Adds a new alias to the collection. This method should always be used to add an alias to the end of the aliases collection.

Parameters:

aliasName - The name of the new alias, a non-null, non-empty String.

disabled - true if the new alias should be disabled, false otherwise.

Returns:

An IUserAlias object containing the newly created alias.

Throws:

java.lang.NullPointerException - If the aliasName is null

java.lang.IllegalArgumentException - If the aliasName is an empty string.

addExisting

IUserAlias addExisting(java.lang.String aliasName,
                       java.lang.String aliasId,
                       boolean disabled)

Adds an existing alias to the collection. This method should always be used to add an existing alias to the end of the aliases collection.

Parameters:

aliasName - The name of the existing alias, a non-null, non-empty String.

aliasId - The ID of the existing alias with the format <auth_type>:<id>. For example, secLDAP:#12.

disabled - true if the existing alias should be disabled, false otherwise.

Returns:

An IUserAlias object containing the existing alias.

Throws:

java.lang.NullPointerException - If the aliasName or aliasId is null

java.lang.IllegalArgumentException - If the aliasName is an empty string or the aliasId is not compliant with the correct format.