Class EngineHostConfigurationClient


  • public class EngineHostConfigurationClient
    extends GovernanceServerConfigurationClient
    EngineHostConfigurationClient provides the configuration services for Engine Host OMAG Servers. This involves creating a list of engine services.
    • Constructor Detail

      • EngineHostConfigurationClient

        public EngineHostConfigurationClient​(java.lang.String adminUserId,
                                             java.lang.String serverName,
                                             java.lang.String serverPlatformRootURL)
                                      throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        adminUserId - administrator's (end user's) userId to associate with calls.
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the admin services
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • EngineHostConfigurationClient

        public EngineHostConfigurationClient​(java.lang.String adminUserId,
                                             java.lang.String serverName,
                                             java.lang.String serverPlatformRootURL,
                                             java.lang.String connectionUserId,
                                             java.lang.String connectionPassword)
                                      throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.
        Parameters:
        adminUserId - administrator's (end user's) userId to associate with calls.
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the admin services
        connectionUserId - caller's system userId embedded in all HTTP requests
        connectionPassword - caller's system password embedded in all HTTP requests
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • Method Detail

      • getRegisteredEngineServices

        public java.util.List<RegisteredOMAGService> getRegisteredEngineServices()
                                                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the list of engine services for this server.
        Returns:
        list of engine service descriptions
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • getConfiguredEngineServices

        public java.util.List<RegisteredOMAGService> getConfiguredEngineServices()
                                                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the list of engine services for this server.
        Returns:
        list of engine service descriptions
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • getEngineHostServicesConfiguration

        public EngineHostServicesConfig getEngineHostServicesConfiguration()
                                                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the configuration for the complete engine host services in this server.
        Returns:
        response containing the engine host services configuration
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • getEngineServiceConfiguration

        public EngineServiceConfig getEngineServiceConfiguration​(java.lang.String serviceURLMarker)
                                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the configuration for the named engine service for this server.
        Parameters:
        serviceURLMarker - engine service name used in URL
        Returns:
        response containing the engine services configuration
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • setEngineDefinitionsClientConfig

        public void setEngineDefinitionsClientConfig​(OMAGServerClientConfig clientConfig)
                                              throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                     org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                     org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up the name and platform URL root for the metadata server running the Governance Engine OMAS that provides the governance engine definitions used by the engine services.
        Parameters:
        clientConfig - URL root and server name for the metadata server.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • configureEngineService

        public void configureEngineService​(java.lang.String serviceURLMarker,
                                           java.util.Map<java.lang.String,​java.lang.Object> engineServiceOptions,
                                           java.util.List<EngineConfig> engines)
                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable a single engine service.
        Parameters:
        serviceURLMarker - string indicating which engine service it is configuring
        engineServiceOptions - property name/value pairs used to configure the engine service
        engines - list of qualified names of the engines and optional user information
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • disableEngineService

        public void disableEngineService​(java.lang.String serviceURLMarker)
                                  throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable a single engine service.
        Parameters:
        serviceURLMarker - string indicating which engine service it is disabling
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • configureEngineService

        public void configureEngineService​(EngineServiceConfig serviceConfig)
                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Add configuration for a single engine service to the server's config document.
        Parameters:
        serviceConfig - all values to configure an engine service
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • setEngineServicesConfig

        public void setEngineServicesConfig​(java.util.List<EngineServiceConfig> engineServicesConfig)
                                     throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up the configuration for all the open metadata engine services (OMESs). This overrides the current values.
        Parameters:
        engineServicesConfig - list of configuration properties for each engine service.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • setEngineHostServicesConfig

        public void setEngineHostServicesConfig​(EngineHostServicesConfig engineHostServicesConfig)
                                         throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up the configuration for the Engine Host Services in an Engine Host OMAG Server in a single call. This overrides the current values.
        Parameters:
        engineHostServicesConfig - governance engine definition client config and list of configuration properties for each engine service.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • clearEngineHostServices

        public void clearEngineHostServices()
                                     throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Clear the configuration for the engine host services.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • clearEngineDefinitionsClientConfig

        public void clearEngineDefinitionsClientConfig()
                                                throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                       org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                       org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Clear the configuration for the metadata server that provides the governance engine definitions through the Governance Engine OMAS.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • clearAllEngineServices

        public void clearAllEngineServices()
                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable the engine services. This removes all configuration for the engine services in the engine host server.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • clearEngineService

        public void clearEngineService​(java.lang.String serviceURLMarker)
                                throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                       org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                       org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable the engine services. This removes all configuration for the engine host server.
        Parameters:
        serviceURLMarker - engine service name used in URL
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.