CrestUserProfileService (IG Aggregated Javadoc 2023.11.1 Documentation)

java.lang.Object
- org.forgerock.openig.tools.userprofile.CrestUserProfileService

All Implemented Interfaces:

UserProfileService
```
public class CrestUserProfileService
extends Object
implements UserProfileService
```
The CrestUserProfileService is responsible for interactions with AM users endpoint using resource version 3.0; since AM v13.

Constructor Summary

Constructors
Constructor	Description
`CrestUserProfileService(RequestHandler requestHandler, Set<String> profileAttributes)`	Creates a new `CrestUserProfileService` which is responsible for interactions with AM users endpoint.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Promise<UserProfile,UserProfileException>`	`getUserProfile(Context context, String username)`	Returns a promise that will be completed with an `UserProfile` or with an `UserProfileException` in case of errors.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CrestUserProfileService
```
public CrestUserProfileService(RequestHandler requestHandler,
                               Set<String> profileAttributes)
```
    Creates a new CrestUserProfileService which is responsible for interactions with AM users endpoint.
    
    Parameters:
    
    requestHandler - The requestHandler used when interacting with AM users endpoint.
    
    profileAttributes - The profile attributes to request.
- Method Detail
  - getUserProfile
```
public Promise<UserProfile,UserProfileException> getUserProfile(Context context,
                                                                      String username)
```
    Description copied from interface: UserProfileService
    
    Returns a promise that will be completed with an UserProfile or with an UserProfileException in case of errors.
    
    Specified by:
    
    getUserProfile in interface UserProfileService
    
    Parameters:
    
    context - The request context.
    
    username - The username that identifies the user to retrieve the profile attributes for.
    
    Returns:
    
    a promise that will be completed with UserProfile or with an ResourceException in case of errors.