Class McpCachePolicy

java.lang.Object

com.soklet.McpCachePolicy

@ThreadSafe
public final class McpCachePolicy
extends Object

Immutable MCP application-cache policy.

The policy fixes both the cache scope and the default time to live for its owning operation. A result may override only the time to live where the operation's result type explicitly permits it.

The cache vocabulary is revision-sensitive rather than a permanent closed enum contract. Code switching on cache scope should retain a forward-compatible default for a future protocol revision.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)
static @NonNull McpCachePolicy	fromPrivateTimeToLive(@NonNull Duration timeToLive)	Creates a private policy with the supplied default time to live.
static @NonNull McpCachePolicy	fromPublicTimeToLive(@NonNull Duration timeToLive)	Creates a public policy with the supplied default time to live.
@NonNull McpCacheScope	getScope()
@NonNull Duration	getTimeToLive()
int	hashCode()
static @NonNull McpCachePolicy	privateNoCacheInstance()	Returns the shared private policy with a zero time to live.

Methods inherited from class Object

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

Method Details

privateNoCacheInstance

public static @NonNull McpCachePolicy privateNoCacheInstance()

Returns the shared private policy with a zero time to live.

Returns:

private zero-TTL policy

fromPrivateTimeToLive

public static @NonNull McpCachePolicy fromPrivateTimeToLive(@NonNull Duration timeToLive)

Creates a private policy with the supplied default time to live.

Parameters:

timeToLive - nonnegative whole-millisecond default duration

Returns:

private cache policy

fromPublicTimeToLive

public static @NonNull McpCachePolicy fromPublicTimeToLive(@NonNull Duration timeToLive)

Creates a public policy with the supplied default time to live.

Callers must use public scope only when results do not vary by principal, tenant, authorization partition, or other private identity.

Parameters:

timeToLive - nonnegative whole-millisecond default duration

Returns:

public cache policy

getTimeToLive

public @NonNull Duration getTimeToLive()

Returns:

nonnegative whole-millisecond default time to live

getScope

public @NonNull McpCacheScope getScope()

Returns:

fixed cache scope

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

Returns:

whether the cache scope and time to live are equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

structural cache-policy hash code