Package 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	Description
ConfigurationManagementClient(String serverPlatformRootURL, String secretStoreProvider, String secretStoreLocation, String secretStoreCollection, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
ConfigurationManagementClient(String serverPlatformRootURL, Map<String,SecretsStoreConnector> secretsStoreConnectorMap, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	deployOMAGServerConfig(String serverName, String destinationPlatformURLRoot)	Push the configuration for the server to another OMAG Server Platform.
Set<OMAGServerConfig>	getAllServerConfigurations()	Return all the OMAG Server configurations that are stored on this platform.
OMAGServerConfig	getResolvedOMAGServerConfig(String serverName)	Return the complete set of configuration properties in use by the server that have the placeholders resolved.
OMAGServerConfig	getStoredOMAGServerConfig(String serverName)	Return the complete set of configuration properties in use by the server from the configuration store.
void	setOMAGServerConfig(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 Details

ConfigurationManagementClient

public ConfigurationManagementClient(String serverPlatformRootURL,
 String secretStoreProvider,
 String secretStoreLocation,
 String secretStoreCollection,
 AuditLog auditLog)
                              throws InvalidParameterException

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

Parameters:

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

secretStoreProvider - class name of the secrets store

secretStoreLocation - location (networkAddress) of the secrets store

secretStoreCollection - name of the collection of secrets to use to connect to the remote server

auditLog - destination for log messages.

Throws:

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

ConfigurationManagementClient

public ConfigurationManagementClient(String serverPlatformRootURL,
 Map<String,SecretsStoreConnector> secretsStoreConnectorMap,
 AuditLog auditLog)
                              throws InvalidParameterException

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

Parameters:

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

secretsStoreConnectorMap - connectors to secrets stores

auditLog - destination for log messages.

Throws:

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

Method Details

getAllServerConfigurations

public Set<OMAGServerConfig> getAllServerConfigurations()
                                                 throws UserNotAuthorizedException,
OMAGConfigurationErrorException,
InvalidParameterException

Return all the OMAG Server configurations that are stored on this platform.

Returns:

the OMAG Server configurations that are stored on this platform

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setOMAGServerConfig

public void setOMAGServerConfig(OMAGServerConfig serverConfig)
                         throws UserNotAuthorizedException,
OMAGConfigurationErrorException,
InvalidParameterException

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

Parameters:

serverConfig - configuration for the server

Throws:

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

OMAGConfigurationErrorException - something went wrong with the REST call stack.

InvalidParameterException - invalid serverName or destinationPlatform parameter.

deployOMAGServerConfig

public void deployOMAGServerConfig(String serverName,
 String destinationPlatformURLRoot)
                            throws UserNotAuthorizedException,
OMAGConfigurationErrorException,
InvalidParameterException

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:

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

OMAGConfigurationErrorException - something went wrong with the REST call stack.

InvalidParameterException - invalid serverName or destinationPlatform parameter.

getStoredOMAGServerConfig

public OMAGServerConfig getStoredOMAGServerConfig(String serverName)
                                           throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

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

Parameters:

serverName - local server name

Returns:

OMAGServerConfig properties

Throws:

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

InvalidParameterException - invalid serverName parameter.

OMAGConfigurationErrorException - something went wrong with the REST call stack.

getResolvedOMAGServerConfig

public OMAGServerConfig getResolvedOMAGServerConfig(String serverName)
                                             throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Return the complete set of configuration properties in use by the server that have the placeholders resolved.

Parameters:

serverName - local server name

Returns:

OMAGServerConfig properties

Throws:

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

InvalidParameterException - invalid serverName parameter.

OMAGConfigurationErrorException - something went wrong with the REST call stack.