Package org.odpi.openmetadata.conformance.workbenches.performance

Class PerformanceWorkPad

java.lang.Object
org.odpi.openmetadata.conformance.beans.OpenMetadataConformanceWorkbenchWorkPad
org.odpi.openmetadata.conformance.workbenches.performance.PerformanceWorkPad
public class PerformanceWorkPad extends OpenMetadataConformanceWorkbenchWorkPad
PerformanceWorkPad provides the thread safe place to assemble results from the performance workbench.

  • Constructor Details

    • PerformanceWorkPad

      public PerformanceWorkPad(String localServerUserId, String localServerPassword, int maxPageSize, AuditLog auditLog, RepositoryPerformanceWorkbenchConfig configuration)
      Constructor receives key information from the configuration services.
      Parameters:
      localServerUserId - userId that this server should use on requests
      localServerPassword - password that this server should use on requests
      maxPageSize - maximum number of elements that can be returned on a single call
      auditLog - audit log for administrator messages
      configuration - configuration for this work pad/workbench

  • Method Details

    • getAuditLog

      public AuditLog getAuditLog()
      Return the audit log for this server.
      Returns:
      audit log object.

    • getTutServerName

      public String getTutServerName()
      Return the name of the server being tested.
      Returns:
      server name

    • getInstancesPerType

      public int getInstancesPerType()
      Return the number of instances that should be created per type definition.
      Returns:
      number of instances to create (per type definition)

    • getMaxSearchResults

      public int getMaxSearchResults()
      Return the maximum number of search results that be processed for tests of the repository under test.
      Returns:
      maximum number of search results to process

    • getWaitBetweenScenarios

      public int getWaitBetweenScenarios()
      Return the amount of time (in seconds) to wait before executing different scenarios of the performance test. This would be useful for example, where you want to simulate a batch-load with an eventually-consistent search index.
      Returns:
      number of seconds to wait between executing different performance test scenarios

    • getProfilesToSkip

      public List<String> getProfilesToSkip()
      Return the profiles that should be skipped (if any) by the performance test.
      Returns:
      list of profile names to skip

    • getMethodsToSkip

      public List<String> getMethodsToSkip()
      Return the methods that should be skipped (if any) by the performance test.
      Returns:
      list of method names to skip

    • getTutServerType

      public String getTutServerType()
      Return the server type of the technology under test. This is extracted from the registration events.
      Returns:
      string type name

    • setTutServerType

      public void setTutServerType(String tutServerType)
      Set up the server type of the technology under test. This is extracted from the registration events.
      Parameters:
      tutServerType - string type name

    • getTutOrganization

      public String getTutOrganization()
      Return the owning organization of the technology under test. This is extracted from the registration event.
      Returns:
      string organization name

    • setTutOrganization

      public void setTutOrganization(String tutOrganization)
      Set up the owning organization of the technology under test. This is extracted from the registration event.
      Parameters:
      tutOrganization - string organization name

    • getTutMetadataCollectionId

      public String getTutMetadataCollectionId()
      Return the metadata collection id of the technology under test (or null if it is not known). This value is populated from the registration events.
      Returns:
      string id

    • setTutMetadataCollectionId

      public void setTutMetadataCollectionId(String tutMetadataCollectionId)
      Set up the metadata collection id of the technology under test. This value is populated from the registration events.
      Parameters:
      tutMetadataCollectionId - string id

    • getTutRepositoryConnector

      public OMRSRepositoryConnector getTutRepositoryConnector()
      Return the repository connector for the technology under test.
      Returns:
      OMRSRepositoryConnector

    • setTutRepositoryConnector

      public void setTutRepositoryConnector(OMRSRepositoryConnector tutRepositoryConnector)
      Set up the repository connector for the technology under test.
      Parameters:
      tutRepositoryConnector - OMRSRepositoryConnector

    • getLocalMetadataCollectionId

      public String getLocalMetadataCollectionId()
      Return the metadata collection id for the local repository.
      Returns:
      string id

    • setLocalMetadataCollectionId

      public void setLocalMetadataCollectionId(String localMetadataCollectionId)
      Set up the metadata collection id for the local repository.
      Parameters:
      localMetadataCollectionId - string id

    • getLocalRepositoryConnector

      public OMRSRepositoryConnector getLocalRepositoryConnector()
      Return the connector to the local repository.
      Returns:
      OMRSRepositoryConnector

    • setLocalRepositoryConnector

      public void setLocalRepositoryConnector(OMRSRepositoryConnector localRepositoryConnector)
      Set up the connector to the local repository.
      Parameters:
      localRepositoryConnector - access to the local repository (updated to generate events for the technology under test to respond to)

    • getProfileNames

      public List<String> getProfileNames()
      Accumulate the set of profile names registered with this work pad.
      Specified by:
      getProfileNames in class OpenMetadataConformanceWorkbenchWorkPad
      Returns:
      the profile names

    • getProfileResults

      public OpenMetadataConformanceProfileResults getProfileResults(String profileName)
      Accumulate the evidences for a given profile.
      Specified by:
      getProfileResults in class OpenMetadataConformanceWorkbenchWorkPad
      Parameters:
      profileName - for which to obtain the detailed results
      Returns:
      the test evidence organized by profile and requirement within profile

    • getProfileResults

      public List<OpenMetadataConformanceProfileResults> getProfileResults()
      Accumulate the evidences for each profile
      Specified by:
      getProfileResults in class OpenMetadataConformanceWorkbenchWorkPad
      Returns:
      the test evidence organized by profile and requirement withing profile

    • getProfileSummaries

      public List<OpenMetadataConformanceProfileSummary> getProfileSummaries()
      Accumulate the summarized evidences for each profile
      Specified by:
      getProfileSummaries in class OpenMetadataConformanceWorkbenchWorkPad
      Returns:
      the summarized test evidence organized by profile and requirement withing profile

    • incrementEntitiesCreated

      public void incrementEntitiesCreated(int amount)
      Increment the total number of entities created by the test by the specified amount.
      Parameters:
      amount - by which to increment the count

    • getTotalEntitiesCreated

      public long getTotalEntitiesCreated()
      Return the total number of entity instances created in the environment.
      Returns:
      the number of entity instances created in the environment

    • incrementRelationshipsCreated

      public void incrementRelationshipsCreated(int amount)
      Increment the total number of relationships created by the test by the specified amount.
      Parameters:
      amount - by which to increment the count

    • getTotalRelationshipsCreated

      public long getTotalRelationshipsCreated()
      Return the total number of relationship instances created in the environment.
      Returns:
      the number of relationship instances created in the environment

    • incrementEntitiesFound

      public void incrementEntitiesFound(int amount)
      Increment the total number of entities found by the specified amount.
      Parameters:
      amount - by which to increment the count

    • getTotalEntitiesFound

      public long getTotalEntitiesFound()
      Return the total number of entities found in the environment.
      Returns:
      the number of entity instances found in the environment

    • incrementRelationshipsFound

      public void incrementRelationshipsFound(int amount)
      Increment the total number of relationships found by the specified amount.
      Parameters:
      amount - by which to increment the count

    • getTotalRelationshipsFound

      public long getTotalRelationshipsFound()
      Return the total number of relationships found in the environment.
      Returns:
      the number of relationship instances found in the environment

    • getReferenceCopyMetadataCollectionId

      public String getReferenceCopyMetadataCollectionId()
      Return the external metadata collection ID that can be used for reference copies.
      Returns:
      a generated external metadata collection ID that will be consistent across all tests

    • toString

      public String toString()
      toString() JSON-style
      Overrides:
      toString in class OpenMetadataConformanceWorkbenchWorkPad
      Returns:
      string description