Package com.atlassian.jira.functest.framework.backdoor

Class ClusterMessageCleaningServiceControl

java.lang.Object
com.atlassian.jira.testkit.client.RestApiClient<ClusterMessageCleaningServiceControl>
com.atlassian.jira.testkit.client.BackdoorControl<ClusterMessageCleaningServiceControl>
com.atlassian.jira.functest.framework.backdoor.BackdoorControl<ClusterMessageCleaningServiceControl>
com.atlassian.jira.functest.framework.backdoor.ClusterMessageCleaningServiceControl
public class ClusterMessageCleaningServiceControl extends BackdoorControl<ClusterMessageCleaningServiceControl>
Control for accessing the ClusterMessageCleaningServiceBackdoor via REST endpoints.

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.atlassian.jira.testkit.client.RestApiClient

    com.atlassian.jira.testkit.client.RestApiClient.BackdoorLoggingFilter, com.atlassian.jira.testkit.client.RestApiClient.JsonMediaTypeFilter, com.atlassian.jira.testkit.client.RestApiClient.RestCall, com.atlassian.jira.testkit.client.RestApiClient.SessionlessConsistencyFilter

  • Field Summary

    Fields inherited from class com.atlassian.jira.testkit.client.BackdoorControl

    API_REST_PATH, API_REST_VERSION, DEFAULT_REST_PATH, logger, rootPath

    Fields inherited from class com.atlassian.jira.testkit.client.RestApiClient

    REST_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClusterMessageCleaningServiceControl(com.atlassian.jira.testkit.client.JIRAEnvironmentData environmentData)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getFixedClockTime()
    Get the current fixed clock time.
    String
    getRetentionPeriod()
    Get the current retention period.
    boolean
    runService()
    Run the cluster message cleaning service.
    void
    setFixedClockTime(long timeMillis)
    Set the fixed clock time for the cluster message cleaning service.
    void
    setRetentionPeriod(String period)
    Set the retention period for the cluster message cleaning service.

    Methods inherited from class com.atlassian.jira.functest.framework.backdoor.BackdoorControl

    createResource

    Methods inherited from class com.atlassian.jira.testkit.client.BackdoorControl

    createResourceForPath, createResourceForPath, get, getRestModulePath

    Methods inherited from class com.atlassian.jira.testkit.client.RestApiClient

    anonymous, authenticate, authoriseWithOAuth2, authoriseWithOAuth2, cleanUp, client, createResource, createResourceGadget, createResourceInternal, errorResponse, expanded, getCredentialsProvider, getEnvironmentData, loginAs, loginAs, registerResponse, resourceRoot, resourceRoot, setOf, toResponse, toResponse, toResponse, withCredentialsProvider

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ClusterMessageCleaningServiceControl

      public ClusterMessageCleaningServiceControl(com.atlassian.jira.testkit.client.JIRAEnvironmentData environmentData)

  • Method Details

    • setRetentionPeriod

      public void setRetentionPeriod(String period)
      Set the retention period for the cluster message cleaning service.
      Parameters:
      period - the retention period (e.g., "1d", "2d", "1h")

    • setFixedClockTime

      public void setFixedClockTime(long timeMillis)
      Set the fixed clock time for the cluster message cleaning service.
      Parameters:
      timeMillis - the fixed clock time in milliseconds

    • getRetentionPeriod

      public String getRetentionPeriod()
      Get the current retention period.
      Returns:
      the current retention period as a string

    • getFixedClockTime

      public long getFixedClockTime()
      Get the current fixed clock time.
      Returns:
      the current fixed clock time as a long

    • runService

      public boolean runService()
      Run the cluster message cleaning service.
      Returns:
      true if the service ran successfully (HTTP 200), false otherwise