org.odpi.openmetadata.adminservices

Class ConfigurationManagementClient

java.lang.Object

org.odpi.openmetadata.adminservices.ConfigurationManagementClient

public class ConfigurationManagementClient
extends Object

ConfigurationManagementClient is able to issue calls to an OMAG Server PPlatform that manages configuration for OMAG Servers.

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	setOMAGServerConfig(String userId, OMAGServerConfig uiServerConfig) 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 OMAS REST servers

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 OMAS REST servers

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 uiServerConfig)
                         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

uiServerConfig - configuration for the server

Throws:

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

OMAGConfigurationErrorException - there is a problem using the supplied configuration or

OMAGInvalidParameterException - invalid serverName or destinationPlatform parameter.