Package org.odpi.openmetadata.viewservices.communitymatters.server

Class CommunityMattersRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.communitymatters.server.CommunityMattersRESTServices
public class CommunityMattersRESTServices extends TokenController
The CommunityMattersRESTServices provides the server-side implementation of the Community Matters Open Metadata View Service (OMVS). This interface provides support for communities and their members.

  • Constructor Details

    • CommunityMattersRESTServices

      public CommunityMattersRESTServices()
      Default constructor

  • Method Details

    • createCommunity

      public GUIDResponse createCommunity(String serverName, NewElementRequestBody requestBody)
      Create a community.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the community.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createCommunityFromTemplate

      public GUIDResponse createCommunityFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a community using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateCommunity

      public VoidResponse updateCommunity(String serverName, String communityGUID, UpdateElementRequestBody requestBody)
      Update the properties of a community.
      Parameters:
      serverName - name of called server.
      communityGUID - unique identifier of the community (returned from create)
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteCommunity

      public VoidResponse deleteCommunity(String serverName, String communityGUID, DeleteRequestBody requestBody)
      Delete a community.
      Parameters:
      serverName - name of called server
      communityGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getCommunitiesByName

      public OpenMetadataRootElementsResponse getCommunitiesByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of community metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getCommunityByGUID

      public OpenMetadataRootElementResponse getCommunityByGUID(String serverName, String communityGUID, GetRequestBody requestBody)
      Retrieve the list of community metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      communityGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findCommunities

      public OpenMetadataRootElementsResponse findCommunities(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of community metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)