org.odpi.openmetadata.accessservices.communityprofile.handlers

Class UserIdentityHandler

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.handlers.UserIdentityHandler

public class UserIdentityHandler
extends Object

UserIdentityHandler is responsible for the management of UserIdentity type entities.

Constructor Summary

Constructors

Constructor and Description
UserIdentityHandler(String serviceName, InvalidParameterHandler invalidParameterHandler, OMRSRepositoryHelper repositoryHelper, RepositoryHandler repositoryHandler, RepositoryErrorHandler errorHandler) Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
void	addIdentityToProfile(String userId, String profileGUID, String newIdentity, String methodName) Link a user identity to a profile.
String	addUserIdentity(String userId, String profileUserId, String methodName) Add the UserIdentity entity for a PersonalProfile.
UserIdentity	getUserIdentity(EntityDetail userIdentityEntity) Create a userIdentity from an entity.
void	removeIdentityFromProfile(String userId, String profileGUID, String obsoleteIdentity, String methodName) Remove a user identity object.
void	removeUserIdentity(String userId, String obsoleteIdentity, String methodName) Remove a user identity object.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserIdentityHandler

public UserIdentityHandler(String serviceName,
                           InvalidParameterHandler invalidParameterHandler,
                           OMRSRepositoryHelper repositoryHelper,
                           RepositoryHandler repositoryHandler,
                           RepositoryErrorHandler errorHandler)

Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Parameters:

serviceName - name of the consuming service

invalidParameterHandler - handler for invalid parameters

repositoryHelper - helper used by the converters

repositoryHandler - handler for calling the repository services

errorHandler - handler for repository service errors

Method Detail

getUserIdentity

public UserIdentity getUserIdentity(EntityDetail userIdentityEntity)

Create a userIdentity from an entity.

Parameters:

userIdentityEntity - principle entity of the profile.

Returns:

UserIdentity bean or null if it does not exist.

addUserIdentity

public String addUserIdentity(String userId,
                              String profileUserId,
                              String methodName)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Add the UserIdentity entity for a PersonalProfile.

Parameters:

userId - userId of the calling user.

profileUserId - userId of the profile owner.

methodName - calling method.

Returns:

unique identifier of the user identity or null if it does not exist.

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 profileGUID,
                                 String newIdentity,
                                 String methodName)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException

Link a user identity to a profile. This will fail if the user identity is already connected to a profile.

Parameters:

userId - the name of the calling user.

profileGUID - the profile to add the identity to.

newIdentity - additional userId for the profile.

methodName - calling method.

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 profileGUID,
                                      String obsoleteIdentity,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Remove a user identity object. This will fail if the profile would be left without an associated user identity.

Parameters:

userId - the name of the calling user.

profileGUID - profile to remove it from.

obsoleteIdentity - user identity to remove.

methodName - calling method.

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.

removeUserIdentity

public void removeUserIdentity(String userId,
                               String obsoleteIdentity,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Remove a user identity object. This will fail if a profile would be left without an associated user identity.

Parameters:

userId - the name of the calling user.

obsoleteIdentity - user identity to remove.

methodName - calling method.

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.