Package io.jenkins.plugins.octanesuitegatebyembiti.actions

Class OctaneGateReportAction

java.lang.Object

io.jenkins.plugins.octanesuitegatebyembiti.actions.OctaneGateReportAction

All Implemented Interfaces:

Action, ModelObject, OctaneGateReportPublisher, Serializable, RunAction2

public class OctaneGateReportAction
extends Object
implements RunAction2, OctaneGateReportPublisher, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OctaneGateReportAction.RefreshCallback
static final record	OctaneGateReportAction.RefreshResult
static enum	OctaneGateReportAction.RefreshStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final String	URL_NAME

Constructor Summary

Constructors

Constructor	Description
OctaneGateReportAction()

Method Summary

Modifier and Type	Method	Description
static OctaneGateReportAction	attachTo(Run<?,?> run, GateRequest request)
boolean	awaitNextPollOrManualExit(Duration duration)
OctaneGateReportSnapshot	awaitReconciledSnapshot()
void	clearManualExitCallback(Runnable callback)
void	clearRefreshCallback(OctaneGateReportAction.RefreshCallback callback)
void	doData(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response, String section, int cursor, int limit)
org.kohsuke.stapler.HttpResponse	doExitOctaneAndContinue()
void	doScaleReportScript(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response)
void	doSnapshot(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response)
void	doTestManagementScript(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response)
String	getDisplayName()
String	getIconFileName()
long	getManualExitRequestedAtMillis()
int	getRefreshSeconds()
String	getReportDataChecksum()
int	getReportDataSchemaVersion()
String	getReportUrl()
OctaneGateReportSnapshot	getSnapshot()
String	getTestManagementJson()
String	getUrlName()
boolean	isAutoRefresh()
boolean	isExtendedExitAvailable()
boolean	isExtendedExitControlVisible()
boolean	isManualExitPending()
boolean	isManualExitRequested()
void	onAttached(Run<?,?> run)
void	onError(String message, GateRequest request)
void	onExtendedTime(GateResult result, StatusClassifier classifier)
void	onFinal(OctaneGateReportState state, String message, GateResult result, StatusClassifier classifier)
void	onFinalizing(String message)
void	onLoad(Run<?,?> run)
void	onPoll(GateResult result, StatusClassifier classifier)
void	onWaiting(GateRequest request, List<String> suiteRunIds)
OctaneGateReportAction.RefreshResult	refreshForEmail(Duration threshold, Instant now)
OctaneGateReportAction.RefreshResult	refreshIfStale(Duration threshold, Instant now)
void	setManualExitCallback(Runnable callback)
void	setRefreshCallback(OctaneGateReportAction.RefreshCallback callback)

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getDescription, getEvent, getGroup, getSemantic, isVisibleInContextMenu

Field Details

URL_NAME

public static final String URL_NAME

See Also:

• Constant Field Values

Constructor Details

OctaneGateReportAction

public OctaneGateReportAction()

Method Details

attachTo

public static OctaneGateReportAction attachTo(Run<?,?> run,
 GateRequest request)

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

onAttached

public void onAttached(Run<?,?> run)

Specified by:

onAttached in interface RunAction2

onLoad

public void onLoad(Run<?,?> run)

Specified by:

onLoad in interface RunAction2

onWaiting

public void onWaiting(GateRequest request,
 List<String> suiteRunIds)

Specified by:

onWaiting in interface OctaneGateReportPublisher

onPoll

public void onPoll(GateResult result,
 StatusClassifier classifier)

Specified by:

onPoll in interface OctaneGateReportPublisher

onExtendedTime

public void onExtendedTime(GateResult result,
 StatusClassifier classifier)

Specified by:

onExtendedTime in interface OctaneGateReportPublisher

onFinalizing

public void onFinalizing(String message)

Specified by:

onFinalizing in interface OctaneGateReportPublisher

onFinal

public void onFinal(OctaneGateReportState state,
 String message,
 GateResult result,
 StatusClassifier classifier)

Specified by:

onFinal in interface OctaneGateReportPublisher

onError

public void onError(String message,
 GateRequest request)

Specified by:

onError in interface OctaneGateReportPublisher

getSnapshot

public OctaneGateReportSnapshot getSnapshot()

awaitReconciledSnapshot

public OctaneGateReportSnapshot awaitReconciledSnapshot()
                                                 throws InterruptedException

Throws:

InterruptedException

getRefreshSeconds

public int getRefreshSeconds()

isAutoRefresh

public boolean isAutoRefresh()

getReportDataChecksum

public String getReportDataChecksum()

getTestManagementJson

public String getTestManagementJson()

getReportDataSchemaVersion

public int getReportDataSchemaVersion()

getReportUrl

public String getReportUrl()

doSnapshot

public void doSnapshot(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 response)
                throws IOException

Throws:

IOException

doData

public void doData(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 response,
 @QueryParameter
 String section,
 @QueryParameter
 int cursor,
 @QueryParameter
 int limit)
            throws IOException

Throws:

IOException

doScaleReportScript

public void doScaleReportScript(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 response)
                         throws IOException

Throws:

IOException

doTestManagementScript

public void doTestManagementScript(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 response)
                            throws IOException

Throws:

IOException

doExitOctaneAndContinue

public org.kohsuke.stapler.HttpResponse doExitOctaneAndContinue()

setManualExitCallback

public void setManualExitCallback(Runnable callback)

clearManualExitCallback

public void clearManualExitCallback(Runnable callback)

setRefreshCallback

public void setRefreshCallback(OctaneGateReportAction.RefreshCallback callback)

clearRefreshCallback

public void clearRefreshCallback(OctaneGateReportAction.RefreshCallback callback)

refreshIfStale

public OctaneGateReportAction.RefreshResult refreshIfStale(Duration threshold,
 Instant now)
                                                    throws Exception

Throws:

Exception

refreshForEmail

public OctaneGateReportAction.RefreshResult refreshForEmail(Duration threshold,
 Instant now)
                                                     throws Exception

Throws:

Exception

isManualExitRequested

public boolean isManualExitRequested()

Specified by:

isManualExitRequested in interface OctaneGateReportPublisher

getManualExitRequestedAtMillis

public long getManualExitRequestedAtMillis()

isManualExitPending

public boolean isManualExitPending()

isExtendedExitAvailable

public boolean isExtendedExitAvailable()

isExtendedExitControlVisible

public boolean isExtendedExitControlVisible()

awaitNextPollOrManualExit

public boolean awaitNextPollOrManualExit(Duration duration)
                                  throws InterruptedException

Specified by:

awaitNextPollOrManualExit in interface OctaneGateReportPublisher

Throws:

InterruptedException