oracle.iam.identity.usermgmt.api

Class AbstractUserNameGenerationPolicy

java.lang.Object

oracle.iam.identity.usermgmt.api.AbstractUserNameGenerationPolicy

All Implemented Interfaces:

UserNameGenerationPolicy, UserNamePolicy

public abstract class AbstractUserNameGenerationPolicy
extends java.lang.Object
implements UserNameGenerationPolicy

Abstract class that implements deprecated API's so that custom policy implementations have no need to implement them.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXISTING_DATA Key/Constant to retrieve the User's existing attributes from the input parameter Map.

Constructor Summary

Constructors

Constructor and Description
AbstractUserNameGenerationPolicy()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUserNameFromPolicy(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	isUserNameValid(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 class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getUserName, isGivenUserNameValid

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

getDescription

Field Detail

EXISTING_DATA

public static final java.lang.String EXISTING_DATA

Key/Constant to retrieve the User's existing attributes from the input parameter Map.

See Also:

Constant Field Values

Constructor Detail

AbstractUserNameGenerationPolicy

public AbstractUserNameGenerationPolicy()

Method Detail

getUserNameFromPolicy

public java.lang.String getUserNameFromPolicy(java.util.Map reqData)
                                       throws UserNameGenerationException

Description copied from interface: UserNamePolicy

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

Specified by:

getUserNameFromPolicy in interface UserNamePolicy

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

isUserNameValid

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

Description copied from interface: UserNamePolicy

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

Specified by:

isUserNameValid in interface UserNamePolicy

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