oracle.adf.share.security.identitymanagement.spi
Interface IdentityManagement

All Known Implementing Classes:

JpsIdentityManagementProvider

public interface IdentityManagement

Internal: Applications should not use this interface. This interface specifies the contract that a provider of an Identity Management adapter should implement.

Method Summary

java.security.Principal	addRole(Role roleDef) Internal: Applications should not use this method. This method should add the specified Role to the identity management system and return a Principal that can subsequently be used to reference the Role.
void	addToRole(java.security.Principal roleRef, java.security.Principal member) Internal: Applications should not use this method. This method adds the specified member Principal to the Role referenced by the specified role Principal.
java.security.Principal	addUser(User user, Credential credential) Internal: Applications should not use this method. This method instructs the provider to create a user in the implemented identity management system with the attributes specified in the user object.
Role	createRole() Internal: Applications should not use this method. This method should return a Role object or subclass that the caller can use to build up a Role definition to submit to the UserManager for adding to the identity management system.
User	createUser() Internal: Applications should not use this method. This method should return a User object or subclass of it that is able to represent a user as expected by the identity management system implemented by this provider.
void	deleteFromRole(java.security.Principal roleRef, java.security.Principal member) Internal: Applications should not use this method. This method deletes the member specified by the corresponding Principal, from the Role represented by the roleRef Principal, from the identity management system.
void	deleteRole(java.security.Principal roleRef) Internal: Applications should not use this method. This method deletes the role referenced by the specified Principal in the identity management system.
void	deleteUser(java.security.Principal principal) Internal: Applications should not use this method. This method deletes the specified user entry referenced by the user principal.
java.security.Principal	getAnonymousRole() Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.
java.lang.String	getAnonymousRoleName() Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.
java.security.Principal	getAnonymousUser() Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.
java.lang.String	getAnonymousUserName() Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.
Role	getRole(java.security.Principal roleRef) Internal: Applications should not use this method. This method returns a Role object corresponding to the Principal specified as an argument.
java.util.ArrayList	getRoleList(int sizeLimit, AttributeFilter[] filter) Internal: Applications should not use this method. This method provides a list of roles from the underlying repository, based on the specified attribute filters.
java.security.Principal	getRolePrincipal(java.lang.String roleName) Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.
User	getUser(java.security.Principal principal) Internal: Applications should not use this method. This method obtains a User object from the provider for the user corresponding to the specified principal.
java.util.ArrayList	getUserList(int sizeLimit, AttributeFilter[] filter) Internal: Applications should not use this method. This method provides a list of users from the underlying repository, based on the specified attribute filters.
java.util.ArrayList	getUserList(int sizeLimit, AttributeFilter[] filter, java.security.Principal roleRef) Internal: Applications should not use this method. This method provides a user list of users in a specified role.
java.security.Principal	getUserPrincipal(java.lang.String username) Internal: Applications should not use this method. This method get the user principal for the given username.
java.util.ArrayList	getUserProfileList(int sizeLimit, AttributeFilter[] filter)
java.lang.Object	getUserProfilePropertyVal(java.lang.String name, java.lang.String propName) Internal: Applications should not use this method. This method retrieve the property value of the UserProfile of the specified property name.
boolean	isAddRoleSupported() Internal: Applications should not use this method. This method indicates whether or not the addRole method is supported by the underlying provider.
boolean	isAddUserSupported() Internal: Applications should not use this method. This method provides a hint to the calling application as to whether or not the provider supports the addUser method.
boolean	isDeleteRoleSupported() Internal: Applications should not use this method. This method indicates whether or not the deleteRole method is supported by the underlying provider.
boolean	isDeleteUserSupported() Internal: Applications should not use this method. This method provides a hint to the calling application as to whether or not the provider supports the deleteUser method.
boolean	isModifyRoleSupported() Internal: Applications should not use this method. This method indicates whether or not the modifyRole method is supported by the underlying provider.
boolean	isModifyUserSupported() Internal: Applications should not use this method. This method provides a hint to the calling application as to whether or not the provider supports the modifyUser method.
void	modifyRole(java.security.Principal roleRef, Role roleDef) Internal: Applications should not use this method. This method takes a Principal that references a Role in the identity management system, and a Role object, and modifies the definition of the Role in the identity management system in accordance with the definition of the Role specified in the argument.
void	modifyUser(java.security.Principal principal, User user) Internal: Applications should not use this method. This method instructs the provider to update the user entry referenced by the specified user principal in the identity management system.
void	saveUserProfile(java.lang.String userName, java.util.HashMap values) Internal: Applications should not use this method. This method persist the property values of the UserProfile of the specified user name.

