Package org.odpi.openmetadata.frameworkservices.gaf.handlers

Class GovernanceEngineConfigurationHandler

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.handlers.GovernanceEngineConfigurationHandler
public class GovernanceEngineConfigurationHandler extends Object
GovernanceConfigurationHandler provides the open metadata server side implementation of GovernanceConfigurationServer which is part of the Open Governance Framework (ODF).

  • Constructor Details

    • GovernanceEngineConfigurationHandler

      public GovernanceEngineConfigurationHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)
      Construct the governance engine configuration handler caching the objects needed to operate within a single server instance.
      Parameters:
      serviceName - name of this service
      serverName - name of the local server
      invalidParameterHandler - handler for managing parameter errors
      repositoryHandler - manages calls to the repository services
      repositoryHelper - provides utilities for manipulating the repository services objects
      localServerUserId - userId for this server
      securityVerifier - open metadata security services verifier
      supportedZones - list of zones that the access service is allowed to serve B instances from.
      defaultZones - list of zones that the access service should set in all new B instances.
      publishZones - list of zones that the access service sets up in published B instances.
      auditLog - logging destination

  • Method Details

    • getGovernanceEngineByName

      public GovernanceEngineElement getGovernanceEngineByName(String userId, String name, List<String> serviceSupportedZones) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Return the properties from a governance engine definition. The governance engine definition is completely contained in a single entity that can be retrieved from the repository services and converted to a bean.
      Parameters:
      userId - identifier of calling user
      name - qualified name or display name (if unique).
      serviceSupportedZones - supported zones for calling service
      Returns:
      properties from the governance engine definition.
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem retrieving the governance engine definition.

    • getGovernanceServiceByGUID

      public GovernanceServiceElement getGovernanceServiceByGUID(String userId, String guid, List<String> serviceSupportedZones) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Return the properties from a governance service definition.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier (guid) of the governance service definition.
      serviceSupportedZones - supported zones for calling service
      Returns:
      properties of the governance service.
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem retrieving the governance service definition.

    • registerGovernanceServiceWithEngine

      public void registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String governanceRequestType, String serviceRequestType, Map<String,String> defaultAnalysisParameters, List<String> serviceSupportedZones) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Register a governance service with a specific governance engine. Both the governance service and the governance engine already exist, so it is just a question of creating a relationship between them.
      Parameters:
      userId - identifier of calling user
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      governanceRequestType - list of governance request types that this governance service is able to process.
      serviceRequestType - request type supported by the service
      defaultAnalysisParameters - list of analysis parameters that are passed to the governance service (via the governance context). These values can be overridden on the actual governance request.
      serviceSupportedZones - supported zones for calling service
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • getRegisteredGovernanceService

      public RegisteredGovernanceServiceElement getRegisteredGovernanceService(String userId, String governanceEngineGUID, String governanceServiceGUID, List<String> serviceSupportedZones) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve a specific governance service registrations with a particular governance engine.
      Parameters:
      userId - identifier of calling user
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the registered governance service.
      serviceSupportedZones - supported zones for calling service
      Returns:
      details of the governance service and the asset types it is registered for.
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • getRegisteredGovernanceServices

      public List<RegisteredGovernanceServiceElement> getRegisteredGovernanceServices(String userId, String governanceEngineGUID, int startingFrom, int maximumResults, List<String> serviceSupportedZones) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the identifiers of the registered governance services with a governance engine.
      Parameters:
      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.
      serviceSupportedZones - supported zones for calling service
      Returns:
      list of unique identifiers
      Throws:
      InvalidParameterException - one of the parameters is null or invalid.
      UserNotAuthorizedException - user not authorized to issue this request.
      PropertyServerException - problem retrieving the governance service and/or governance engine definitions.