Package org.odpi.openmetadata.viewservices.myprofile.server

Class MyProfileRESTServices

java.lang.Object

org.odpi.openmetadata.tokencontroller.TokenController

org.odpi.openmetadata.viewservices.myprofile.server.MyProfileRESTServices

public class MyProfileRESTServices
extends TokenController

The MyProfileRESTServices provides the server-side implementation of the My Profile Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

Constructor Summary

Constructors

Constructor	Description
MyProfileRESTServices()	Default constructor

Method Summary

Modifier and Type	Method	Description
GUIDResponse	addMyProfile(String serverName, NewElementRequestBody requestBody)	Add the profile for this user.
GUIDResponse	blogMyActivity(String serverName, NewAttachmentRequestBody requestBody)	Add the supplied notification to the user's blog.
OpenMetadataRootElementsResponse	getMyActors(String serverName, ResultsRequestBody requestBody)	Return the list of actors linked to the user's profile.
OpenMetadataRootElementsResponse	getMyAssignedActions(String serverName, boolean includeUserIds, boolean includeRoles, ActivityStatusRequestBody requestBody)	Return the list of actions that have been assigned to the user's profile, roles, or user identity.
OpenMetadataRootElementResponse	getMyProfile(String serverName, GetRequestBody requestBody)	Return the profile for this user.
OpenMetadataRootElementsResponse	getMyRequestedActions(String serverName, boolean includeUserIds, boolean includeRoles, ActivityStatusRequestBody requestBody)	Return the list of actions linked to the user's profile, roles, or user identity that this user has sponsored.
OpenMetadataRootElementsResponse	getMyResources(String serverName, boolean includeUserIds, boolean includeRoles, ResultsRequestBody requestBody)	Return the list of assigned resources linked to the user's profile.
OpenMetadataRootElementsResponse	getMyRoles(String serverName, ResultsRequestBody requestBody)	Return the list of assigned roles linked to the user's profile.
OpenMetadataRootElementsResponse	getMySponsoredActions(String serverName, boolean includeUserIds, boolean includeRoles, ActivityStatusRequestBody requestBody)	Return the list of actions linked to the user's profile, roles, or user identity that this user has sponsored.
OpenMetadataRootElementsResponse	getMyUserIdentities(String serverName, ResultsRequestBody requestBody)	Return the list of user identities linked to the user's profile.
GUIDResponse	journalMyActivity(String serverName, NewAttachmentRequestBody requestBody)	Add the supplied notification to the user's journal.
GUIDResponse	logMyActivity(String serverName, NewAttachmentRequestBody requestBody)	Add the profile for this user.

Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController

getUser

Methods inherited from class java.lang.Object

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

Constructor Details

MyProfileRESTServices

public MyProfileRESTServices()

Default constructor

Method Details

getMyProfile

public OpenMetadataRootElementResponse getMyProfile(String serverName,
 GetRequestBody requestBody)

Return the profile for this user.

Parameters:

serverName - name of the server instances for this request

requestBody - optional properties to restrict search by and control how the results are formatted

Returns:

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

getMyAssignedActions

public OpenMetadataRootElementsResponse getMyAssignedActions(String serverName,
 boolean includeUserIds,
 boolean includeRoles,
 ActivityStatusRequestBody requestBody)

Return the list of actions that have been assigned to the user's profile, roles, or user identity.

Parameters:

serverName - name of the server instances for this request

includeUserIds - get actions for linked userIds

includeRoles - get actions for linked roles

requestBody - optional properties to restrict search by and control how the results are formatted

Returns:

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

getMySponsoredActions

public OpenMetadataRootElementsResponse getMySponsoredActions(String serverName,
 boolean includeUserIds,
 boolean includeRoles,
 ActivityStatusRequestBody requestBody)

Return the list of actions linked to the user's profile, roles, or user identity that this user has sponsored.

Parameters:

serverName - name of the server instances for this request

includeUserIds - get actions for linked userIds

includeRoles - get actions for linked roles

requestBody - optional properties to restrict search by and control how the results are formatted

Returns:

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

getMyRequestedActions

public OpenMetadataRootElementsResponse getMyRequestedActions(String serverName,
 boolean includeUserIds,
 boolean includeRoles,
 ActivityStatusRequestBody requestBody)

Return the list of actions linked to the user's profile, roles, or user identity that this user has sponsored.

Parameters:

serverName - name of the server instances for this request

includeUserIds - get actions for linked userIds

includeRoles - get actions for linked roles

requestBody - optional properties to restrict search by and control how the results are formatted

Returns:

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

getMyActors

public OpenMetadataRootElementsResponse getMyActors(String serverName,
 ResultsRequestBody requestBody)

Return the list of actors linked to the user's profile.

Parameters:

serverName - name of the server instances for this request

requestBody - optional properties to restrict search by and control how the results are formatted

Returns:

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

getMyUserIdentities

public OpenMetadataRootElementsResponse getMyUserIdentities(String serverName,
 ResultsRequestBody requestBody)

Return the list of user identities linked to the user's profile.

Parameters:

serverName - name of the server instances for this request

requestBody - optional properties to restrict search by and control how the results are formatted

Returns:

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

getMyRoles

public OpenMetadataRootElementsResponse getMyRoles(String serverName,
 ResultsRequestBody requestBody)

Return the list of assigned roles linked to the user's profile.

Parameters:

serverName - name of the server instances for this request

requestBody - optional properties to restrict search by and control how the results are formatted

Returns:

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

getMyResources

public OpenMetadataRootElementsResponse getMyResources(String serverName,
 boolean includeUserIds,
 boolean includeRoles,
 ResultsRequestBody requestBody)

Return the list of assigned resources linked to the user's profile.

Parameters:

serverName - name of the server instances for this request

includeUserIds - get actions for linked userIds

includeRoles - get actions for linked roles

requestBody - optional properties to restrict search by and control how the results are formatted

Returns:

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

logMyActivity

public GUIDResponse logMyActivity(String serverName,
 NewAttachmentRequestBody requestBody)

Add the profile for this user.

Parameters:

serverName - name of the server instances for this request

requestBody - properties for the profile

Returns:

unique identifier of new notification or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

blogMyActivity

public GUIDResponse blogMyActivity(String serverName,
 NewAttachmentRequestBody requestBody)

Add the supplied notification to the user's blog.

Parameters:

serverName - name of the server instances for this request

requestBody - properties for the profile

Returns:

unique identifier of new notification or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

journalMyActivity

public GUIDResponse journalMyActivity(String serverName,
 NewAttachmentRequestBody requestBody)

Add the supplied notification to the user's journal.

Parameters:

serverName - name of the server instances for this request

requestBody - properties for the profile

Returns:

unique identifier of new notification or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

addMyProfile

public GUIDResponse addMyProfile(String serverName,
 NewElementRequestBody requestBody)

Add the profile for this user.

Parameters:

serverName - name of the server instances for this request

requestBody - properties for the profile

Returns:

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