Method Detail

createUser

User createUser()

Internal: Applications should not use this method. This method should return a User object or subclass of it that is able to represent a user as expected by the identity management system implemented by this provider.

The subclass is encouraged to implement the UserProfileCapable interface, which defines the contract for a user profile for a standard Oracle Identity Management user entry.

Returns:

a representation of a user with standard getter and setter methods for the supported attributes.

addUser

java.security.Principal addUser(User user,
                                Credential credential)

Internal: Applications should not use this method. This method instructs the provider to create a user in the implemented identity management system with the attributes specified in the user object. The credential is provided in a separate parameter so that it is not defined in the User object, which is provided freely to the application. The credential is only specified during user creation and is not available thereafter.

Parameters:

user -

credential -

Returns:

a Principal assigned to the new user. This principal must be consistent with the user Principal that would be added to the Subject if this user were to authenticate against this repository.

getUser

User getUser(java.security.Principal principal)

Internal: Applications should not use this method. This method obtains a User object from the provider for the user corresponding to the specified principal.

Parameters:

principal -

Returns:

a User object that contains the user's profile attributes from the identity management system.

modifyUser

void modifyUser(java.security.Principal principal,
                User user)

Internal: Applications should not use this method. This method instructs the provider to update the user entry referenced by the specified user principal in the identity management system.

Parameters:

principal - A user principal that corresponds to what the associated authenticator for the identity management system would associate with the Subject when the user authenticates. This provides the unique identifier for the user in the identity management system.

user - A User object or subclass of it that provides the complete set of attributes that should be committed to the identity management system.

deleteUser

void deleteUser(java.security.Principal principal)

Internal: Applications should not use this method. This method deletes the specified user entry referenced by the user principal.

Parameters:

principal - A user principal that corresponds to what the associated authenticator for the identity management system would associate with the Subject when the user authenticates. This provides the unique identifier for the user in the identity management system.

getUserPrincipal

java.security.Principal getUserPrincipal(java.lang.String username)

Internal: Applications should not use this method. This method get the user principal for the given username.

Parameters:

username - The username of the user as used to log on to the system.

Returns:

A user principal that corresponds to what the associated authenticator for the identity management system would associate with the Subject when the user authenticates. This provides the unique identifier for the user in the identity management system.

isAddUserSupported

boolean isAddUserSupported()

Internal: Applications should not use this method. This method provides a hint to the calling application as to whether or not the provider supports the addUser method.

Returns:

true indicates that addUser is supported by the provider

isModifyUserSupported

boolean isModifyUserSupported()

Internal: Applications should not use this method. This method provides a hint to the calling application as to whether or not the provider supports the modifyUser method.

Returns:

true indicates that modifyUser is supported by the provider

isDeleteUserSupported

boolean isDeleteUserSupported()

Internal: Applications should not use this method. This method provides a hint to the calling application as to whether or not the provider supports the deleteUser method.

Returns:

true indicates that deleteUser is supported by the provider

getUserList

java.util.ArrayList getUserList(int sizeLimit,
                                AttributeFilter[] filter)

Internal: Applications should not use this method. This method provides a list of users from the underlying repository, based on the specified attribute filters.

Parameters:

sizeLimit - The limit of the number of entries that should be retrieved into the collection.

filter - An array of AttributeFilter to specify the search criteria for the list. The attributes specified should be supported by the underlying provider in the user object.

Returns:

An array of user objects.

getUserList

java.util.ArrayList getUserList(int sizeLimit,
                                AttributeFilter[] filter,
                                java.security.Principal roleRef)

Internal: Applications should not use this method. This method provides a user list of users in a specified role.

Parameters:

sizeLimit -

filter -

roleRef -

Returns:

An array of user objects.

getUserProfileList

