Class McpResourcePage

java.lang.Object

com.soklet.McpResourcePage

All Implemented Interfaces:

McpOperationResult

@ThreadSafe
public final class McpResourcePage
extends Object
implements McpOperationResult

One immutable complete resources/list page.

The endpoint's resources-list cache policy owns the fixed cache scope and default time to live. A page may override only the time to live. The page is returned directly and does not require a McpCompleteResult wrapper. A localization-enabled server conservatively publishes a private, zero-time-to-live policy regardless of a page override.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	McpResourcePage.Builder	Mutable builder for an immutable resource page.

Method Summary

Modifier and Type	Method	Description
static @NonNull McpResourcePage.Builder	builder()
boolean	equals(@Nullable Object other)
@NonNull Optional<@NonNull Duration>	getCacheTimeToLiveOverride()	Returns this page's time-to-live override.
@NonNull McpJsonObject	getMetadata()
@NonNull Optional<@NonNull String>	getNextCursor()	Returns the opaque cursor clients should supply for the next page.
@NonNull List<@NonNull McpResourceDescriptor>	getResourceDescriptors()
int	hashCode()

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static @NonNull McpResourcePage.Builder builder()

Returns:

an empty resource-page builder

getResourceDescriptors

public @NonNull List<@NonNull McpResourceDescriptor> getResourceDescriptors()

Returns:

immutable resource descriptors in insertion order

getMetadata

public @NonNull McpJsonObject getMetadata()

Returns:

immutable result-level protocol extension metadata

getNextCursor

public @NonNull Optional<@NonNull String> getNextCursor()

Returns the opaque cursor clients should supply for the next page.

The application is responsible for binding a cursor to the intended page position, retained snapshot and catalog revision, authorization context, and expiry as required by its deployment. Soklet does not sign, encrypt, store, or verify the cursor.

Returns:

next cursor, or empty when this is the final page

getCacheTimeToLiveOverride

public @NonNull Optional<@NonNull Duration> getCacheTimeToLiveOverride()

Returns this page's time-to-live override.

Returns:

override, or empty to use the endpoint default

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

Returns:

whether every page property is structurally equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

structural page hash code