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

adminUserId, invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor	Description
ViewServerConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL)	Create a new client with no authentication embedded in the HTTP request.
ViewServerConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL, String connectionUserId, String connectionPassword)	Create a new client that passes a connection userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
void	clearAllViewServices()	Disable the view services.
void	configureAllViewService(String partnerOMASServerURLRoot, String partnerOMASServerName, Map<String,Object> viewServiceOptions)	Enable all registered view services with the same partner server and options.
void	configureViewService(String partnerOMASServerURLRoot, String partnerOMASServerName, String serviceURLMarker, Map<String,Object> viewServiceOptions)	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, setServerPassword, 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 adminUserId,
 String serverName,
 String serverPlatformRootURL)
                              throws 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.

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.

ViewServerConfigurationClient

public ViewServerConfigurationClient(String adminUserId,
 String serverName,
 String serverPlatformRootURL,
 String connectionUserId,
 String connectionPassword)
                              throws OMAGInvalidParameterException

Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

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

connectionUserId - caller's system userId embedded in all HTTP requests

connectionPassword - caller's system password embedded in all HTTP requests

Throws:

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

Method Details

getRegisteredViewServices

public List<RegisteredOMAGService> getRegisteredViewServices()
                                                      throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Return the list of view services for this server.

Returns:

list of view service descriptions

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getConfiguredViewServices

public List<RegisteredOMAGService> getConfiguredViewServices()
                                                      throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Return the list of view services for this server.

Returns:

list of view service descriptions

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getViewServicesConfiguration

public List<ViewServiceConfig> getViewServicesConfiguration()
                                                     throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Return the configuration for the view services in this server.

Returns:

list of view service configuration

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setViewServicesConfiguration

public void setViewServicesConfiguration(List<ViewServiceConfig> viewServices)
                                  throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Return the configuration for the view services in this server.

Parameters:

viewServices - list of view service configuration

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureViewService

public void configureViewService(String partnerOMASServerURLRoot,
 String partnerOMASServerName,
 String serviceURLMarker,
 Map<String,Object> viewServiceOptions)
                          throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Enable a single view service.

Parameters:

partnerOMASServerURLRoot - URL root of the OMAG Server Platform where the access service used by this view service is running

partnerOMASServerName - name of metadata access server where the access service used by this view service is running

serviceURLMarker - string indicating which view service it is configuring

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

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

disableViewService

public void disableViewService(String serviceURLMarker)
                        throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Disable a single view service.

Parameters:

serviceURLMarker - string indicating which view service it is configuring

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureAllViewService

public void configureAllViewService(String partnerOMASServerURLRoot,
 String partnerOMASServerName,
 Map<String,Object> viewServiceOptions)
                             throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

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

Parameters:

partnerOMASServerURLRoot - URL root of the OMAG Server Platform where the access service used by this view service is running

partnerOMASServerName - name of metadata access server where the access service used by this view service is running

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

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearAllViewServices

public void clearAllViewServices()
                          throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

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

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.