Package hudson.widgets

Class HistoryWidget<O extends ModelObject,T>

java.lang.Object

hudson.widgets.Widget

hudson.widgets.HistoryWidget<O,T>

Type Parameters:

O - Owner of the widget, typically Job

T - Type individual record, typically HistoricalBuild

Direct Known Subclasses:

BuildHistoryWidget

public class HistoryWidget<O extends ModelObject,T>
extends Widget

Displays the history of records on the side panel.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HistoryWidget.Adapter<T>
static final class	HistoryWidget.FactoryImpl

Field Summary

Fields

Modifier and Type	Field	Description
final HistoryWidget.Adapter<? super T>	adapter
Iterable<T>	baseList	The given data model of records.
final String	baseUrl	URL of the owner.
static final AlternativeUiTextProvider.Message<HistoryWidget<?,?>>	DISPLAY_NAME	Replaceable title for describing the kind of tasks this history shows.
final O	owner

Constructor Summary

Constructors

Constructor	Description
HistoryWidget(O owner, Iterable<T> baseList, HistoryWidget.Adapter<? super T> adapter)

Method Summary

Modifier and Type	Method	Description
void	doAjax(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, String n)	Handles AJAX requests from browsers to update build history.
String	getDisplayName()	Title of the widget.
String	getFirstTransientBuildKey()
HistoryPageFilter<T>	getHistoryPageFilter()	Get a HistoryPageFilter for rendering a page of queue items.
String	getNextBuildNumberToFetch()
protected String	getOwnerUrl()
Iterable<HistoryPageEntry<T>>	getRenderList()	The records to be rendered this time.
String	getUrlName()	Gets the URL path name.
boolean	isTrimmed()
protected HistoryPageFilter<T>	newPageFilter()
void	setNextBuildNumberToFetch(String nextBuildNumberToFetch)
void	setTrimmed(boolean trimmed)
protected HistoryPageFilter	updateFirstTransientBuildKey(HistoryPageFilter historyPageFilter)	Calculates the first transient build record.

Methods inherited from class hudson.widgets.Widget

getUrl

Methods inherited from class java.lang.Object

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

Field Details

DISPLAY_NAME

public static final AlternativeUiTextProvider.Message<HistoryWidget<?,?>> DISPLAY_NAME

Replaceable title for describing the kind of tasks this history shows. Defaults to "Build History".

baseList

public Iterable<T> baseList

The given data model of records. Newer ones first.

baseUrl

public final String baseUrl

URL of the owner.

owner

public final O extends ModelObject owner

adapter

public final HistoryWidget.Adapter<? super T> adapter

Constructor Details

HistoryWidget

public HistoryWidget(O owner,
 Iterable<T> baseList,
 HistoryWidget.Adapter<? super T> adapter)

Parameters:

owner - The parent model object that owns this widget.

Method Details

getOwnerUrl

protected String getOwnerUrl()

Overrides:

getOwnerUrl in class Widget

Returns:

The URL of the owner of this widget relative to context path. Always ends with a trailing slash. Can be null for backward compatibility with widgets annotated with @Extension.

getDisplayName

public String getDisplayName()

Title of the widget.

getUrlName

public String getUrlName()

Description copied from class: Widget

Gets the URL path name.

For example, if this method returns "xyz", and if the parent object (that this widget is associated with) is bound to /foo/bar/zot, then this widget object will be exposed to /foo/bar/zot/widget/xyz.

This method is useful when the widget needs to expose additional URLs, for example for serving AJAX requests.

This method should return a string that's unique among other Widgets. The default implementation returns the unqualified class name.

Overrides:

getUrlName in class Widget

getFirstTransientBuildKey

public String getFirstTransientBuildKey()

updateFirstTransientBuildKey

protected HistoryPageFilter updateFirstTransientBuildKey(HistoryPageFilter historyPageFilter)

Calculates the first transient build record. Everything ≥ this will be discarded when AJAX call is made.

Parameters:

historyPageFilter - The history page filter containing the list of builds.

Returns:

The history page filter that was passed in.

getRenderList

public Iterable<HistoryPageEntry<T>> getRenderList()

The records to be rendered this time.

getHistoryPageFilter

public HistoryPageFilter<T> getHistoryPageFilter()

Get a HistoryPageFilter for rendering a page of queue items.

newPageFilter

protected HistoryPageFilter<T> newPageFilter()

isTrimmed

public boolean isTrimmed()

setTrimmed

public void setTrimmed(boolean trimmed)

doAjax

public void doAjax(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @Header("n")
 String n)
            throws IOException,
jakarta.servlet.ServletException

Handles AJAX requests from browsers to update build history.

Parameters:

n - The build 'number' to fetch. This is string because various variants uses non-numbers as the build key.

Throws:

IOException

jakarta.servlet.ServletException

getNextBuildNumberToFetch

public String getNextBuildNumberToFetch()

setNextBuildNumberToFetch

public void setNextBuildNumberToFetch(String nextBuildNumberToFetch)