Module org.mule.sdk.api

Package org.mule.sdk.api.store

Class ObjectStoreSettings

java.lang.Object

org.mule.sdk.api.store.ObjectStoreSettings

@MinMuleVersion("4.5.0")
public class ObjectStoreSettings
extends Object

Immutable object which contains settings parameters regarding how should a particular ObjectStore instance behave.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectStoreSettings.Builder	A Builder for creating ObjectStoreSettings

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_EXPIRATION_INTERVAL

Method Summary

Modifier and Type	Method	Description
static ObjectStoreSettings.Builder	builder()
Optional<Long>	getEntryTTL()	The entry timeout in milliseconds.
long	getExpirationInterval()	How frequently (in milliseconds) should the expiration thread run.
Optional<Integer>	getMaxEntries()	Returns the max number of entries allowed.
boolean	isPersistent()	Returns Whether the store is persistent or transient.
static ObjectStoreSettings	unmanagedPersistent()	Creates a new ObjectStoreSettings instance which describes a persistent store with no expiration or boundaries.
static ObjectStoreSettings	unmanagedTransient()	Creates a new ObjectStoreSettings instance which describes a transient store with no expiration or boundaries.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_EXPIRATION_INTERVAL

public static final long DEFAULT_EXPIRATION_INTERVAL

Method Details

builder

public static ObjectStoreSettings.Builder builder()

Returns:

a new ObjectStoreSettings.Builder

unmanagedTransient

public static ObjectStoreSettings unmanagedTransient()

Creates a new ObjectStoreSettings instance which describes a transient store with no expiration or boundaries.

Returns:

a new ObjectStoreSettings

unmanagedPersistent

public static ObjectStoreSettings unmanagedPersistent()

Creates a new ObjectStoreSettings instance which describes a persistent store with no expiration or boundaries.

Returns:

a new ObjectStoreSettings

isPersistent

public boolean isPersistent()

Returns Whether the store is persistent or transient. If not set through ObjectStoreSettings.Builder.persistent(boolean), then it will default to true

getMaxEntries

public Optional<Integer> getMaxEntries()

Returns the max number of entries allowed. Exceeding entries will be removed when expiration thread runs. If absent, then the described ObjectStore will have no size boundaries.

getEntryTTL

public Optional<Long> getEntryTTL()

The entry timeout in milliseconds. If absent, then the described ObjectStore will have no time boundaries.

getExpirationInterval

public long getExpirationInterval()

How frequently (in milliseconds) should the expiration thread run. If not set through ObjectStoreSettings.Builder.expirationInterval(Long), it will default to DEFAULT_EXPIRATION_INTERVAL