org.odpi.openmetadata.accessservices.communityprofile.client

Class MyProfileManagement

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.client.MyProfileManagement

All Implemented Interfaces:

MyPersonalProfileInterface

public class MyProfileManagement
extends Object
implements MyPersonalProfileInterface

This client covers the management of a user's personal profile.

Constructor Summary

Constructors

Constructor and Description
MyProfileManagement(String serverName, String omasServerURL) Create a new client with no authentication embedded in the HTTP request.
MyProfileManagement(String serverName, String omasServerURL, String userId, String password) Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method and Description
String	addContactMethod(String userId, ContactMethodType type, String service, String value) Add a new contact method to the requesting user's profile.
void	addToMyAssets(String userId, String assetGUID) Add an asset to the identified user's list of favorite assets.
void	deleteContactMethod(String userId, String contactMethodGUID, ContactMethodType type) Remove an obsolete contact method from the requesting user's profile.
void	deleteMyProfile(String userId, String qualifiedName) Create or update the profile for the requesting user.
List<AssetCollectionMember>	getMyAssets(String userId, int startFrom, int pageSize) Return a list of assets that the specified user has added to their favorites list.
List<ContactMethod>	getMyContactDetails(String UserId) Return the list of contact methods for this user.
int	getMyKarmaPoints(String userId) Return the total karma points for this user.
PersonalProfile	getMyProfile(String userId) Return the profile for this user.
void	removeFromMyAssets(String userId, String assetGUID) Remove an asset from identified user's list of favorite assets.
void	setUpMyProfile(String userId, String qualifiedName, String fullName, String knownName, String jobTitle, String jobRoleDescription, List<ContactMethod> contactDetails, Map<String,String> additionalProperties) Create or update the profile for the requesting user.
void	setUpMyProfile(String userId, String qualifiedName, String fullName, String knownName, String jobTitle, String jobRoleDescription, Map<String,Object> profileProperties, Map<String,String> additionalProperties) Create or update the profile for the requesting user.

Methods inherited from class java.lang.Object

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

Constructor Detail

MyProfileManagement

public MyProfileManagement(String serverName,
                           String omasServerURL)

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

Parameters:

serverName - name of the server to connect to

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

MyProfileManagement

public MyProfileManagement(String serverName,
                           String omasServerURL,
                           String userId,
                           String password)

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

omasServerURL - 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

Method Detail

getMyProfile

public PersonalProfile getMyProfile(String userId)
                             throws InvalidParameterException,
                                    NoProfileForUserException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Return the profile for this user.

Specified by:

getMyProfile in interface MyPersonalProfileInterface

Parameters:

userId - userId of the user making the request.

Returns:

profile object

Throws:

InvalidParameterException - the userId is null or invalid.

NoProfileForUserException - the user does not have a profile.

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

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

getMyKarmaPoints

public int getMyKarmaPoints(String userId)
                     throws InvalidParameterException,
                            NoProfileForUserException,
                            PropertyServerException,
                            UserNotAuthorizedException

Return the total karma points for this user.

Specified by:

getMyKarmaPoints in interface MyPersonalProfileInterface

Parameters:

userId - userId of the user making the request.

Returns:

int

Throws:

InvalidParameterException - the userId is null or invalid.

NoProfileForUserException - the user does not have a profile.

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

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

setUpMyProfile

public void setUpMyProfile(String userId,
                           String qualifiedName,
                           String fullName,
                           String knownName,
                           String jobTitle,
                           String jobRoleDescription,
                           Map<String,Object> profileProperties,
                           Map<String,String> additionalProperties)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Create or update the profile for the requesting user.

Parameters:

qualifiedName - 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.

profileProperties - properties about the individual for a new type that is the subclass of Person.

additionalProperties - additional properties about the individual.

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.

deleteMyProfile

public void deleteMyProfile(String userId,
                            String qualifiedName)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException

Create or update the profile for the requesting user.

Specified by:

