Package org.odpi.openmetadata.conformance.server

Class ConformanceSuiteTestLabServices

java.lang.Object
org.odpi.openmetadata.conformance.server.ConformanceSuiteTestLabServices
public class ConformanceSuiteTestLabServices extends Object
ConformanceSuiteTestLabServices supports the REST API for the CTS.

  • Constructor Details

    • ConformanceSuiteTestLabServices

      public ConformanceSuiteTestLabServices()

  • Method Details

    • getProfileNames

      public ProfileNameListResponse getProfileNames(String userId, String serverName)
      Requests the list of profile (names) that are available.
      Parameters:
      userId - calling user.
      serverName - the name of the conformance service.
      Returns:
      TestCaseListResponse or InvalidParameterException the serverName is not known or UserNotAuthorizedException the supplied userId is not known.

    • getProfileReport

      public ProfileReportResponse getProfileReport(String userId, String serverName, String profileName)
      Requests detailed information on the execution of a specific test case.
      Parameters:
      userId - calling user.
      serverName - the name of the conformance service.
      profileName - of the profile for which to obtain a detailed report.
      Returns:
      TestCaseReportResponse or InvalidParameterException the serverName or workbenchId is not known or UserNotAuthorizedException the supplied userId is not known.

    • getTestCaseIds

      public TestCaseListResponse getTestCaseIds(String userId, String serverName)
      Requests the list of test case IDs that are available.
      Parameters:
      userId - calling user.
      serverName - the name of the conformance service.
      Returns:
      TestCaseListResponse or InvalidParameterException the serverName is not known or UserNotAuthorizedException the supplied userId is not known.

    • getTestCaseReport

      public TestCaseReportResponse getTestCaseReport(String userId, String serverName, String testCaseId)
      Requests detailed information on the execution of a specific test case.
      Parameters:
      userId - calling user.
      serverName - the name of the conformance service.
      testCaseId - of the test case for which to obtain a detailed report.
      Returns:
      TestCaseReportResponse or InvalidParameterException the serverName or workbenchId is not known or UserNotAuthorizedException the supplied userId is not known.

    • getFailedTestCaseReport

      public TestCaseListReportResponse getFailedTestCaseReport(String userId, String serverName)
      Requests detailed information on the execution of all of the failed test cases.
      Parameters:
      userId - calling user.
      serverName - the name of the conformance service.
      Returns:
      TestCaseListReportResponse or InvalidParameterException the serverName or workbenchId is not known or UserNotAuthorizedException the supplied userId is not known.

    • getWorkbenchReport

      public WorkbenchReportResponse getWorkbenchReport(String userId, String serverName, String workbenchId)
      Requests information on the level of conformance discovered by a specific workbench
      Parameters:
      userId - calling user.
      serverName - the name of the conformance service.
      workbenchId - identifier of the workbench.
      Returns:
      WorkbenchReportResponse or InvalidParameterException the serverName or workbenchId is not known or UserNotAuthorizedException the supplied userId is not known.

    • getConformanceReport

      public TestLabReportResponse getConformanceReport(String userId, String serverName)
      Request a full report on the conformance of the technology under test.
      Parameters:
      userId - calling user.
      serverName - the name of the conformance service.
      Returns:
      TestLabReportResponse or InvalidParameterException the serverName or workbenchId is not known or UserNotAuthorizedException the supplied userId is not known.

    • getConformanceSummaryReport

      public TestLabSummaryResponse getConformanceSummaryReport(String userId, String serverName)
      Request a summary report on the conformance of the technology under test.
      Parameters:
      userId - calling user.
      serverName - the name of the conformance service.
      Returns:
      TestLabSummaryResponse or InvalidParameterException the serverName or workbenchId is not known or UserNotAuthorizedException the supplied userId is not known.

    • getWorkbenchStatus

      public WorkbenchStatusResponse getWorkbenchStatus(String userId, String serverName, String workbenchId)
      Request the status of a conformance workbench
      Parameters:
      userId - calling user.
      serverName - the name of the conformance service.
      workbenchId - the id of the workbench.
      Returns:
      WorkbenchStatusResponse or InvalidParameterException the serverName or workbenchId is not known or UserNotAuthorizedException the supplied userId is not known.