Package org.odpi.openmetadata.adminservices.client

Class MetadataAccessServerConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.CohortMemberConfigurationClient

org.odpi.openmetadata.adminservices.client.MetadataAccessServerConfigurationClient

Direct Known Subclasses:

MetadataAccessPointConfigurationClient, MetadataAccessStoreConfigurationClient

public class MetadataAccessServerConfigurationClient
extends CohortMemberConfigurationClient

MetadataAccessServerConfigurationClient configures a MetadataAccessServer OMAG Server. This server can become a cohort member and, through the access services, offers a wide range of specialist APIs and event streams to access and store metadata.

Field Summary

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

adminUserId, invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor	Description
MetadataAccessServerConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL)	Create a new client with no authentication embedded in the HTTP request.
MetadataAccessServerConfigurationClient(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	addRemoteEnterpriseTopic(Map<String,Object> configurationProperties)	Set up the default remote enterprise topic.
void	clearAllAccessServices()	Disable the access services.
void	configureAccessService(String serviceURLMarker)	Enable a single access service.
void	configureAccessService(String serviceURLMarker, Map<String,Object> accessServiceOptions)	Enable a single access service.
void	configureAccessServiceNoTopics(String serviceURLMarker)	Enable a single access service without the In and Out topic.
void	configureAccessServiceNoTopics(String serviceURLMarker, Map<String,Object> accessServiceOptions)	Enable a single access service without the In and Out topic.
void	configureAllAccessServices(Map<String,Object> accessServiceOptions)	Enable all access services that are registered into this server.
void	configureAllAccessServicesNoTopics(Map<String,Object> accessServiceOptions)	Enable all access services that are registered into this server without the in and out topics activated.
void	disableAccessService(String serviceURLMarker)	Disable a single access service.
List<AccessServiceConfig>	getAccessServicesConfiguration()	Return the configuration for the access services in this server.
Map<String,String>	getAccessServiceTopicNames(String serviceURLMarker)	Retrieve the topic names for this access service
Map<String,String>	getAllAccessServiceTopicNames()	Retrieve the topic names for all configured access service
List<RegisteredOMAGService>	getConfiguredAccessServices()	Return the list of access services that are configured for this server.
List<RegisteredOMAGService>	getRegisteredAccessServices()	Return the list of access services for this server.
void	overrideAccessServiceInTopic(String serviceURLMarker, String topicName)	Override the topic name for the in topic of a single access service.
void	overrideAccessServiceOutTopic(String serviceURLMarker, String topicName)	Override the topic name for the in topic of a single access service.
void	setAccessServicesConfig(List<AccessServiceConfig> accessServicesConfig)	Set up the configuration for all of the open metadata access services (OMASs).
void	setEnterpriseAccessConfig(EnterpriseAccessConfig enterpriseAccessConfig)	Set up the configuration that controls the enterprise repository services.

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

addCohortRegistration, addCohortRegistration, addStartUpOpenMetadataArchiveFile, addStartUpOpenMetadataArchiveList, clearCohortRegistration, clearLocalRepository, clearOpenMetadataArchives, getCohortTopicName, getDedicatedCohortTopicNames, getLocalMetadataCollectionId, overrideCohortTopicName, overrideInstancesCohortTopicName, overrideRegistrationCohortTopicName, overrideTypesCohortTopicName, setCohortConfig, setLocalMetadataCollectionId, setLocalMetadataCollectionName, setLocalRepositoryConfig

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

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestination, clearAuditLogDestinations, clearOMAGServerConfig, clearServerSecurityConnection, deployOMAGServerConfig, getOMAGServerConfig, getOMAGServerInstanceConfig, getServerClassification, getServerSecurityConnection, setAuditLogDestinations, 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 Detail

MetadataAccessServerConfigurationClient

public MetadataAccessServerConfigurationClient(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.

MetadataAccessServerConfigurationClient

public MetadataAccessServerConfigurationClient(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 Detail

getRegisteredAccessServices

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

Return the list of access services for this server.

Returns:

list of access service descriptions

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getConfiguredAccessServices

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

Return the list of access services that are configured for this server.

Returns:

list of access service descriptions

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getAccessServicesConfiguration

public List<AccessServiceConfig> getAccessServicesConfiguration()
                                                         throws OMAGNotAuthorizedException,
                                                                OMAGInvalidParameterException,
                                                                OMAGConfigurationErrorException

Return the configuration for the access services in this server.

Returns:

list of access service configuration

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureAccessService

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

Enable a single access service.

Parameters:

serviceURLMarker - string indicating which access 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.

disableAccessService

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

Disable a single access service.

Parameters:

serviceURLMarker - string indicating which access service it is disabling

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureAccessService

public void configureAccessService(String serviceURLMarker,
                                   Map<String,Object> accessServiceOptions)
                            throws OMAGNotAuthorizedException,
                                   OMAGInvalidParameterException,
                                   OMAGConfigurationErrorException

Enable a single access service.

Parameters:

serviceURLMarker - string indicating which access service it is configuring

accessServiceOptions - property name/value pairs used to configure the access service

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureAccessServiceNoTopics

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

Enable a single access service without the In and Out topic.

Parameters:

serviceURLMarker - string indicating which access 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.

configureAccessServiceNoTopics

public void configureAccessServiceNoTopics(String serviceURLMarker,
                                           Map<String,Object> accessServiceOptions)
                                    throws OMAGNotAuthorizedException,
                                           OMAGInvalidParameterException,
                                           OMAGConfigurationErrorException

Enable a single access service without the In and Out topic.

Parameters:

serviceURLMarker - string indicating which access service it is configuring

accessServiceOptions - property name/value pairs used to configure the access service

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureAllAccessServices

public void configureAllAccessServices(Map<String,Object> accessServiceOptions)
                                throws OMAGNotAuthorizedException,
                                       OMAGInvalidParameterException,
                                       OMAGConfigurationErrorException

Enable all access services that are registered into this server. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation.

Parameters:

accessServiceOptions - property name/value pairs used to configure the access services

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureAllAccessServicesNoTopics

public void configureAllAccessServicesNoTopics(Map<String,Object> accessServiceOptions)
                                        throws OMAGNotAuthorizedException,
                                               OMAGInvalidParameterException,
                                               OMAGConfigurationErrorException

Enable all access services that are registered into this server without the in and out topics activated. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation.

Parameters:

accessServiceOptions - property name/value pairs used to configure the access services

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getAccessServiceTopicNames

public Map<String,String> getAccessServiceTopicNames(String serviceURLMarker)
                                                    throws OMAGNotAuthorizedException,
                                                           OMAGInvalidParameterException,
                                                           OMAGConfigurationErrorException

Retrieve the topic names for this access service

Parameters:

serviceURLMarker - string indicating which access service it requested

Returns:

map of topic names to descriptions

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getAllAccessServiceTopicNames

public Map<String,String> getAllAccessServiceTopicNames()
                                                       throws OMAGNotAuthorizedException,
                                                              OMAGInvalidParameterException,
                                                              OMAGConfigurationErrorException

Retrieve the topic names for all configured access service

Returns:

map of topic names to descriptions

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

overrideAccessServiceInTopic

public void overrideAccessServiceInTopic(String serviceURLMarker,
                                         String topicName)
                                  throws OMAGNotAuthorizedException,
                                         OMAGInvalidParameterException,
                                         OMAGConfigurationErrorException

Override the topic name for the in topic of a single access service.

Parameters:

serviceURLMarker - string indicating which access service it is configuring

topicName - new topic name

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

overrideAccessServiceOutTopic

public void overrideAccessServiceOutTopic(String serviceURLMarker,
                                          String topicName)
                                   throws OMAGNotAuthorizedException,
                                          OMAGInvalidParameterException,
                                          OMAGConfigurationErrorException

Override the topic name for the in topic of a single access service.

Parameters:

serviceURLMarker - string indicating which access service it is configuring

topicName - new topic name

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearAllAccessServices

public void clearAllAccessServices()
                            throws OMAGNotAuthorizedException,
                                   OMAGInvalidParameterException,
                                   OMAGConfigurationErrorException

Disable the access services. This removes all configuration for the access services and disables the enterprise repository services.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setAccessServicesConfig

public void setAccessServicesConfig(List<AccessServiceConfig> accessServicesConfig)
                             throws OMAGNotAuthorizedException,
                                    OMAGInvalidParameterException,
                                    OMAGConfigurationErrorException

Set up the configuration for all of the open metadata access services (OMASs). This overrides the current values.

Parameters:

accessServicesConfig - - list of configuration properties for each access service.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addRemoteEnterpriseTopic

public void addRemoteEnterpriseTopic(Map<String,Object> configurationProperties)
                              throws OMAGNotAuthorizedException,
                                     OMAGInvalidParameterException,
                                     OMAGConfigurationErrorException

Set up the default remote enterprise topic. This allows a remote process to monitor enterprise topic events.

Parameters:

configurationProperties - additional properties for the cohort

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setEnterpriseAccessConfig

public void setEnterpriseAccessConfig(EnterpriseAccessConfig enterpriseAccessConfig)
                               throws OMAGNotAuthorizedException,
                                      OMAGInvalidParameterException,
                                      OMAGConfigurationErrorException

Set up the configuration that controls the enterprise repository services. These services are part of the Open Metadata Repository Services (OMRS). They provide federated queries and federated event notifications that cover metadata from the local repository plus any repositories connected via open metadata repository cohorts. These services are configured automatically when the access services are enabled and so this call is not normally needed unless the default settings for the enterprise access services are not sufficient.

Parameters:

enterpriseAccessConfig - - enterprise repository services configuration properties.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.