Class ConfigurationManagementClient


  • public class ConfigurationManagementClient
    extends java.lang.Object
    ConfigurationManagementClient is able to issue calls to an OMAG Server Platform that manages configuration for OMAG Servers. This includes storing and retrieving configuration and deploying it between platforms.
    • Constructor Summary

      Constructors 
      Constructor Description
      ConfigurationManagementClient​(java.lang.String adminUserId, java.lang.String serverPlatformRootURL)
      Create a new client with no authentication embedded in the HTTP request.
      ConfigurationManagementClient​(java.lang.String adminUserId, java.lang.String serverPlatformRootURL, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
    • Constructor Detail

      • ConfigurationManagementClient

        public ConfigurationManagementClient​(java.lang.String adminUserId,
                                             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.
        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.
      • ConfigurationManagementClient

        public ConfigurationManagementClient​(java.lang.String adminUserId,
                                             java.lang.String serverPlatformRootURL,
                                             java.lang.String userId,
                                             java.lang.String password)
                                      throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        adminUserId - administrator's (end user's) userId to associate with calls.
        serverPlatformRootURL - the network address of the server running the admin services
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId 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

      • getAllServerConfigurations

        public java.util.Set<OMAGServerConfig> getAllServerConfigurations()
                                                                   throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException,
                                                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Return all the OMAG Server configurations that are stored on this platform.
        Returns:
        the OMAG Server configurations that are stored on this platform
        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.
      • setOMAGServerConfig

        public void setOMAGServerConfig​(OMAGServerConfig serverConfig)
                                 throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException,
                                        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Set up the configuration properties for an OMAG Server in a single command.
        Parameters:
        serverConfig - configuration for the 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.OMAGConfigurationErrorException - something went wrong with the REST call stack.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid serverName or destinationPlatform parameter.
      • deployOMAGServerConfig

        public void deployOMAGServerConfig​(java.lang.String serverName,
                                           java.lang.String destinationPlatformURLRoot)
                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Push the configuration for the server to another OMAG Server Platform.
        Parameters:
        serverName - local server name
        destinationPlatformURLRoot - location of the platform where the config is to be deployed to
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid serverName or destinationPlatform parameter.
      • getOMAGServerConfig

        public OMAGServerConfig getOMAGServerConfig​(java.lang.String serverName)
                                             throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the complete set of configuration properties in use by the server.
        Parameters:
        serverName - local server name
        Returns:
        OMAGServerConfig properties
        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 serverName parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.