Package org.odpi.openmetadata.frameworkservices.gaf.server

Class GovernanceConfigRESTServices

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.server.GovernanceConfigRESTServices
public class GovernanceConfigRESTServices extends Object
The GovernanceConfigRESTServices provides the server-side implementation of the configuration services from the Open Governance Framework (ODF). These services configure governance engines and governance services.

  • Constructor Details

    • GovernanceConfigRESTServices

      public GovernanceConfigRESTServices()
      Default constructor

  • Method Details

    • createGovernanceEngine

      public GUIDResponse createGovernanceEngine(String serverName, String serviceURLMarker, String userId, String typeName, NewGovernanceEngineRequestBody requestBody)
      Create a new governance engine definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      typeName - type of governance engine
      requestBody - containing: qualifiedName - unique name for the governance engine; displayName - display name for messages and user interfaces; description - description of the types of governance services that wil be associated with this governance engine.
      Returns:
      unique identifier (guid) of the governance engine 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 governance engine definition.

    • getGovernanceEngineByGUID

      public GovernanceEngineElementResponse getGovernanceEngineByGUID(String serverName, String serviceURLMarker, String userId, String guid)
      Return the properties from a governance engine definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier (guid) of the governance engine definition.
      Returns:
      properties from the governance engine 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 governance engine definition.

    • getGovernanceEngineByName

      public GovernanceEngineElementResponse getGovernanceEngineByName(String serverName, String serviceURLMarker, String userId, NameRequestBody requestBody)
      Return the properties from a governance engine definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      requestBody - qualified name or display name (if unique).
      Returns:
      properties from the governance engine 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 governance engine definition.

    • getAllGovernanceEngines

      public GovernanceEngineElementsResponse getAllGovernanceEngines(String serverName, String serviceURLMarker, String userId, int startingFrom, int maximumResults)
      Return the list of governance engine definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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 governance engine 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 governance engine definition.

    • updateGovernanceEngine

      public VoidResponse updateGovernanceEngine(String serverName, String serviceURLMarker, String userId, String guid, UpdateGovernanceEngineRequestBody requestBody)
      Update the properties of an existing governance engine 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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the governance engine - used to locate the definition.
      requestBody - containing the new properties of the governance engine.
      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 governance engine definition.

    • deleteGovernanceEngine

      public VoidResponse deleteGovernanceEngine(String serverName, String serviceURLMarker, String userId, String guid, DeleteRequestBody requestBody)
      Remove the properties of the governance engine. Both the guid and the qualified name is supplied to validate that the correct governance engine is being deleted.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the governance engine - used to locate the definition.
      requestBody - containing the unique name for the governance engine.
      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 governance engine definition.

    • createGovernanceService

      public GUIDResponse createGovernanceService(String serverName, String serviceURLMarker, String userId, String typeName, NewGovernanceServiceRequestBody requestBody)
      Create a governance service definition. The same governance service can be associated with multiple governance engines.
      Parameters:
      serverName - name of the service to route the request to
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user
      typeName - type of governance service
      requestBody - containing: qualifiedName - unique name for the governance service; displayName - display name for the governance service; description - description of the analysis provided by the governance service; connection - connection to instantiate the governance service implementation.
      Returns:
      unique identifier of the governance service or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getGovernanceServiceByGUID

      public GovernanceServiceElementResponse getGovernanceServiceByGUID(String serverName, String serviceURLMarker, String userId, String guid)
      Return the properties from a governance service definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier (guid) of the governance service definition.
      Returns:
      properties of the governance service or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the governance engine definition.

    • getGovernanceServiceByName

      public GovernanceServiceElementResponse getGovernanceServiceByName(String serverName, String serviceURLMarker, String userId, NameRequestBody requestBody)
      Return the properties from a governance service definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      requestBody - qualified name or display name (if unique).
      Returns:
      properties from the governance engine 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 governance engine definition.

    • getAllGovernanceServices

      public GovernanceServiceElementsResponse getAllGovernanceServices(String serverName, String serviceURLMarker, String userId, int startingFrom, int maximumResults)
      Return the list of governance services definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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 governance service 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 governance engine definition.

    • getGovernanceServiceRegistrations

      public GUIDListResponse getGovernanceServiceRegistrations(String serverName, String serviceURLMarker, String userId, String governanceServiceGUID)
      Return the list of governance engines that a specific governance service is registered with.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceServiceGUID - governance service to search for.
      Returns:
      list of governance engine 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 governance engine definition.

    • updateGovernanceService

      public VoidResponse updateGovernanceService(String serverName, String serviceURLMarker, String userId, String guid, UpdateGovernanceServiceRequestBody requestBody)
      Update the properties of an existing governance service 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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the governance service - used to locate the definition.
      requestBody - containing the new parameters for the governance service.
      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 governance engine definition.

    • deleteGovernanceService

      public VoidResponse deleteGovernanceService(String serverName, String serviceURLMarker, String userId, String guid, DeleteRequestBody requestBody)
      Remove the properties of the governance service. Both the guid and the qualified name is supplied to validate that the correct governance service is being deleted. The governance service is also unregistered from its governance engines.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      guid - unique identifier of the governance service - used to locate the definition.
      requestBody - containing the unique name for the governance service.
      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 governance engine definition.

    • registerGovernanceServiceWithEngine

      public VoidResponse registerGovernanceServiceWithEngine(String serverName, String serviceURLMarker, String userId, String governanceEngineGUID, GovernanceServiceRegistrationRequestBody requestBody)
      Register a governance service with a specific governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      requestBody - containing: governanceServiceGUID - unique identifier of the governance service; governanceRequestTypes - list of asset types that this governance service 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 governance engine definition.

    • getRegisteredGovernanceService

      public RegisteredGovernanceServiceResponse getRegisteredGovernanceService(String serverName, String serviceURLMarker, String userId, String governanceEngineGUID, String governanceServiceGUID)
      Retrieve a specific governance service registered with a governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      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 governance engine definition.

    • getRegisteredGovernanceServices

      public RegisteredGovernanceServicesResponse getRegisteredGovernanceServices(String serverName, String serviceURLMarker, String userId, String governanceEngineGUID, int startingFrom, int maximumResults)
      Retrieve the identifiers of the governance services registered with a governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      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 governance engine definition.

    • unregisterGovernanceServiceRequestFromEngine

      public VoidResponse unregisterGovernanceServiceRequestFromEngine(String serverName, String serviceURLMarker, String userId, String requestType, String governanceEngineGUID, String governanceServiceGUID, NullRequestBody requestBody)
      Remove a request type for a governance service from the governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      requestType - calling request
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - 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 governance engine definition.

    • unregisterGovernanceServiceFromEngine

      public VoidResponse unregisterGovernanceServiceFromEngine(String serverName, String serviceURLMarker, String userId, String governanceEngineGUID, String governanceServiceGUID, NullRequestBody requestBody)
      Unregister a governance service from the governance engine.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - 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 governance engine definition.

    • createIntegrationGroup

      public GUIDResponse createIntegrationGroup(String serverName, String serviceURLMarker, String userId, IntegrationGroupProperties requestBody)
      Create a new integration group definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      requestBody - containing: qualifiedName - unique name for the integration group; displayName - display name for messages and user interfaces; description - description of the types of integration connectors that wil be associated with this 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

      public IntegrationGroupElementResponse getIntegrationGroupByGUID(String serverName, String serviceURLMarker, String userId, String guid)
      Return the properties from an integration group definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public IntegrationGroupElementResponse getIntegrationGroupByName(String serverName, String serviceURLMarker, String userId, String name)
      Return the properties from an integration group definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public IntegrationGroupElementsResponse getAllIntegrationGroups(String serverName, String serviceURLMarker, String userId, int startingFrom, int maximumResults)
      Return the list of integration group definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public VoidResponse updateIntegrationGroup(String serverName, String serviceURLMarker, String userId, String guid, boolean isMergeUpdate, 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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public VoidResponse deleteIntegrationGroup(String serverName, String serviceURLMarker, String userId, String guid, 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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public GUIDResponse createIntegrationConnector(String serverName, String serviceURLMarker, String userId, 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
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public IntegrationConnectorElementResponse getIntegrationConnectorByGUID(String serverName, String serviceURLMarker, String userId, String guid)
      Return the properties from an integration connector definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public IntegrationConnectorElementResponse getIntegrationConnectorByName(String serverName, String serviceURLMarker, String userId, String name)
      Return the properties from an integration connector definition.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public IntegrationConnectorElementsResponse getAllIntegrationConnectors(String serverName, String serviceURLMarker, String userId, int startingFrom, int maximumResults)
      Return the list of integration connectors definitions that are stored.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public GUIDListResponse getIntegrationConnectorRegistrations(String serverName, String serviceURLMarker, String userId, String integrationConnectorGUID)
      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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationConnectorGUID - 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

      public VoidResponse updateIntegrationConnector(String serverName, String serviceURLMarker, String userId, String guid, boolean isMergeUpdate, IntegrationConnectorProperties requestBody)
      Update the properties of an existing integration connector 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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public VoidResponse deleteIntegrationConnector(String serverName, String serviceURLMarker, String userId, String guid, 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.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public VoidResponse registerIntegrationConnectorWithGroup(String serverName, String serviceURLMarker, String userId, String integrationGroupGUID, String integrationConnectorGUID, RegisteredIntegrationConnectorProperties requestBody)
      Register an integration connector with a specific integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      requestBody - containing registration properties.
      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

      public RegisteredIntegrationConnectorResponse getRegisteredIntegrationConnector(String serverName, String serviceURLMarker, String userId, String integrationGroupGUID, String integrationConnectorGUID)
      Retrieve a specific integration connector registered with an integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public RegisteredIntegrationConnectorsResponse getRegisteredIntegrationConnectors(String serverName, String serviceURLMarker, String userId, String integrationGroupGUID, int startingFrom, int maximumResults)
      Retrieve the identifiers of the integration connectors registered with an integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public VoidResponse unregisterIntegrationConnectorFromGroup(String serverName, String serviceURLMarker, String userId, String integrationGroupGUID, String integrationConnectorGUID, NullRequestBody requestBody)
      Unregister an integration connector from the integration group.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public GUIDResponse addCatalogTarget(String serverName, String serviceURLMarker, String userId, String integrationConnectorGUID, String metadataElementGUID, CatalogTargetProperties requestBody)
      Add a catalog target to an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

      public VoidResponse updateCatalogTarget(String serverName, String serviceURLMarker, String userId, String relationshipGUID, CatalogTargetProperties requestBody)
      Update a catalog target for an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the integration service.
      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

      public CatalogTargetResponse getCatalogTarget(String serverName, String serviceURLMarker, String userId, String relationshipGUID)
      Retrieve a specific catalog target associated with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the relationship.
      Returns:
      details of the integration connector and the elements it is to catalog or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the integration connector definition.

    • getCatalogTargets

      public CatalogTargetsResponse getCatalogTargets(String serverName, String serviceURLMarker, String userId, String integrationConnectorGUID, int startingFrom, int maximumResults)
      Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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 retrieving the integration connector definition.

    • removeCatalogTarget

      public VoidResponse removeCatalogTarget(String serverName, String serviceURLMarker, String userId, String relationshipGUID, NullRequestBody requestBody)
      Unregister a catalog target from the integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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 retrieving/deleting the integration connector definition.