Package org.odpi.openmetadata.accessservices.communityprofile.client

Class UserIdentityManagement

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.client.CommunityProfileBaseClient

org.odpi.openmetadata.accessservices.communityprofile.client.UserIdentityManagement

All Implemented Interfaces:

RelatedElementsManagementInterface, UserIdentityManagementInterface

public class UserIdentityManagement
extends CommunityProfileBaseClient
implements UserIdentityManagementInterface

UserIdentityManagement is the client for explicitly managing the user identity entities and associating them with profiles. It is typically used when the relationship between user identities and profiles are many to one.

Constructor Summary

Constructors

Constructor	Description
UserIdentityManagement(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
UserIdentityManagement(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
UserIdentityManagement(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
UserIdentityManagement(String serverName, String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
UserIdentityManagement(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	addIdentityToProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, ProfileIdentityProperties properties)	Link a user identity to a profile.
String	createUserIdentity(String userId, String externalSourceGUID, String externalSourceName, UserIdentityProperties newIdentity)	Create a UserIdentity.
String	createUserIdentityForProfile(String userId, String externalSourceGUID, String externalSourceName, String profileGUID, UserIdentityProperties newIdentity)	Create a UserIdentity that is for the sole use of a specific actor profile.
void	deleteUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID)	Remove a user identity object.
List<UserIdentityElement>	findUserIdentities(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of user identity metadata elements that contain the search string.
List<UserIdentityElement>	getUserIdentitiesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of user identity metadata elements with a matching qualified name.
UserIdentityElement	getUserIdentityByGUID(String userId, String userIdentityGUID)	Retrieve the userIdentity metadata element with the supplied unique identifier.
void	removeIdentityFromProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID)	Unlink a user identity from a profile.
void	updateProfileIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, boolean isMergeUpdate, ProfileIdentityProperties properties)	Update the properties of the relationship between a user identity and profile.
void	updateUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, boolean isMergeUpdate, UserIdentityProperties properties)	Update a UserIdentity.

Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.client.CommunityProfileBaseClient

clearAssignmentScope, clearMoreInformation, clearResource, clearStakeholder, getAssignedActors, getAssignedScopes, getDescriptiveElements, getMoreInformation, getResourceList, getStakeholderCommissionedElements, getStakeholders, getSupportedByResource, removeReferenceable, setupAssignmentScope, setupMoreInformation, setupResource, setupStakeholder, updateRelationship

Methods inherited from class java.lang.Object

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

Constructor Detail

UserIdentityManagement

public UserIdentityManagement(String serverName,
                              String serverPlatformURLRoot)
                       throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - bad input parameters

UserIdentityManagement

public UserIdentityManagement(String serverName,
                              String serverPlatformURLRoot,
                              AuditLog auditLog)
                       throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

UserIdentityManagement

public UserIdentityManagement(String serverName,
                              String serverPlatformURLRoot,
                              String userId,
                              String password)
                       throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - bad input parameters

UserIdentityManagement

public UserIdentityManagement(String serverName,
                              String serverPlatformURLRoot,
                              String userId,
                              String password,
                              AuditLog auditLog)
                       throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - bad input parameters

UserIdentityManagement

public UserIdentityManagement(String serverName,
                              String serverPlatformURLRoot,
                              CommunityProfileRESTClient restClient,
                              int maxPageSize)
                       throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - there is a problem with the information about the remote OMAS

Method Detail

createUserIdentity

public String createUserIdentity(String userId,
                                 String externalSourceGUID,
                                 String externalSourceName,
                                 UserIdentityProperties newIdentity)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Create a UserIdentity. This is not connected to a profile.

Specified by:

createUserIdentity in interface UserIdentityManagementInterface

Parameters:

userId - the name of the calling user.

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

newIdentity - properties for the new userIdentity.

Returns:

unique identifier of the UserIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createUserIdentityForProfile

public String createUserIdentityForProfile(String userId,
                                           String externalSourceGUID,
                                           String externalSourceName,
                                           String profileGUID,
                                           UserIdentityProperties newIdentity)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Create a UserIdentity that is for the sole use of a specific actor profile. When the profile is deleted, the user identity is deleted.

Specified by:

createUserIdentityForProfile in interface UserIdentityManagementInterface

Parameters:

userId - the name of the calling user.

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

profileGUID - unique identifier of the profile

newIdentity - properties for the new userIdentity

Returns:

unique identifier of the UserIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateUserIdentity

public void updateUserIdentity(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String userIdentityGUID,
                               boolean isMergeUpdate,
                               UserIdentityProperties properties)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Update a UserIdentity.

Specified by:

updateUserIdentity in interface UserIdentityManagementInterface

Parameters:

userId - the name of the calling user

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

userIdentityGUID - unique identifier of the UserIdentity

isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false

properties - updated properties for the new userIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

deleteUserIdentity

public void deleteUserIdentity(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String userIdentityGUID)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Remove a user identity object.

Specified by:

deleteUserIdentity in interface UserIdentityManagementInterface

Parameters:

userId - the name of the calling user

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

userIdentityGUID - unique identifier of the UserIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addIdentityToProfile

public void addIdentityToProfile(String userId,
                                 String externalSourceGUID,
                                 String externalSourceName,
                                 String userIdentityGUID,
                                 String profileGUID,
                                 ProfileIdentityProperties properties)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Link a user identity to a profile.

Specified by:

addIdentityToProfile in interface UserIdentityManagementInterface

Parameters:

userId - the name of the calling user.

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

profileGUID - the profile to add the identity to.

userIdentityGUID - additional userId for the profile.

properties - the properties that describe how the owner of the profile uses the user identity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateProfileIdentity

public void updateProfileIdentity(String userId,
                                  String externalSourceGUID,
                                  String externalSourceName,
                                  String userIdentityGUID,
                                  String profileGUID,
                                  boolean isMergeUpdate,
                                  ProfileIdentityProperties properties)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Update the properties of the relationship between a user identity and profile.

Specified by:

updateProfileIdentity in interface UserIdentityManagementInterface

Parameters:

userId - the name of the calling user

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

userIdentityGUID - additional userId for the profile

profileGUID - the profile to add the identity to

isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false

properties - the properties that describe how the owner of the profile uses the user identity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeIdentityFromProfile

public void removeIdentityFromProfile(String userId,
                                      String externalSourceGUID,
                                      String externalSourceName,
                                      String userIdentityGUID,
                                      String profileGUID)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Unlink a user identity from a profile.

Specified by:

removeIdentityFromProfile in interface UserIdentityManagementInterface

Parameters:

userId - the name of the calling user.

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

userIdentityGUID - unique identifier of the UserIdentity

profileGUID - profile to remove it from.

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findUserIdentities

public List<UserIdentityElement> findUserIdentities(String userId,
                                                    String searchString,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Retrieve the list of user identity metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findUserIdentities in interface UserIdentityManagementInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getUserIdentitiesByName

public List<UserIdentityElement> getUserIdentitiesByName(String userId,
                                                         String name,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Retrieve the list of user identity metadata elements with a matching qualified name. There are no wildcards supported on this request.

Specified by:

getUserIdentitiesByName in interface UserIdentityManagementInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getUserIdentityByGUID

public UserIdentityElement getUserIdentityByGUID(String userId,
                                                 String userIdentityGUID)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Retrieve the userIdentity metadata element with the supplied unique identifier.

Specified by:

getUserIdentityByGUID in interface UserIdentityManagementInterface

Parameters:

userId - calling user

userIdentityGUID - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)