Package com.cloudbees.hudson.plugins.folder.computed

Class FolderComputation<I extends TopLevelItem>

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

com.cloudbees.hudson.plugins.folder.computed.FolderComputation<I>

All Implemented Interfaces:

ModelObject, Queue.Executable, Saveable, SearchableModelObject, SearchItem, Runnable, WithConsoleUrl, FullyNamedModelObject, Loadable, ModelObjectWithContextMenu

public class FolderComputation<I extends TopLevelItem>
extends Actionable
implements FullyNamedModelObject, Queue.Executable, Saveable, Loadable

A particular “run” of ComputedFolder.

Since:

4.11-beta-1

Nested Class Summary

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields

Modifier and Type	Field	Description
static final AlternativeUiTextProvider.Message<FolderComputation>	DISPLAY_NAME	Allow other code to override the display name for FolderComputation.

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FolderComputation(ComputedFolder<I> folder, FolderComputation<I> previous)

Method Summary

Modifier and Type	Method	Description
StreamTaskListener	createEventsListener()
void	doConsoleText(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Sends out the raw console output.
void	doConsoleText(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Deprecated. use doConsoleText(StaplerRequest2, StaplerResponse2)
org.kohsuke.stapler.HttpResponse	doStop()	Stops this build if it's still going.
String	getBuildStatusIconClassName()
List<Cause>	getCauses()
protected XmlFile	getDataFile()
String	getDisplayName()
String	getDurationString()
long	getEstimatedDuration()
File	getEventsFile()
AnnotatedLargeText<FolderComputation<I>>	getEventsText()
String	getFullDisplayName()
String	getFullName()	May be used by OldDataMonitor in its manage view.
BallColor	getIconColor()
File	getLogFile()
InputStream	getLogInputStream()	Returns an input stream that reads from the log file.
AnnotatedLargeText<FolderComputation<I>>	getLogText()
ComputedFolder<I>	getParent()
Result	getPreviousResult()
Result	getResult()
String	getSearchUrl()
Calendar	getTimestamp()
String	getUrl()
boolean	isBuilding()
boolean	isLogUpdated()
void	load()
void	run()
void	save()
String	toString()
void	writeLogTo(long offset, org.apache.commons.jelly.XMLOutput out)
void	writeWholeLogTo(OutputStream out)

Methods inherited from class hudson.model.Actionable

addAction, addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, getDynamic, getDynamic, removeAction, removeActions, replaceAction, replaceActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Queue.Executable

getConsoleUrl, getParentExecutable

Methods inherited from interface hudson.search.SearchItem

getSearchGroup, getSearchIcon

Field Details

DISPLAY_NAME

public static final AlternativeUiTextProvider.Message<FolderComputation> DISPLAY_NAME

Allow other code to override the display name for FolderComputation.

Constructor Details

FolderComputation

protected FolderComputation(@NonNull
 ComputedFolder<I> folder,
 @CheckForNull
 FolderComputation<I> previous)

Method Details

run

public void run()

Specified by:

run in interface Queue.Executable

Specified by:

run in interface Runnable

save

public void save()
          throws IOException

Specified by:

save in interface Saveable

Throws:

IOException

load

public void load()
          throws IOException

Specified by:

load in interface Loadable

Throws:

IOException

getLogFile

@NonNull
public File getLogFile()

getEventsFile

@NonNull
public File getEventsFile()

createEventsListener

@NonNull
public StreamTaskListener createEventsListener()

getDataFile

@NonNull
protected XmlFile getDataFile()

getCauses

public List<Cause> getCauses()

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

getFullName

public String getFullName()

May be used by OldDataMonitor in its manage view.

Returns:

AbstractItem.getFullName()

getFullDisplayName

public String getFullDisplayName()

Specified by:

getFullDisplayName in interface FullyNamedModelObject

getSearchUrl

public String getSearchUrl()

Specified by:

getSearchUrl in interface SearchItem

getParent

@NonNull
public ComputedFolder<I> getParent()

Specified by:

getParent in interface Queue.Executable

getEstimatedDuration

public long getEstimatedDuration()

Specified by:

getEstimatedDuration in interface Queue.Executable

isBuilding

public boolean isBuilding()

isLogUpdated

public boolean isLogUpdated()

getLogText

@NonNull
public AnnotatedLargeText<FolderComputation<I>> getLogText()

getEventsText

@NonNull
public AnnotatedLargeText<FolderComputation<I>> getEventsText()

writeLogTo

public void writeLogTo(long offset,
 org.apache.commons.jelly.XMLOutput out)
                throws IOException

Throws:

IOException

writeWholeLogTo

public void writeWholeLogTo(@NonNull
 OutputStream out)
                     throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

doConsoleText

public void doConsoleText(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                   throws IOException

Sends out the raw console output.

Parameters:

req - the request

rsp - the response.

Throws:

IOException - if things go wrong.

doConsoleText

@Deprecated
@StaplerNotDispatchable
public void doConsoleText(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
                   throws IOException

Deprecated.

use doConsoleText(StaplerRequest2, StaplerResponse2)

Throws:

IOException

doStop

public org.kohsuke.stapler.HttpResponse doStop()
                                        throws IOException,
jakarta.servlet.ServletException

Stops this build if it's still going.

Returns:

the Http response.

Throws:

IOException

jakarta.servlet.ServletException

getLogInputStream

@NonNull
public InputStream getLogInputStream()
                              throws IOException

Returns an input stream that reads from the log file. It will use a gzip-compressed log file (log.gz) if that exists.

Returns:

An input stream from the log file. If the log file does not exist, the error message will be returned to the output.

Throws:

IOException - if things go wrong

getResult

@CheckForNull
public Result getResult()

getTimestamp

@NonNull
public Calendar getTimestamp()

getDurationString

@NonNull
public String getDurationString()

getUrl

@NonNull
public String getUrl()

getPreviousResult

@CheckForNull
public Result getPreviousResult()

getIconColor

@NonNull
public BallColor getIconColor()

getBuildStatusIconClassName

public String getBuildStatusIconClassName()

toString

public String toString()

Specified by:

toString in interface Queue.Executable

Overrides:

toString in class Object