Class McpInputRequiredResult

java.lang.Object

com.soklet.McpInputRequiredResult

All Implemented Interfaces:

McpOperationResult

@ThreadSafe
public final class McpInputRequiredResult
extends Object
implements McpOperationResult

Immutable MCP result indicating that an operation needs additional client input before it can complete.

At least one input request or request-state value is required. Input requests retain their insertion order and their keys are unique within the result. Input-required results intentionally expose no cache controls.

For a durable McpRequestStateMode.APPLICATION_PROTECTED continuation, an application can persist the continuation in its own repository and return only an opaque handle as application request state. The client must carry the current handle on every retry, including retries over a new connection. Soklet transports that string; it does not store, rotate, protect, authorize, or recover the referenced application record.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	McpInputRequiredResult.Builder	Mutable builder for immutable McpInputRequiredResult values.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)
@NonNull Optional<@NonNull String>	getApplicationRequestState()	Returns opaque request state whose protection is application-owned.
@NonNull Optional<@NonNull McpJsonValue>	getFrameworkRequestState()	Returns application-defined JSON for Soklet to protect as request state.
@NonNull Map<@NonNull String, @NonNull McpInputRequest>	getInputRequests()	Returns the input requests in insertion order.
@NonNull McpJsonObject	getMetadata()	Returns application-supplied protocol extension metadata.
int	hashCode()
static @NonNull McpInputRequiredResult.Builder	withApplicationRequestState(@NonNull String applicationRequestState)	Vends a builder containing opaque request state protected by the application.
static @NonNull McpInputRequiredResult.Builder	withFrameworkRequestState(@NonNull McpJsonValue frameworkRequestState)	Vends a builder containing application JSON for Soklet to protect as request state.
static @NonNull McpInputRequiredResult.Builder	withInputRequest(@NonNull String key, @NonNull McpInputRequest inputRequest)	Vends a builder containing its required first input request.

Methods inherited from class Object

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

Method Details

withInputRequest

public static @NonNull McpInputRequiredResult.Builder withInputRequest(@NonNull String key,
 @NonNull McpInputRequest inputRequest)

Vends a builder containing its required first input request.

Parameters:

key - input-response correlation key

inputRequest - server-initiated request

Returns:

input-required-result builder

Throws:

NullPointerException - if an argument is null

withFrameworkRequestState

public static @NonNull McpInputRequiredResult.Builder withFrameworkRequestState(@NonNull McpJsonValue frameworkRequestState)

Vends a builder containing application JSON for Soklet to protect as request state.

Parameters:

frameworkRequestState - application-defined JSON state

Returns:

input-required-result builder

Throws:

NullPointerException - if frameworkRequestState is null

withApplicationRequestState

public static @NonNull McpInputRequiredResult.Builder withApplicationRequestState(@NonNull String applicationRequestState)

Vends a builder containing opaque request state protected by the application.

Parameters:

applicationRequestState - nonempty opaque application-protected state

Returns:

input-required-result builder

Throws:

NullPointerException - if applicationRequestState is null

IllegalArgumentException - if applicationRequestState is empty or contains malformed UTF-16

getInputRequests

public @NonNull Map<@NonNull String, @NonNull McpInputRequest> getInputRequests()

Returns the input requests in insertion order.

Returns:

immutable input-request map

getFrameworkRequestState

public @NonNull Optional<@NonNull McpJsonValue> getFrameworkRequestState()

Returns application-defined JSON for Soklet to protect as request state.

This inspection value retains the supplied representation. After protection and a verified retry, numeric leaves returned by McpRequestContext.getFrameworkRequestState() use the canonical numeric form and do not retain the original decimal scale.

Returns:

framework-protected request-state value, or empty when absent

getApplicationRequestState

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

Returns opaque request state whose protection is application-owned.

The value may be a handle into an application-owned durable repository. Its presence does not imply that Soklet has validated the handle's integrity, expiry, duplicate-use status, or binding to the admitted principal or authorization context.

Returns:

application-protected request-state value, or empty when absent

getMetadata

public @NonNull McpJsonObject getMetadata()

Returns application-supplied protocol extension metadata.

Returns:

immutable result metadata

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

Returns:

whether every input-required result property is structurally equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

structural input-required result hash code