org.odpi.openmetadata.adminservices.client

Class MetadataAccessPointConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.MetadataAccessPointConfigurationClient

Direct Known Subclasses:

MetadataServerConfigurationClient

public class MetadataAccessPointConfigurationClient
extends OMAGServerConfigurationClient

MetadataAccessPointConfigurationClient configures a MetadataAccessPoint 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 and Description
MetadataAccessPointConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL) Create a new client with no authentication embedded in the HTTP request.
MetadataAccessPointConfigurationClient(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 and Description
void	addCohortRegistration(String cohortName, Map<String,Object> additionalProperties) Enable registration of server to an open metadata repository cohort.
void	addStartUpOpenMetadataArchiveFile(String fileName) Add a new open metadata archive file to load at startup.
void	addStartUpOpenMetadataArchiveList(List<Connection> connections) Add a list of connections to connectors that can access an open metadata archive file.
void	clearAllAccessServices() Disable the access services.
void	clearCohortRegistration(String cohortName) Unregister this server from an open metadata repository cohort.
void	clearLocalRepository() Remove all configuration for a local repository.
void	clearOpenMetadataArchives() Clear the list of open metadata archives for loading at server startup.
void	configureAccessService(String serviceURLMarker) Enable a single access service.
void	configureAccessService(String serviceURLMarker, Map<String,Object> accessServiceOptions) Enable a single access service.
void	configureAllAccessServices(Map<String,Object> accessServiceOptions) Enable all access services that are registered into 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
String	getCohortTopicName(String cohortName) Retrieve the current topic name for the cohort.
List<RegisteredOMAGService>	getConfiguredAccessServices() Return the list of access services that are configured for this server.
String	getLocalMetadataCollectionId() Return the local metadata collection id.
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	overrideCohortTopicName(String cohortName, String topicName) Override the current topic name for the cohort.
void	setAccessServicesConfig(List<AccessServiceConfig> accessServicesConfig) Set up the configuration for all of the open metadata access services (OMASs).
void	setCohortConfig(String cohortName, CohortConfig cohortConfig) Set up the configuration properties for a cohort.
void	setEnterpriseAccessConfig(EnterpriseAccessConfig enterpriseAccessConfig) Set up the configuration that controls the enterprise repository services.
void	setLocalMetadataCollectionName(String name) Set up the local metadata collection name.
protected void	setLocalRepositoryConfig(LocalRepositoryConfig localRepositoryConfig) Set up the configuration for the local repository in one operation.

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

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestinations, clearServerSecurityConnection, deployOMAGServerConfig, getOMAGServerConfig, getServerClassification, getServerSecurityConnection, setDefaultAuditLog, setEventBus, setMaxPageSize, setOMAGServerConfig, setOrganizationName, setServerPassword, setServerSecurityConnection, setServerType, setServerURLRoot, setServerUserId

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataAccessPointConfigurationClient

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

MetadataAccessPointConfigurationClient

public MetadataAccessPointConfigurationClient(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

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.

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.

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.

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.

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.

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.

addCohortRegistration

public void addCohortRegistration(String cohortName,
                                  Map<String,Object> additionalProperties)
                           throws OMAGNotAuthorizedException,
                                  OMAGInvalidParameterException,
                                  OMAGConfigurationErrorException

Enable registration of server to an open metadata repository cohort. This is a group of open metadata repositories that are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs a unique name. The members of the cohort use a shared topic to exchange registration information and events related to changes in their supported metadata types and instances. They are also able to query each other's metadata directly through REST calls.

Parameters:

cohortName - name of the cohort.

additionalProperties - additional properties for the event bus connection

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getCohortTopicName

public String getCohortTopicName(String cohortName)
                          throws OMAGNotAuthorizedException,
                                 OMAGInvalidParameterException,
                                 OMAGConfigurationErrorException

Retrieve the current topic name for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().

Parameters:

cohortName - name of the cohort.

Returns:

string topic name

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

overrideCohortTopicName

public void overrideCohortTopicName(String cohortName,
                                    String topicName)
                             throws OMAGNotAuthorizedException,
                                    OMAGInvalidParameterException,
                                    OMAGConfigurationErrorException

Override the current topic name for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().

Parameters:

cohortName - name of the cohort.

topicName - new name for the topic.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setCohortConfig

public void setCohortConfig(String cohortName,
                            CohortConfig cohortConfig)
                     throws OMAGNotAuthorizedException,
                            OMAGInvalidParameterException,
                            OMAGConfigurationErrorException

Set up the configuration properties for a cohort. This may reconfigure an existing cohort or create a cohort. Use setCohortMode to delete a cohort.

Parameters:

cohortName - name of the cohort

cohortConfig - configuration 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.

clearCohortRegistration

public void clearCohortRegistration(String cohortName)
                             throws OMAGNotAuthorizedException,
                                    OMAGInvalidParameterException,
                                    OMAGConfigurationErrorException

Unregister this server from an open metadata repository cohort.

Parameters:

cohortName - name of the cohort.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addStartUpOpenMetadataArchiveFile

public void addStartUpOpenMetadataArchiveFile(String fileName)
                                       throws OMAGNotAuthorizedException,
                                              OMAGInvalidParameterException,
                                              OMAGConfigurationErrorException

Add a new open metadata archive file to load at startup.

Parameters:

fileName - name of the open metadata archive file.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addStartUpOpenMetadataArchiveList

public void addStartUpOpenMetadataArchiveList(List<Connection> connections)
                                       throws OMAGNotAuthorizedException,
                                              OMAGInvalidParameterException,
                                              OMAGConfigurationErrorException

Add a list of connections to connectors that can access an open metadata archive file.

Parameters:

connections - list of connections to open metadata archive connectors

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearOpenMetadataArchives

public void clearOpenMetadataArchives()
                               throws OMAGNotAuthorizedException,
                                      OMAGInvalidParameterException,
                                      OMAGConfigurationErrorException

Clear the list of open metadata archives for loading at server startup.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setLocalRepositoryConfig

protected void setLocalRepositoryConfig(LocalRepositoryConfig localRepositoryConfig)
                                 throws OMAGNotAuthorizedException,
                                        OMAGInvalidParameterException,
                                        OMAGConfigurationErrorException

Set up the configuration for the local repository in one operation. This overrides the current values.

Parameters:

localRepositoryConfig - - configuration properties for the local repository.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearLocalRepository

public void clearLocalRepository()
                          throws OMAGNotAuthorizedException,
                                 OMAGInvalidParameterException,
                                 OMAGConfigurationErrorException

Remove all configuration for a local repository. The default is no local repository. This call can be used to remove subsequent local repository configuration. This call effectively sets the type of a metadata server back to a metadata access point.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setLocalMetadataCollectionName

public void setLocalMetadataCollectionName(String name)
                                    throws OMAGNotAuthorizedException,
                                           OMAGInvalidParameterException,
                                           OMAGConfigurationErrorException

Set up the local metadata collection name. If a null is passed, the connection name is cleared to null. If this is not set then the default value is the local server name.

Parameters:

name - metadata collection name.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getLocalMetadataCollectionId

public String getLocalMetadataCollectionId()
                                    throws OMAGNotAuthorizedException,
                                           OMAGInvalidParameterException,
                                           OMAGConfigurationErrorException

Return the local metadata collection id. If the local repository is not configured then the invalid parameter exception is returned.

Returns:

string guid

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.