Package org.odpi.openmetadata.adminservices.client

Class ViewServerConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.ViewServerConfigurationClient

public class ViewServerConfigurationClient
extends OMAGServerConfigurationClient

ViewServerConfigurationClient provides the configuration services for view servers. This involves creating a list of view services config properties.

Field Summary

Fields inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor	Description
ViewServerConfigurationClient(String serverName, String serverPlatformRootURL, String secretStoreProvider, String secretStoreLocation, String secretStoreCollection, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	clearAllViewServices()	Disable the view services.
void	configureAllViewService(OMAGServerClientConfig metadataServerDetails, Map<String,Object> viewServiceOptions)	Enable all registered view services with the same partner server and options.
void	configureViewService(String serviceURLMarker, ViewServiceConfig viewServiceConfig)	Enable a single view service.
void	disableViewService(String serviceURLMarker)	Disable a single view service.
List<RegisteredOMAGService>	getConfiguredViewServices()	Return the list of view services for this server.
List<RegisteredOMAGService>	getRegisteredViewServices()	Return the list of view services for this server.
List<ViewServiceConfig>	getViewServicesConfiguration()	Return the configuration for the view services in this server.
void	setViewServicesConfiguration(List<ViewServiceConfig> viewServices)	Return the configuration for the view services in this server.

Methods inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addFileAuditLogDestination, addJDBCAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestination, clearAuditLogDestinations, clearOMAGServerConfig, clearServerSecurityConnection, deployOMAGServerConfig, getBasicServerProperties, getOMAGServerConfig, getOMAGServerInstanceConfig, getServerSecurityConnection, getServerTypeClassification, setAuditLogDestinations, setBasicServerProperties, setDefaultAuditLog, setEventBus, setMaxPageSize, setOMAGServerConfig, setOrganizationName, setServerDescription, setServerSecurityConnection, setServerType, setServerURLRoot, setServerUserId, updateAuditLogDestination

Methods inherited from class java.lang.Object

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

Constructor Details

ViewServerConfigurationClient

public ViewServerConfigurationClient(String serverName,
 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:

serverName - name of the server to connect to

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.

Method Details

getRegisteredViewServices

public List<RegisteredOMAGService> getRegisteredViewServices()
                                                      throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Return the list of view services for this server.

Returns:

list of view service descriptions

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getConfiguredViewServices

public List<RegisteredOMAGService> getConfiguredViewServices()
                                                      throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Return the list of view services for this server.

Returns:

list of view service descriptions

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getViewServicesConfiguration

public List<ViewServiceConfig> getViewServicesConfiguration()
                                                     throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Return the configuration for the view services in this server.

Returns:

list of view service configuration

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setViewServicesConfiguration

public void setViewServicesConfiguration(List<ViewServiceConfig> viewServices)
                                  throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Return the configuration for the view services in this server.

Parameters:

viewServices - list of view service configuration

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureViewService

public void configureViewService(String serviceURLMarker,
 ViewServiceConfig viewServiceConfig)
                          throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Enable a single view service.

Parameters:

serviceURLMarker - string indicating which view service it is configuring

viewServiceConfig - properties used to configure the view service

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

disableViewService

public void disableViewService(String serviceURLMarker)
                        throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Disable a single view service.

Parameters:

serviceURLMarker - string indicating which view service it is configuring

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureAllViewService

public void configureAllViewService(OMAGServerClientConfig metadataServerDetails,
 Map<String,Object> viewServiceOptions)
                             throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Enable all registered view services with the same partner server and options.

Parameters:

metadataServerDetails - URL root of the OMAG Server Platform and details of metadata access server where the OMF Services used by this view service is running

viewServiceOptions - property name/value pairs used to configure the view service

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearAllViewServices

public void clearAllViewServices()
                          throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Disable the view services. This removes all configuration for the view server.

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.