public class MetadataServerConfigurationClient extends MetadataAccessPointConfigurationClient
adminUserId, invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL| Constructor and Description |
|---|
MetadataServerConfigurationClient(String adminUserId,
String serverName,
String serverPlatformRootURL)
Create a new client with no authentication embedded in the HTTP request.
|
MetadataServerConfigurationClient(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.
|
| 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 |
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.
|
String |
getCohortTopicName(String cohortName)
Retrieve the current topic name for the cohort.
|
String |
getLocalMetadataCollectionId()
Return the local metadata collection id.
|
void |
overrideCohortTopicName(String cohortName,
String topicName)
Override the current topic name for the cohort.
|
void |
setCohortConfig(String cohortName,
CohortConfig cohortConfig)
Set up the configuration properties for a cohort.
|
void |
setGraphLocalRepository(Map<String,Object> storageProperties)
Set up a graph store as the local repository.
|
void |
setInMemLocalRepository()
Set up an in memory local repository.
|
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.
|
void |
setReadOnlyLocalRepository()
Set up an read only local repository.
|
clearAllAccessServices, configureAccessService, configureAccessService, configureAllAccessServices, getAccessServiceTopicNames, getAllAccessServiceTopicNames, getConfiguredAccessServices, overrideAccessServiceInTopic, overrideAccessServiceOutTopic, setAccessServicesConfig, setEnterpriseAccessConfigaddAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestinations, clearServerSecurityConnection, deployOMAGServerConfig, getOMAGServerConfig, getServerClassification, getServerSecurityConnection, setDefaultAuditLog, setEventBus, setMaxPageSize, setOMAGServerConfig, setOrganizationName, setServerPassword, setServerSecurityConnection, setServerType, setServerURLRoot, setServerUserIdpublic MetadataServerConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL) throws OMAGInvalidParameterException
adminUserId - administrator's (end user's) userId to associate with calls.serverName - name of the server to connect toserverPlatformRootURL - the network address of the server running the admin servicesOMAGInvalidParameterException - there is a problem creating the client-side components to issue any
REST API calls.public MetadataServerConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL, String connectionUserId, String connectionPassword) throws OMAGInvalidParameterException
adminUserId - administrator's (end user's) userId to associate with calls.serverName - name of the server to connect toserverPlatformRootURL - the network address of the server running the admin servicesconnectionUserId - caller's system userId embedded in all HTTP requestsconnectionPassword - caller's system password embedded in all HTTP requestsOMAGInvalidParameterException - there is a problem creating the client-side components to issue any
REST API calls.public void setInMemLocalRepository()
throws OMAGNotAuthorizedException,
OMAGConfigurationErrorException,
OMAGInvalidParameterException
OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void setGraphLocalRepository(Map<String,Object> storageProperties) throws OMAGNotAuthorizedException, OMAGConfigurationErrorException, OMAGInvalidParameterException
storageProperties - properties used to configure the back end storage for the graphOMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void setReadOnlyLocalRepository()
throws OMAGNotAuthorizedException,
OMAGConfigurationErrorException,
OMAGInvalidParameterException
OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void addCohortRegistration(String cohortName, Map<String,Object> additionalProperties) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
cohortName - name of the cohort.additionalProperties - additional properties for the event bus connectionOMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public String getCohortTopicName(String cohortName) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
cohortName - name of the cohort.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void overrideCohortTopicName(String cohortName, String topicName) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
cohortName - name of the cohort.topicName - new name for the topic.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void setCohortConfig(String cohortName, CohortConfig cohortConfig) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
cohortName - name of the cohortcohortConfig - configuration for the cohortOMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void clearCohortRegistration(String cohortName) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
cohortName - name of the cohort.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void addStartUpOpenMetadataArchiveFile(String fileName) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
fileName - name of the open metadata archive file.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void addStartUpOpenMetadataArchiveList(List<Connection> connections) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
connections - list of connections to open metadata archive connectorsOMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void clearOpenMetadataArchives()
throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException
OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.protected void setLocalRepositoryConfig(LocalRepositoryConfig localRepositoryConfig) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
localRepositoryConfig - - configuration properties for the local repository.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void clearLocalRepository()
throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException
OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public void setLocalMetadataCollectionName(String name) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
name - metadata collection name.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.public String getLocalMetadataCollectionId() throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException
OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.OMAGInvalidParameterException - invalid parameter.OMAGConfigurationErrorException - unusual state in the admin server.Copyright © 2018–2020 ODPi. All rights reserved.