org.odpi.openmetadata.accessservices.communityprofile.handlers

Class PersonalProfileHandler

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.handlers.PersonalProfileHandler

public class PersonalProfileHandler
extends Object

PersonalProfileHandler manages Person objects from the property server. It runs server-side in the Community Profile OMAS and retrieves entities and relationships through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor and Description
PersonalProfileHandler(String serviceName, String serverName, 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
String	createPersonalProfile(String userId, String profileUserId, String employeeNumber, String fullName, String knownName, String jobTitle, String jobRoleDescription, Map<String,String> additionalProperties, String methodName) Create a personal profile for an individual.
void	deletePersonalProfile(String userId, String profileGUID, String qualifiedName, String methodName) Delete the personal profile.
PersonalProfile	getPersonalProfile(String userId, EntityDetail personalProfileEntity, String methodName) Create a personal profile from an entity.
PersonalProfile	getPersonalProfile(String userId, String profileUserId, String methodName) Retrieve a personal profile for a userId.
PersonalProfile	getPersonalProfileByGUID(String userId, String profileGUID, String methodName) Retrieve a personal profile by guid.
PersonalProfile	getPersonalProfileByQualifiedName(String userId, String qualifiedName, String methodName) Retrieve a personal profile by personnel/serial/unique employee number of the individual.
List<PersonalProfile>	getPersonalProfilesByName(String userId, String name, int startFrom, int pageSize, String methodName) Return a list of candidate personal profiles for an individual.
void	updatePersonalProfile(String userId, String profileGUID, String qualifiedName, String fullName, String knownName, String jobTitle, String jobRoleDescription, Map<String,Object> extendedProperties, Map<String,String> additionalProperties, String methodName) Update properties for the personal properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonalProfileHandler

public PersonalProfileHandler(String serviceName,
                              String serverName,
                              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

serverName - name of this server instance

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

getPersonalProfile

public PersonalProfile getPersonalProfile(String userId,
                                          EntityDetail personalProfileEntity,
                                          String methodName)
                                   throws InvalidParameterException,
                                          PropertyServerException,
                                          UserNotAuthorizedException

Create a personal profile from an entity.

Parameters:

userId - calling userId

personalProfileEntity - principle entity of the profile.

methodName - calling method

Returns:

PersonalProfile bean or null if it does not exist.

Throws:

InvalidParameterException - one of the userIds is null

PropertyServerException - the metadata repository is not available

UserNotAuthorizedException - the user is not authorized to issue this request

getPersonalProfile

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

Retrieve a personal profile for a userId.

Parameters:

userId - calling userId

profileUserId - userId associated with the profile.

methodName - calling method

Returns:

PersonalProfile bean or null if it does not exist.

Throws:

InvalidParameterException - one of the userIds is null

PropertyServerException - the metadata repository is not available

UserNotAuthorizedException - the user is not authorized to issue this request

createPersonalProfile

public String createPersonalProfile(String userId,
                                    String profileUserId,
                                    String employeeNumber,
                                    String fullName,
                                    String knownName,
                                    String jobTitle,
                                    String jobRoleDescription,
                                    Map<String,String> additionalProperties,
                                    String methodName)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Create a personal profile for an individual. This profile is linked to a UserIdentity entity. If the UserIdentity does not exist then it is created as well.

Parameters:

userId - the name of the calling user.

profileUserId - userId of the individual whose profile this is.

employeeNumber - personnel/serial/unique employee number of the individual.

fullName - full name of the person.

knownName - known name or nickname of the individual.

jobTitle - job title of the individual.

jobRoleDescription - job description of the individual.

additionalProperties - additional properties about the individual.

methodName - calling method

Returns:

Unique identifier for the personal profile.

Throws:

InvalidParameterException - the qualified name or known name is null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

updatePersonalProfile

public void updatePersonalProfile(String userId,
                                  String profileGUID,
                                  String qualifiedName,
                                  String fullName,
                                  String knownName,
                                  String jobTitle,
                                  String jobRoleDescription,
                                  Map<String,Object> extendedProperties,
                                  Map<String,String> additionalProperties,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Update properties for the personal properties. Null values result in empty fields in the profile.

Parameters:

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

qualifiedName - personnel/serial/unique employee number of the individual. Used to verify the profileGUID.

fullName - full name of the person.

knownName - known name or nickname of the individual.

jobTitle - job title of the individual.

jobRoleDescription - job description of the individual.

extendedProperties - subtype properties.

additionalProperties - additional properties about the individual.

methodName - calling method

Throws:

InvalidParameterException - the full name is null or the qualifiedName does not match the profileGUID.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

deletePersonalProfile

public void deletePersonalProfile(String userId,
                                  String profileGUID,
                                  String qualifiedName,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Delete the personal profile.

Parameters:

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

qualifiedName - personnel/serial/unique employee number of the individual.

methodName - calling method

Throws:

InvalidParameterException - the employee number or full name is null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getPersonalProfileByGUID

public PersonalProfile getPersonalProfileByGUID(String userId,
                                                String profileGUID,
                                                String methodName)
                                         throws InvalidParameterException,
                                                PropertyServerException,
                                                UserNotAuthorizedException

Retrieve a personal profile by guid.

Parameters:

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

methodName - calling method

Returns:

personal profile object.

Throws:

InvalidParameterException - the unique identifier of the personal profile is either null or invalid.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getPersonalProfileByQualifiedName

public PersonalProfile getPersonalProfileByQualifiedName(String userId,
                                                         String qualifiedName,
                                                         String methodName)
                                                  throws InvalidParameterException,
                                                         PropertyServerException,
                                                         UserNotAuthorizedException

Retrieve a personal profile by personnel/serial/unique employee number of the individual.

Parameters:

userId - the name of the calling user.

qualifiedName - personnel/serial/unique employee number of the individual.

methodName - calling method

Returns:

personal profile object.

Throws:

InvalidParameterException - userId is null; the qualified name is null or not unique.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

getPersonalProfilesByName

public List<PersonalProfile> getPersonalProfilesByName(String userId,
                                                       String name,
                                                       int startFrom,
                                                       int pageSize,
                                                       String methodName)
                                                throws InvalidParameterException,
                                                       PropertyServerException,
                                                       UserNotAuthorizedException

Return a list of candidate personal profiles for an individual. It matches on full name and known name. The name may include wild card parameters.

Parameters:

userId - the name of the calling user.

name - name of individual.

startFrom - scan pointer

pageSize - maximum number of results

methodName - calling method

Returns:

list of personal profile objects.

Throws:

InvalidParameterException - the name is null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.