com.sun.identity.authentication.spi
Interface UserIDGenerator
- public interface UserIDGenerator
An application implements a UserIDGenerator
interface and
registers itself to the Core Authentication service so that the
authentication modules can retrieve a list of auto-generated user IDs. The
method that each individual module implements AMLoginModule
can
be used to retrieve such list is getNewUserIDs()
. For example in
self-registration module, when an end-user tries to register a user ID that
is not valid, the module then can display a list of alternate user IDs
that the end-user could be used to complete the registration.
Method Summary |
java.util.Set |
generateUserIDs(java.lang.String orgName,
java.util.Map attributes,
int num)
Generates a set of user IDs. |
generateUserIDs
public java.util.Set generateUserIDs(java.lang.String orgName,
java.util.Map attributes,
int num)
- Generates a set of user IDs. Optionally, the specified parameters,
orgName
and attributes, could be used to generate the user
IDs. The parameter num
refers to the maximum number of user
IDs returned. It is possible that the size of the returned
Set
is smaller than the parameter num
.
- Parameters:
orgName
- the DN of the organization.attributes
- the keys in the Map
contains the
attribute names and their corresponding values in
the Map
is a Set
that
contains the values for the attribute.num
- the maximum number of returned user IDs; 0 means there
is no limit.
- Returns:
- a set of auto-generated user IDs.
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.