Package org.odpi.openmetadata.adminservices.client

Class ConformanceTestServerConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.CohortMemberConfigurationClient

org.odpi.openmetadata.adminservices.client.ConformanceTestServerConfigurationClient

public class ConformanceTestServerConfigurationClient
extends CohortMemberConfigurationClient

ConformanceTestServerConfigurationClient provides the configuration services needed by The Conformance Test Server. This configuration focuses on setting up test workbenches.

Constructor Summary

Constructors

Constructor	Description
ConformanceTestServerConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL)	Create a new client with no authentication embedded in the HTTP request.
ConformanceTestServerConfigurationClient(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	disableAllConformanceSuiteWorkbenches()	Request that the conformance suite services are deactivated in this server.
void	disablePlatformConformanceSuiteServices()	Request that the repository conformance suite tests are deactivated in this server.
void	disableRepositoryConformanceSuiteServices()	Request that the repository conformance suite tests are deactivated in this server.
void	enablePlatformConformanceSuiteWorkbench(String platformURL)	Request that the conformance suite services are activated in this server to test the support of the platform services running in the platform at tutPlatformRootURL.
void	enableRepositoryConformanceSuiteWorkbench(org.odpi.openmetadata.adminservices.configuration.properties.RepositoryConformanceWorkbenchConfig repositoryConformanceWorkbenchConfig)	Request that the conformance suite services are activated in this server to test the support of the repository services running in the server named tutRepositoryServerName.

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

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

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

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addFileAuditLogDestination, 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

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

Constructor Details

ConformanceTestServerConfigurationClient

public ConformanceTestServerConfigurationClient(String adminUserId,
 String serverName,
 String serverPlatformRootURL)
                                         throws org.odpi.openmetadata.adminservices.ffdc.exception.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:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConformanceTestServerConfigurationClient

public ConformanceTestServerConfigurationClient(String adminUserId,
 String serverName,
 String serverPlatformRootURL,
 String connectionUserId,
 String connectionPassword)
                                         throws org.odpi.openmetadata.adminservices.ffdc.exception.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:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

enableRepositoryConformanceSuiteWorkbench

public void enableRepositoryConformanceSuiteWorkbench(org.odpi.openmetadata.adminservices.configuration.properties.RepositoryConformanceWorkbenchConfig repositoryConformanceWorkbenchConfig)
                                               throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Request that the conformance suite services are activated in this server to test the support of the repository services running in the server named tutRepositoryServerName.

Parameters:

repositoryConformanceWorkbenchConfig - configuration for the repository conformance workbench.

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.

enablePlatformConformanceSuiteWorkbench

public void enablePlatformConformanceSuiteWorkbench(String platformURL)
                                             throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Request that the conformance suite services are activated in this server to test the support of the platform services running in the platform at tutPlatformRootURL.

Parameters:

platformURL - url of the OMAG platform to test.

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.

disableRepositoryConformanceSuiteServices

public void disableRepositoryConformanceSuiteServices()
                                               throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Request that the repository conformance suite tests are deactivated in this server.

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.

disablePlatformConformanceSuiteServices

public void disablePlatformConformanceSuiteServices()
                                             throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Request that the repository conformance suite tests are deactivated in this server.

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.

disableAllConformanceSuiteWorkbenches

public void disableAllConformanceSuiteWorkbenches()
                                           throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException

Request that the conformance suite services are deactivated in this server.

Throws:

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.

org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.