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 Details

    • MyProfileRESTServices

      public MyProfileRESTServices()
      Default constructor

  • Method Details

    • getMyProfile

      public OpenMetadataRootElementResponse getMyProfile(String serverName)
      Return the profile for this user.
      Parameters:
      serverName - name of the server instances for this request
      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, GetRequestBody requestBody)
      Return the list of actors linked to the user's profile.
      Parameters:
      serverName - name of the server instances for this request
      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, GetRequestBody requestBody)
      Return the list of user identities linked to the user's profile.
      Parameters:
      serverName - name of the server instances for this request
      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, GetRequestBody requestBody)
      Return the list of assigned roles linked to the user's profile.
      Parameters:
      serverName - name of the server instances for this request
      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, GetRequestBody requestBody)
      Return the list of assigned resources linked to the user's profile.
      Parameters:
      serverName - name of the server instances for this request
      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.

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