oracle.iam.identity.usermgmt.api

Interface UserNameGenerationPolicy

All Superinterfaces:

UserNamePolicy

All Known Implementing Classes:

AbstractUserNameGenerationPolicy

public interface UserNameGenerationPolicy
extends UserNamePolicy

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUserName(java.util.Map reqData) Generates a user name based on the user name generation policy using the user data available in the input Map
boolean	isGivenUserNameValid(java.lang.String userName, java.util.Map reqData) Validates if the user name based on the user data specified in the input Map is valid as per the user name generation policy

Methods inherited from interface oracle.iam.identity.usermgmt.api.UserNamePolicy

getDescription, getUserNameFromPolicy, isUserNameValid

Method Detail

getUserName

java.lang.String getUserName(java.util.Map reqData)
                      throws UserNameGenerationException

Generates a user name based on the user name generation policy using the user data available in the input Map

Parameters:

reqData - the Map containing the user data

Returns:

the generated user name

Throws:

UserNameGenerationException - if there is an exception while generating the user name

isGivenUserNameValid

boolean isGivenUserNameValid(java.lang.String userName,
                             java.util.Map reqData)

Validates if the user name based on the user data specified in the input Map is valid as per the user name generation policy

Parameters:

userName - the user name to be validated against the policy

reqData - the Map containing the user data

Returns:

True if the user name is valid as per the policy, false otherwise