org.odpi.openmetadata.accessservices.communityprofile.server.spring

Class MyProfileResource

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.server.spring.MyProfileResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/community-profile/users/{userId}")
public class MyProfileResource
extends Object

The MyProfileResource provides part of the server-side implementation of the Community Profile Open Metadata Assess Service (OMAS). This interface provides access to an individual's personal profile and the management of a special collection linked to their profile called my-assets.

Constructor Summary

Constructors

Constructor and Description
MyProfileResource() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	addToMyAssets(String serverName, String userId, String assetGUID, NullRequestBody nullRequestBody) Add an asset to the identified user's list of favorite assets.
AssetListResponse	getMyAssets(String serverName, String userId, int startFrom, int pageSize) Return a list of assets that the specified user has added to their favorites list.
PersonalProfileResponse	getMyProfile(String serverName, String userId) Return the profile for this user.
VoidResponse	removeFromMyAssets(String serverName, String userId, String assetGUID, NullRequestBody nullRequestBody) Remove an asset from identified user's list of favorite assets.
VoidResponse	updateMyProfile(String serverName, String userId, MyProfileRequestBody requestBody) 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

MyProfileResource

public MyProfileResource()

Default constructor

Method Detail

getMyProfile

@RequestMapping(method=GET,
                path="/my-profile")
public PersonalProfileResponse getMyProfile(@PathVariable
                                                                                                            String serverName,
                                                                                                            @PathVariable
                                                                                                            String userId)

Return the profile for this user.

Parameters:

serverName - name of the server instances for this request

userId - userId of the user making the request.

Returns:

profile response object or InvalidParameterException the userId is null or invalid or NoProfileForUserException the user does not have a profile or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

updateMyProfile

@RequestMapping(method=POST,
                path="/my-profile")
public VoidResponse updateMyProfile(@PathVariable
                                                                                                     String serverName,
                                                                                                     @PathVariable
                                                                                                     String userId,
                                                                                                     @RequestBody
                                                                                                     MyProfileRequestBody requestBody)

Create or update the profile for the requesting user.

Parameters:

serverName - name of the server instances for this request

userId - the name of the calling user.

requestBody - properties for the new profile.

Returns:

void response or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getMyAssets

@RequestMapping(method=GET,
                path="/my-assets")
public AssetListResponse getMyAssets(@PathVariable
                                                                                                    String serverName,
                                                                                                    @PathVariable
                                                                                                    String userId,
                                                                                                    @RequestParam
                                                                                                    int startFrom,
                                                                                                    @RequestParam
                                                                                                    int pageSize)

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

Parameters:

serverName - name of the server instances for this request

userId - userId of user making request.

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

pageSize - maximum number of elements to return.

Returns:

list of asset details or InvalidParameterException one of the parameters is invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

addToMyAssets

@RequestMapping(method=POST,
                path="/my-assets/{assetGUID}")
public VoidResponse addToMyAssets(@PathVariable
                                                                                                              String serverName,
                                                                                                              @PathVariable
                                                                                                              String userId,
                                                                                                              @PathVariable
                                                                                                              String assetGUID,
                                                                                                              @RequestBody
                                                                                                              NullRequestBody nullRequestBody)

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

Parameters:

serverName - name of the server instances for this request

userId - userId of user making request.

assetGUID - unique identifier of the asset.

nullRequestBody - null request body

Returns:

void response or InvalidParameterException one of the parameters is invalid or PropertyServerException there is a problem updating information in the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

removeFromMyAssets

@RequestMapping(method=POST,
                path="/my-assets/{assetGUID}/delete")
public VoidResponse removeFromMyAssets(@PathVariable
                                                                                                                          String serverName,
                                                                                                                          @PathVariable
                                                                                                                          String userId,
                                                                                                                          @PathVariable
                                                                                                                          String assetGUID,
                                                                                                                          @RequestBody
                                                                                                                          NullRequestBody nullRequestBody)

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

Parameters:

serverName - name of the server instances for this request

userId - userId of user making request.

assetGUID - unique identifier of the asset.

nullRequestBody - null request body

Returns:

void response or InvalidParameterException one of the parameters is invalid or PropertyServerException there is a problem updating information in the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.