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

Class CommunityRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.server.CommunityRESTServices
public class CommunityRESTServices extends Object
CommunityRESTServices provides the API operations to create and maintain community information.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommunityRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearCommunityRole(String serverName, String userId, String communityGUID, String communityRoleGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
    Remove a relationship between a community and a role.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createCommunity(String serverName, String userId, org.odpi.openmetadata.accessservices.communityprofile.rest.ReferenceableRequestBody requestBody)
    Create a new metadata element to represent a community.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createCommunityFromTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a community using an existing metadata element as a template.
    org.odpi.openmetadata.accessservices.communityprofile.rest.CommunityListResponse
    findCommunities(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of community metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.communityprofile.rest.CommunityListResponse
    getCommunities(String serverName, String userId, int startFrom, int pageSize)
    Retrieve the list of community metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.communityprofile.rest.CommunityListResponse
    getCommunitiesByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of community metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.communityprofile.rest.CommunityResponse
    getCommunityByGUID(String serverName, String userId, String guid)
    Retrieve the community metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.communityprofile.rest.PersonRoleListResponse
    getRolesForCommunity(String serverName, String userId, String communityGUID, int startFrom, int pageSize)
    Return information about a person role connected to the named community.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeCommunity(String serverName, String userId, String communityGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
    Remove the metadata element representing a community.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupCommunityRole(String serverName, String userId, String communityGUID, String communityRoleGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
    Create a relationship between a community and a person role.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateCommunity(String serverName, String userId, String communityGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.communityprofile.rest.ReferenceableRequestBody requestBody)
    Update the metadata element representing a community.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CommunityRESTServices

      public CommunityRESTServices()
      Default constructor

  • Method Details

    • createCommunity

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createCommunity(String serverName, String userId, org.odpi.openmetadata.accessservices.communityprofile.rest.ReferenceableRequestBody requestBody)
      Create a new metadata element to represent a community.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - properties to store
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createCommunityFromTemplate

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createCommunityFromTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.TemplateRequestBody requestBody)
      Create a new metadata element to represent a community using an existing metadata element as a template.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateCommunity

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateCommunity(String serverName, String userId, String communityGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.communityprofile.rest.ReferenceableRequestBody requestBody)
      Update the metadata element representing a community.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      communityGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with the existing properties of overlay them?
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupCommunityRole

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupCommunityRole(String serverName, String userId, String communityGUID, String communityRoleGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.RelationshipRequestBody requestBody)
      Create a relationship between a community and a person role.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      communityGUID - unique identifier of the community in the external data manager
      communityRoleGUID - unique identifier of the person role in the external data manager
      requestBody - relationship properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearCommunityRole

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearCommunityRole(String serverName, String userId, String communityGUID, String communityRoleGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
      Remove a relationship between a community and a role.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      communityGUID - unique identifier of the community in the external data manager
      communityRoleGUID - unique identifier of the role in the external data manager
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • removeCommunity

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeCommunity(String serverName, String userId, String communityGUID, org.odpi.openmetadata.accessservices.communityprofile.rest.ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a community.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      communityGUID - unique identifier of the metadata element to remove
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findCommunities

      public org.odpi.openmetadata.accessservices.communityprofile.rest.CommunityListResponse findCommunities(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of community metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getCommunitiesByName

      public org.odpi.openmetadata.accessservices.communityprofile.rest.CommunityListResponse getCommunitiesByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of community metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getRolesForCommunity

      public org.odpi.openmetadata.accessservices.communityprofile.rest.PersonRoleListResponse getRolesForCommunity(String serverName, String userId, String communityGUID, int startFrom, int pageSize)
      Return information about a person role connected to the named community.
      Parameters:
      serverName - called server
      userId - calling user
      communityGUID - unique identifier for the community
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching person roles InvalidParameterException name or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCommunities

      public org.odpi.openmetadata.accessservices.communityprofile.rest.CommunityListResponse getCommunities(String serverName, String userId, int startFrom, int pageSize)
      Retrieve the list of community metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getCommunityByGUID

      public org.odpi.openmetadata.accessservices.communityprofile.rest.CommunityResponse getCommunityByGUID(String serverName, String userId, String guid)
      Retrieve the community metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)