org.odpi.openmetadata.adminservices.client

Class ConfigurationManagementClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.ConfigurationManagementClient

public class ConfigurationManagementClient
extends 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 and Description
ConfigurationManagementClient(String serverName, String serverPlatformRootURL) Create a new client with no authentication embedded in the HTTP request.
ConfigurationManagementClient(String serverName, String serverPlatformRootURL, String userId, String password) Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method and Description
void	deployOMAGServerConfig(String userId, String serverName, String destinationPlatformURLRoot) Push the configuration for the server to another OMAG Server Platform.
OMAGServerConfig	getOMAGServerConfig(String userId, String serverName) Return the complete set of configuration properties in use by the server.
void	setOMAGServerConfig(String userId, OMAGServerConfig serverConfig) Set up the configuration properties for an OMAG Server in a single command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationManagementClient

public ConfigurationManagementClient(String serverName,
                                     String serverPlatformRootURL)
                              throws OMAGInvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

Throws:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConfigurationManagementClient

public ConfigurationManagementClient(String serverName,
                                     String serverPlatformRootURL,
                                     String userId,
                                     String password)
                              throws 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:

serverName - name of the server to connect to

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:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

setOMAGServerConfig

public void setOMAGServerConfig(String userId,
                                OMAGServerConfig serverConfig)
                         throws OMAGNotAuthorizedException,
                                OMAGConfigurationErrorException,
                                OMAGInvalidParameterException

Set up the configuration properties for an OMAG Server in a single command.

Parameters:

userId - user that is issuing the request

serverConfig - configuration for the server

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGConfigurationErrorException - something went wrong with the REST call stack.

OMAGInvalidParameterException - invalid serverName or destinationPlatform parameter.

deployOMAGServerConfig

public void deployOMAGServerConfig(String userId,
                                   String serverName,
                                   String destinationPlatformURLRoot)
                            throws OMAGNotAuthorizedException,
                                   OMAGConfigurationErrorException,
                                   OMAGInvalidParameterException

Push the configuration for the server to another OMAG Server Platform.

Parameters:

userId - user that is issuing the request

serverName - local server name

destinationPlatformURLRoot - location of the platform where the config is to be deployed to

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGConfigurationErrorException - something went wrong with the REST call stack.

OMAGInvalidParameterException - invalid serverName or destinationPlatform parameter.

getOMAGServerConfig

public OMAGServerConfig getOMAGServerConfig(String userId,
                                            String serverName)
                                     throws OMAGNotAuthorizedException,
                                            OMAGInvalidParameterException,
                                            OMAGConfigurationErrorException

Return the complete set of configuration properties in use by the server.

Parameters:

userId - user that is issuing the request

serverName - local server name

Returns:

OMAGServerConfig properties

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid serverName parameter.

OMAGConfigurationErrorException - something went wrong with the REST call stack.