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

Class GroupConfigurationResource

java.lang.Object
org.odpi.openmetadata.accessservices.governanceengine.server.spring.GroupConfigurationResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/governance-engine/users/{userId}") public class GroupConfigurationResource extends Object
GroupConfigurationResource provides the Spring wrapper for the Integration Group Configuration Services

  • Constructor Details

    • GroupConfigurationResource

      public GroupConfigurationResource()

  • Method Details

    • createIntegrationGroup

      @PostMapping(path="/integration-groups/new") public GUIDResponse createIntegrationGroup(@PathVariable String serverName, @PathVariable String userId, @RequestBody IntegrationGroupProperties requestBody)
      Create a new integration group definition.
      Parameters:
      serverName - name of the service to route the request to
      userId - identifier of calling user
      requestBody - containing properties of integration group.
      Returns:
      unique identifier (guid) of the integration group definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getIntegrationGroupByGUID

      @GetMapping(path="/integration-groups/{guid}") public IntegrationGroupElementResponse getIntegrationGroupByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the properties from an integration group definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier (guid) of the integration group definition.
      Returns:
      properties from the integration group definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getIntegrationGroupByName

      @GetMapping(path="/integration-groups/by-name/{name}") public IntegrationGroupElementResponse getIntegrationGroupByName(@PathVariable String serverName, @PathVariable String userId, @PathVariable String name)
      Return the properties from an integration group definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      name - qualified name or display name (if unique).
      Returns:
      properties from the integration group definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getAllIntegrationGroups

      @GetMapping(path="/integration-groups") public IntegrationGroupElementsResponse getAllIntegrationGroups(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the list of integration group definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of integration group definitions or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • updateIntegrationGroup

      @PostMapping(path="/integration-groups/{guid}/update") public VoidResponse updateIntegrationGroup(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestParam boolean isMergeUpdate, @RequestBody IntegrationGroupProperties requestBody)
      Update the properties of an existing integration group definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier of the integration group - used to locate the definition.
      isMergeUpdate - should the supplied properties be merged with existing properties (true) only replacing the properties with matching names, or should the entire properties of the instance be replaced?
      requestBody - containing the new properties of the integration group.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • deleteIntegrationGroup

      @PostMapping(path="/integration-groups/{guid}/delete") public VoidResponse deleteIntegrationGroup(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody DeleteRequestBody requestBody)
      Remove the properties of the integration group. Both the guid and the qualified name is supplied to validate that the correct integration group is being deleted.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier of the integration group - used to locate the definition.
      requestBody - containing the unique name for the integration group.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • createIntegrationConnector

      @PostMapping(path="/integration-connectors/new") public GUIDResponse createIntegrationConnector(@PathVariable String serverName, @PathVariable String userId, @RequestBody IntegrationConnectorProperties requestBody)
      Create an integration connector definition. The same integration connector can be associated with multiple integration groups.
      Parameters:
      serverName - name of the service to route the request to
      userId - identifier of calling user
      requestBody - containing: qualifiedName - unique name for the integration connector; displayName - display name for the integration connector; description - description of the analysis provided by the integration connector; connection - connection to instantiate the integration connector implementation.
      Returns:
      unique identifier of the integration connector or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getIntegrationConnectorByGUID

      @GetMapping(path="/integration-connectors/{guid}") public IntegrationConnectorElementResponse getIntegrationConnectorByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the properties from an integration connector definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier (guid) of the integration connector definition.
      Returns:
      properties of the integration connector or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getIntegrationConnectorByName

      @GetMapping(path="/integration-connectors/by-name/{name}") public IntegrationConnectorElementResponse getIntegrationConnectorByName(@PathVariable String serverName, @PathVariable String userId, @PathVariable String name)
      Return the properties from an integration connector definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      name - qualified name or display name (if unique).
      Returns:
      properties from the integration group definition or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getAllIntegrationConnectors

      @GetMapping(path="/integration-connectors") public IntegrationConnectorElementsResponse getAllIntegrationConnectors(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the list of integration connectors definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of integration connector definitions or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getIntegrationConnectorRegistrations

      @GetMapping(path="/integration-connectors/{guid}/registrations") public GUIDListResponse getIntegrationConnectorRegistrations(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Return the list of integration groups that a specific integration connector is registered with.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - integration connector to search for.
      Returns:
      list of integration group unique identifiers (guids) or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • updateIntegrationConnector

      @PostMapping(path="/integration-connectors/{guid}/update") public VoidResponse updateIntegrationConnector(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestParam boolean isMergeUpdate, @RequestBody IntegrationConnectorProperties requestBody)
      Update the properties of an existing integration connector definition.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier of the integration connector - used to locate the definition.
      isMergeUpdate - should the supplied properties be merged with existing properties (true) only replacing the properties with matching names, or should the entire properties of the instance be replaced?
      requestBody - containing the new parameters for the integration connector.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • deleteIntegrationConnector

      @PostMapping(path="/integration-connectors/{guid}/delete") public VoidResponse deleteIntegrationConnector(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody DeleteRequestBody requestBody)
      Remove the properties of the integration connector. Both the guid and the qualified name is supplied to validate that the correct integration connector is being deleted. The integration connector is also unregistered from its integration groups.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      guid - unique identifier of the integration connector - used to locate the definition.
      requestBody - containing the unique name for the integration connector.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • registerIntegrationConnectorWithGroup

      @PostMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors/{integrationConnectorGUID}") public VoidResponse registerIntegrationConnectorWithGroup(@PathVariable String serverName, @PathVariable String userId, @PathVariable String integrationGroupGUID, @PathVariable String integrationConnectorGUID, @RequestBody RegisteredIntegrationConnectorProperties requestBody)
      Register an integration connector with a specific integration group.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      requestBody - containing: integrationGroupGUID - unique identifier of the integration connector; governanceRequestTypes - list of asset governance types that this integration connector is able to process.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getRegisteredIntegrationConnector

      @GetMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors/{integrationConnectorGUID}") public RegisteredIntegrationConnectorResponse getRegisteredIntegrationConnector(@PathVariable String serverName, @PathVariable String userId, @PathVariable String integrationGroupGUID, @PathVariable String integrationConnectorGUID)
      Retrieve a specific integration connector registered with an integration group.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      Returns:
      details of the integration connector and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • getRegisteredIntegrationConnectors

      @GetMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors") public RegisteredIntegrationConnectorsResponse getRegisteredIntegrationConnectors(@PathVariable String serverName, @PathVariable String userId, @PathVariable String integrationGroupGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Retrieve the details of the integration connectors registered with an integration group.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • unregisterIntegrationConnectorFromGroup

      @PostMapping(path="/integration-groups/{integrationGroupGUID}/integration-connectors/{integrationConnectorGUID}/delete") public VoidResponse unregisterIntegrationConnectorFromGroup(@PathVariable String serverName, @PathVariable String userId, @PathVariable String integrationGroupGUID, @PathVariable String integrationConnectorGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Unregister an integration connector from the integration group.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration group definition.

    • addCatalogTarget

      @PostMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets/{metadataElementGUID}") public GUIDResponse addCatalogTarget(@PathVariable String serverName, @PathVariable String userId, @PathVariable String integrationConnectorGUID, @PathVariable String metadataElementGUID, @RequestBody CatalogTargetProperties requestBody)
      Add a catalog target to an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      requestBody - properties for the relationship.
      Returns:
      guid or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • updateCatalogTarget

      @PostMapping(path="/catalog-targets/{relationshipGUID}/update") public VoidResponse updateCatalogTarget(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody CatalogTargetProperties requestBody)
      Update a catalog target for an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the metadata element that is a catalog target.
      requestBody - properties for the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • getCatalogTarget

      @GetMapping(path="/catalog-targets/{relationshipGUID}") public CatalogTargetResponse getCatalogTarget(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipGUID)
      Retrieve a specific catalog target associated with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the relationship that is a catalog target.
      Returns:
      details of the governance service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getCatalogTargets

      @GetMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets") public CatalogTargetsResponse getCatalogTargets(@PathVariable String serverName, @PathVariable String userId, @PathVariable String integrationConnectorGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Retrieve the details of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      integrationConnectorGUID - unique identifier of the integration connector.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • removeCatalogTarget

      @PostMapping(path="/catalog-targets/{relationshipGUID}/delete") public VoidResponse removeCatalogTarget(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipGUID, @RequestBody NullRequestBody requestBody)
      Unregister a catalog target from the integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the governance service.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.