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

Class CommunityProfileResource

java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.server.spring.CommunityProfileResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/community-profile/users/{userId}") public class CommunityProfileResource extends Object
UserIdentityResource provides the APIs for maintaining user identities and their relationships with profiles.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommunityProfileResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addMasterDataManagerClassification(String serverName, String userId, String metadataSourceGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Update classification of the metadata source that is a master data manager for user profile information.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addUserAccessDirectoryClassification(String serverName, String userId, String metadataSourceGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Update classification of the metadata source that is providing a user access directory information such as the groups and access rights of a user Id.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addUserProfileManagerClassification(String serverName, String userId, String metadataSourceGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Update classification of the metadata source as being capable if managing user profiles.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createMetadataSource(String serverName, String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.softwarecapabilities.MetadataSourceProperties requestBody)
    Create information about the metadata source that is providing user profile information.
    org.odpi.openmetadata.commonservices.ffdc.rest.MetadataSourceResponse
    getMetadataSource(String serverName, String userId, String metadataSourceGUID)
    Retrieve the properties of the software server capability that describes a metadata source.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    getMetadataSourceGUID(String serverName, String userId, String qualifiedName)
    Retrieve the unique identifier of the software server capability that describes a metadata source.
    org.odpi.openmetadata.commonservices.ffdc.rest.OCFConnectionResponse
    getOutTopicConnection(String serverName, String userId, String callerId)
    Return the connection object for the Community Profile OMAS's out topic.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CommunityProfileResource

      public CommunityProfileResource()

  • Method Details

    • getOutTopicConnection

      @GetMapping(path="/topics/out-topic-connection/{callerId}") public org.odpi.openmetadata.commonservices.ffdc.rest.OCFConnectionResponse getOutTopicConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String callerId)
      Return the connection object for the Community Profile OMAS's out topic.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      callerId - unique identifier of the caller
      Returns:
      connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.

    • createMetadataSource

      @PostMapping(path="/metadata-sources") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createMetadataSource(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.frameworks.openmetadata.properties.softwarecapabilities.MetadataSourceProperties requestBody)
      Create information about the metadata source that is providing user profile information.
      Parameters:
      serverName - name of calling server
      userId - calling user
      requestBody - description of the metadata source
      Returns:
      unique identifier of the user profile manager's software server capability or InvalidParameterException the bean requestBody are invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • getMetadataSourceGUID

      @GetMapping(path="/metadata-sources/by-name/{qualifiedName}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse getMetadataSourceGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String qualifiedName)
      Retrieve the unique identifier of the software server capability that describes a metadata source. This could be a user profile manager, user access directory and/or a master data manager.
      Parameters:
      serverName - name of calling server
      userId - calling user
      qualifiedName - unique name of the metadata source
      Returns:
      unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • getMetadataSource

      @GetMapping(path="/metadata-sources/{metadataSourceGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.MetadataSourceResponse getMetadataSource(@PathVariable String serverName, @PathVariable String userId, @PathVariable String metadataSourceGUID)
      Retrieve the properties of the software server capability that describes a metadata source. This could be a user profile manager, user access directory and/or a master data manager.
      Parameters:
      serverName - name of calling server
      userId - calling user
      metadataSourceGUID - unique identifier of the metadata source
      Returns:
      unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • addUserProfileManagerClassification

      @PostMapping(path="/metadata-sources/{metadataSourceGUID}/user-profile-manager") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addUserProfileManagerClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String metadataSourceGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Update classification of the metadata source as being capable if managing user profiles.
      Parameters:
      serverName - name of calling server
      userId - calling user
      metadataSourceGUID - unique identifier of the metadata source
      requestBody - null request body
      Returns:
      void or InvalidParameterException the bean properties are invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • addUserAccessDirectoryClassification

      @PostMapping(path="/metadata-sources/{metadataSourceGUID}/user-access-directory") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addUserAccessDirectoryClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String metadataSourceGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Update classification of the metadata source that is providing a user access directory information such as the groups and access rights of a user Id.
      Parameters:
      serverName - name of calling server
      userId - calling user
      metadataSourceGUID - unique identifier of the metadata source
      requestBody - null request body
      Returns:
      void or InvalidParameterException the bean properties are invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • addMasterDataManagerClassification

      @PostMapping(path="/metadata-sources/{metadataSourceGUID}/master-data-manager") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addMasterDataManagerClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String metadataSourceGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Update classification of the metadata source that is a master data manager for user profile information.
      Parameters:
      serverName - name of calling server
      userId - calling user
      metadataSourceGUID - unique identifier of the metadata source
      requestBody - null request body
      Returns:
      void or InvalidParameterException the bean properties are invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server