Package io.jenkins.plugins.restlistparam.model

Class ContinuationTokenPagination

java.lang.Object

hudson.model.AbstractDescribableImpl<Pagination>

io.jenkins.plugins.restlistparam.model.Pagination

io.jenkins.plugins.restlistparam.model.ContinuationTokenPagination

All Implemented Interfaces:

Describable<Pagination>, Serializable

public class ContinuationTokenPagination
extends Pagination

Reads a continuation token from the Json body and requests the configured endpoint again with the token as a query parameter, as Nexus 3 (continuationToken) or offset based APIs (nextPageStart) do.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContinuationTokenPagination.DescriptorImpl

Nested classes/interfaces inherited from class io.jenkins.plugins.restlistparam.model.Pagination

Pagination.NextPage, Pagination.Page, Pagination.PaginationDescriptor

Field Summary

Fields inherited from class io.jenkins.plugins.restlistparam.model.Pagination

DEFAULT_MAX_PAGES, MAX_MAX_PAGES, MIN_MAX_PAGES

Constructor Summary

Constructors

Constructor	Description
ContinuationTokenPagination(String tokenExpression, String queryParameter)

Method Summary

Modifier and Type	Method	Description
String	getQueryParameter()
String	getTokenExpression()
Optional<String>	incompatibilityWith(MimeType mimeType)	The error that makes this strategy unusable with mimeType at fetch time, if any.
Optional<Pagination.NextPage>	next(Pagination.Page page)	Finds the next page to request after page.
FormValidation	validate(MimeType mimeType)	Runs the same checks as the configuration form's field checks, for settings that were never saved.

Methods inherited from class io.jenkins.plugins.restlistparam.model.Pagination

checkMaxPages, getEffectiveMaxPages, getMaxPages, setMaxPages

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

ContinuationTokenPagination

@DataBoundConstructor
public ContinuationTokenPagination(String tokenExpression,
 String queryParameter)

Method Details

getTokenExpression

public String getTokenExpression()

getQueryParameter

public String getQueryParameter()

next

public Optional<Pagination.NextPage> next(Pagination.Page page)

Description copied from class: Pagination

Finds the next page to request after page.

Specified by:

next in class Pagination

Parameters:

page - The page just fetched

Returns:

The next page, or empty when page is the last one

incompatibilityWith

public Optional<String> incompatibilityWith(MimeType mimeType)

Description copied from class: Pagination

The error that makes this strategy unusable with mimeType at fetch time, if any. Configuration mistakes that can still be fetched (such as an out-of-range page limit) are not errors here.

Overrides:

incompatibilityWith in class Pagination

validate

public FormValidation validate(MimeType mimeType)

Description copied from class: Pagination

Runs the same checks as the configuration form's field checks, for settings that were never saved.

Overrides:

validate in class Pagination

Parameters:

mimeType - The parameter's MIME type

Returns:

The first failing check, or FormValidation.ok()