Oracle Fusion Middleware Java API Reference for Oracle ADF Share
11g Release 1 (11.1.1.0.0)

E10686-01

oracle.adf.share.security.providers.jps
Class JpsIdentityManagementProvider

java.lang.Object
  extended by oracle.adf.share.security.providers.jps.JpsIdentityManagementProvider
All Implemented Interfaces:
IdentityManagement

public class JpsIdentityManagementProvider
extends java.lang.Object
implements IdentityManagement


Field Summary
static java.lang.String WILD_CARD
           
 
Constructor Summary
JpsIdentityManagementProvider()
           
 
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[] filters)
          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[] filters)
          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[] filters, 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[] filters)
           
 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.
 void initialize()
           
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WILD_CARD

public static java.lang.String WILD_CARD
Constructor Detail

JpsIdentityManagementProvider

public JpsIdentityManagementProvider()
Method Detail

initialize

public void initialize()

createUser

public User createUser()
Description copied from interface: IdentityManagement
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.

Specified by:
createUser in interface IdentityManagement
Returns:
a representation of a user with standard getter and setter methods for the supported attributes.

addUser

public java.security.Principal addUser(User user,
                                       Credential credential)
Description copied from interface: IdentityManagement
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.

Specified by:
addUser in interface IdentityManagement
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

public User getUser(java.security.Principal principal)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method obtains a User object from the provider for the user corresponding to the specified principal.

Specified by:
getUser in interface IdentityManagement
Returns:
a User object that contains the user's profile attributes from the identity management system.

modifyUser

public void modifyUser(java.security.Principal principal,
                       User user)
Description copied from interface: IdentityManagement
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.

Specified by:
modifyUser in interface IdentityManagement
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

public void deleteUser(java.security.Principal principal)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method deletes the specified user entry referenced by the user principal.

Specified by:
deleteUser in interface IdentityManagement
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

public java.security.Principal getUserPrincipal(java.lang.String username)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method get the user principal for the given username.

Specified by:
getUserPrincipal in interface IdentityManagement
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

public boolean isAddUserSupported()
Description copied from interface: IdentityManagement
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.

Specified by:
isAddUserSupported in interface IdentityManagement
Returns:
true indicates that addUser is supported by the provider

isModifyUserSupported

public boolean isModifyUserSupported()
Description copied from interface: IdentityManagement
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.

Specified by:
isModifyUserSupported in interface IdentityManagement
Returns:
true indicates that modifyUser is supported by the provider

isDeleteUserSupported

public boolean isDeleteUserSupported()
Description copied from interface: IdentityManagement
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.

Specified by:
isDeleteUserSupported in interface IdentityManagement
Returns:
true indicates that deleteUser is supported by the provider

getUserList

public java.util.ArrayList getUserList(int sizeLimit,
                                       AttributeFilter[] filters)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method provides a list of users from the underlying repository, based on the specified attribute filters.

Specified by:
getUserList in interface IdentityManagement
Parameters:
sizeLimit - The limit of the number of entries that should be retrieved into the collection.
filters - 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.

getUserProfileList

public java.util.ArrayList getUserProfileList(int sizeLimit,
                                              AttributeFilter[] filters)
Specified by:
getUserProfileList in interface IdentityManagement

getUserProfilePropertyVal

public java.lang.Object getUserProfilePropertyVal(java.lang.String name,
                                                  java.lang.String propName)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method retrieve the property value of the UserProfile of the specified property name.

Specified by:
getUserProfilePropertyVal in interface IdentityManagement

saveUserProfile

public void saveUserProfile(java.lang.String userName,
                            java.util.HashMap values)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method persist the property values of the UserProfile of the specified user name.

Specified by:
saveUserProfile in interface IdentityManagement

getUserList

public java.util.ArrayList getUserList(int sizeLimit,
                                       AttributeFilter[] filters,
                                       java.security.Principal roleRef)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method provides a user list of users in a specified role.

Specified by:
getUserList in interface IdentityManagement
Returns:
An array of user objects.

createRole

public Role createRole()
Description copied from interface: IdentityManagement
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.

Specified by:
createRole in interface IdentityManagement
Returns:
a Role object or subclass

addRole

public java.security.Principal addRole(Role roleDef)
Description copied from interface: IdentityManagement
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.

Specified by:
addRole in interface IdentityManagement
Returns:
A Principal corresponding to the Role that was added to the identity management system.

modifyRole

public void modifyRole(java.security.Principal roleRef,
                       Role roleDef)
Description copied from interface: IdentityManagement
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.

Specified by:
modifyRole in interface IdentityManagement

deleteRole

public void deleteRole(java.security.Principal roleRef)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method deletes the role referenced by the specified Principal in the identity management system.

Specified by:
deleteRole in interface IdentityManagement

getRole

public Role getRole(java.security.Principal roleRef)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method returns a Role object corresponding to the Principal specified as an argument.

Specified by:
getRole in interface IdentityManagement
Returns:
a Role object corresponding to the specified Principal

getRolePrincipal

public java.security.Principal getRolePrincipal(java.lang.String roleName)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Specified by:
getRolePrincipal in interface IdentityManagement
Returns:
Principal for specified role name

addToRole

public void addToRole(java.security.Principal roleRef,
                      java.security.Principal member)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method adds the specified member Principal to the Role referenced by the specified role Principal.

Specified by:
addToRole in interface IdentityManagement

deleteFromRole

public void deleteFromRole(java.security.Principal roleRef,
                           java.security.Principal member)
Description copied from interface: IdentityManagement
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.

Specified by:
deleteFromRole in interface IdentityManagement

getRoleList

public java.util.ArrayList getRoleList(int sizeLimit,
                                       AttributeFilter[] filters)
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method provides a list of roles from the underlying repository, based on the specified attribute filters.

Specified by:
getRoleList in interface IdentityManagement
Parameters:
sizeLimit - The limit of the number of entries that should be retrieved into the collection.
filters - 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

public boolean isAddRoleSupported()
Description copied from interface: IdentityManagement
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.

Specified by:
isAddRoleSupported in interface IdentityManagement
Returns:
true if the addRole method is supported by the provider

isModifyRoleSupported

public boolean isModifyRoleSupported()
Description copied from interface: IdentityManagement
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.

Specified by:
isModifyRoleSupported in interface IdentityManagement
Returns:
true if the modifyRole method is supported by the provider

isDeleteRoleSupported

public boolean isDeleteRoleSupported()
Description copied from interface: IdentityManagement
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.

Specified by:
isDeleteRoleSupported in interface IdentityManagement
Returns:
true if the deleteRole method is supported by the provider

getAnonymousRoleName

public java.lang.String getAnonymousRoleName()
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Specified by:
getAnonymousRoleName in interface IdentityManagement
Returns:
anonymous role name

getAnonymousRole

public java.security.Principal getAnonymousRole()
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Specified by:
getAnonymousRole in interface IdentityManagement
Returns:
anonymous role principal

getAnonymousUserName

public java.lang.String getAnonymousUserName()
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Specified by:
getAnonymousUserName in interface IdentityManagement
Returns:
anonymous User name

getAnonymousUser

public java.security.Principal getAnonymousUser()
Description copied from interface: IdentityManagement
Internal: Applications should not use this method. This method returns a Principal corresponding to the specified Role name.

Specified by:
getAnonymousUser in interface IdentityManagement
Returns:
anonymous principal

Oracle Fusion Middleware Java API Reference for Oracle ADF Share
11g Release 1 (11.1.1.0.0)

E10686-01

Copyright © 1997, 2008, Oracle. All rights reserved.