java.util.ArrayList getUserProfileList(int sizeLimit,
                                       AttributeFilter[] filter)

createRole

Role createRole()

Internal: Applications should not use this method. This method should return a Role object or subclass that the caller can use to build up a Role definition to submit to the UserManager for adding to the identity management system.

Returns:

a Role object or subclass

addRole

java.security.Principal addRole(Role roleDef)

Internal: Applications should not use this method. This method should add the specified Role to the identity management system and return a Principal that can subsequently be used to reference the Role.

Parameters:

roleDef -

Returns:

A Principal corresponding to the Role that was added to the identity management system.

modifyRole

void modifyRole(java.security.Principal roleRef,
                Role roleDef)

Internal: Applications should not use this method. This method takes a Principal that references a Role in the identity management system, and a Role object, and modifies the definition of the Role in the identity management system in accordance with the definition of the Role specified in the argument.

Parameters:

roleRef -

roleDef -

deleteRole

void deleteRole(java.security.Principal roleRef)

Internal: Applications should not use this method. This method deletes the role referenced by the specified Principal in the identity management system.

Parameters:

roleRef -

getRole

Role getRole(java.security.Principal roleRef)

Internal: Applications should not use this method. This method returns a Role object corresponding to the Principal specified as an argument.

Parameters:

roleRef -

Returns:

a Role object corresponding to the specified Principal

getRolePrincipal

java.security.Principal getRolePrincipal(java.lang.String roleName)

Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Parameters:

roleName -

Returns:

Principal for specified role name

addToRole

void addToRole(java.security.Principal roleRef,
               java.security.Principal member)

Internal: Applications should not use this method. This method adds the specified member Principal to the Role referenced by the specified role Principal.

Parameters:

roleRef -

member -

deleteFromRole

void deleteFromRole(java.security.Principal roleRef,
                    java.security.Principal member)

Internal: Applications should not use this method. This method deletes the member specified by the corresponding Principal, from the Role represented by the roleRef Principal, from the identity management system.

Parameters:

roleRef -

member -

getRoleList

java.util.ArrayList getRoleList(int sizeLimit,
                                AttributeFilter[] filter)

Internal: Applications should not use this method. This method provides a list of roles from the underlying repository, based on the specified attribute filters.

Parameters:

sizeLimit - The limit of the number of entries that should be retrieved into the collection.

filter - An array of AttributeFilter to specify the search criteria for the list. The attributes specified should be supported by the underlying provider in the role object.

Returns:

An array of role objects.

isAddRoleSupported

boolean isAddRoleSupported()

Internal: Applications should not use this method. This method indicates whether or not the addRole method is supported by the underlying provider. This may be used by the application to tailor the user interface accordingly.

Returns:

true if the addRole method is supported by the provider

isModifyRoleSupported

boolean isModifyRoleSupported()

Internal: Applications should not use this method. This method indicates whether or not the modifyRole method is supported by the underlying provider. This may be used by the application to tailor the user interface accordingly.

Returns:

true if the modifyRole method is supported by the provider

isDeleteRoleSupported

boolean isDeleteRoleSupported()

Internal: Applications should not use this method. This method indicates whether or not the deleteRole method is supported by the underlying provider. This may be used by the application to tailor the user interface accordingly.

Returns:

true if the deleteRole method is supported by the provider

getUserProfilePropertyVal

java.lang.Object getUserProfilePropertyVal(java.lang.String name,
                                           java.lang.String propName)

Internal: Applications should not use this method. This method retrieve the property value of the UserProfile of the specified property name.

Parameters:

name -

propName -

saveUserProfile

void saveUserProfile(java.lang.String userName,
                     java.util.HashMap values)

Internal: Applications should not use this method. This method persist the property values of the UserProfile of the specified user name.

Parameters:

userName -

values -

getAnonymousRoleName

java.lang.String getAnonymousRoleName()

Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Returns:

anonymous role name

getAnonymousRole

java.security.Principal getAnonymousRole()

Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Returns:

anonymous role principal

getAnonymousUserName

java.lang.String getAnonymousUserName()

Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Returns:

anonymous User name

getAnonymousUser

java.security.Principal getAnonymousUser()

Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Returns:

anonymous principal