deleteMyProfile in interface MyPersonalProfileInterface

Parameters:

userId - the name of the calling user.

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.

getMyContactDetails

public List<ContactMethod> getMyContactDetails(String UserId)
                                        throws InvalidParameterException,
                                               NoProfileForUserException,
                                               PropertyServerException,
                                               UserNotAuthorizedException

Return the list of contact methods for this user.

Specified by:

getMyContactDetails in interface MyPersonalProfileInterface

Parameters:

UserId - userId of the user making the request.

Returns:

list of contact methods

Throws:

InvalidParameterException - the userId is null or invalid.

NoProfileForUserException - the user does not have a profile.

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

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

setUpMyProfile

public void setUpMyProfile(String userId,
                           String qualifiedName,
                           String fullName,
                           String knownName,
                           String jobTitle,
                           String jobRoleDescription,
                           List<ContactMethod> contactDetails,
                           Map<String,String> additionalProperties)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Create or update the profile for the requesting user. This is only permitted if the profile is not locked to (managed by) an external system.

Specified by:

setUpMyProfile in interface MyPersonalProfileInterface

Parameters:

userId - the name of the calling user.

qualifiedName - 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.

contactDetails - list of contact methods for the person.

additionalProperties - additional properties about the individual.

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.

addContactMethod

public String addContactMethod(String userId,
                               ContactMethodType type,
                               String service,
                               String value)
                        throws InvalidParameterException,
                               NoProfileForUserException,
                               PropertyServerException,
                               UserNotAuthorizedException

Add a new contact method to the requesting user's profile.

Specified by:

addContactMethod in interface MyPersonalProfileInterface

Parameters:

userId - the name of the calling user.

type - type of contact method.

service - service for the contact method.

value - account name for the service.

Returns:

unique identifier (guid) for the new contact method.

Throws:

InvalidParameterException - the userId is null or invalid. Another property is invalid.

NoProfileForUserException - the user does not have a profile.

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

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

deleteContactMethod

public void deleteContactMethod(String userId,
                                String contactMethodGUID,
                                ContactMethodType type)
                         throws InvalidParameterException,
                                NoProfileForUserException,
                                PropertyServerException,
                                UserNotAuthorizedException

Remove an obsolete contact method from the requesting user's profile.

Specified by:

deleteContactMethod in interface MyPersonalProfileInterface

Parameters:

userId - the name of the calling user.

contactMethodGUID - unique identifier (guid) for the obsolete contact method.

type - type of contact method. This is used to confirm that the GUID is the right one.

Throws:

InvalidParameterException - the userId is null or invalid. Another property is invalid.

NoProfileForUserException - the user does not have a profile.

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

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

getMyAssets

public List<AssetCollectionMember> getMyAssets(String userId,
                                               int startFrom,
                                               int pageSize)
                                        throws InvalidParameterException,
                                               NoProfileForUserException,
                                               PropertyServerException,
                                               UserNotAuthorizedException

Return a list of assets that the specified user has added to their favorites list.

Parameters:

userId - userId of user making request.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of asset details

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

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

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

addToMyAssets

public void addToMyAssets(String userId,
                          String assetGUID)
                   throws InvalidParameterException,
                          NoProfileForUserException,
                          PropertyServerException,
                          UserNotAuthorizedException

Add an asset to the identified user's list of favorite assets.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier of the asset.

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

PropertyServerException - there is a problem updating information in the property server(s).

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

removeFromMyAssets

public void removeFromMyAssets(String userId,
                               String assetGUID)
                        throws InvalidParameterException,
                               NoProfileForUserException,
                               PropertyServerException,
                               UserNotAuthorizedException

Remove an asset from identified user's list of favorite assets.

Parameters:

userId - userId of user making request.

assetGUID - unique identifier of the asset.

Throws:

InvalidParameterException - one of the parameters is invalid.

NoProfileForUserException - the user does not have a profile so can not have any asset collections.

PropertyServerException - there is a problem updating information in the property server(s).

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