--- schema_version: "1" id: a0a79c0908fde774d1731fdd6c78596b62f9f6ad3e71ad9795a1cf210668660c title: Object Store Connector Reference collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/object-store-connector/latest/object-store-connector-reference.md canonical_url: https://docs.mulesoft.com/object-store-connector/latest/object-store-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: 3edbe03897277d074b192cd3301bf60c90cc11b84054bafca773c46881ee2d12 description: MuleSoft Documentation Site release: "1.3" latest: true --- --- product: Object Store Connector version: 1.3 is-latest-version: true --- # Object Store Connector Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Object Store Connector v1.3.0 Support Category: Select Connector that provides functionality to access and create object store instances. ## Configurations --- ### Config Default configuration #### Parameters

Name	Type	Description	Default Value	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.		x
Connection	Connection	The connection types to provide to this configuration.		x
Lock Timeout	Number	Timeout for acquiring ObjectStore locks. If not specified, operations wait indefinitely.
Lock Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the lock timeout parameter.	SECONDS

#### Connection Types ##### Connection A ConnectionProvider that returns the Mule runtime's default ObjectStoreManager. ###### Parameters

Name	Type	Description	Default Value	Required
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn't pass after exhausting the associated reconnection strategy.

## Operations - [Clear](#clear) - [Contains](#contains) - [Remove](#remove) - [Retrieve](#retrieve) - [Retrieve All](#retrieveAll) - [Retrieve All Keys](#retrieveAllKeys) - [Store](#store) ### Clear `` Removes all the contents in the store. #### Parameters

Name	Type	Description	Default Value	Required
Object Store	One of: Object Store Object Store (Object Store v2) Private Object Store	A reference to the object store to use. If not defined, the runtime's default partition is used.

#### Output

Type

Void

#### Throws - OS:STORE\_NOT\_AVAILABLE ### Contains `` Checks if there is any value associated to the given key. If no value exists for the key, then false is returned. This operation is synchronized at the key level. No other operation can access the same key on the same object store while this operation is running. If the runtime is running in cluster mode, this synchronization is also guaranteed across nodes. #### Parameters

Name	Type	Description	Default Value	Required
Key	String	The key of the object to be checked.		x
Object Store	One of: Object Store Object Store (Object Store v2) Private Object Store	A reference to the object store to use. If not defined, the runtime's default partition is used.
Target Variable	String	The name of a variable to store the operation's output.
Target Value	String	An expression to evaluate against the operation's output and store the expression outcome in the target variable.	`#[payload]`

#### Output

Type

Boolean

#### Throws - OS:INVALID\_KEY - OS:STORE\_NOT\_AVAILABLE ### Remove `` Removes the value associated to the given key. If no value exists for the key, then an OS:KEY\_NOT\_FOUND error is thrown. This operation is synchronized on the key level. No other operation is able to access the same key on the same object store while this operation is running. If the runtime is running in cluster mode, this synchronization is also guaranteed across nodes. #### Parameters

Name	Type	Description	Default Value	Required
Key	String	The key of the object to be removed.		x
Object Store	One of: Object Store Object Store (Object Store v2) Private Object Store	A reference to the object store to use. If not defined, the runtime's default partition will be used.

#### Output

Type

Void

#### Throws - OS:INVALID\_KEY - OS:STORE\_NOT\_AVAILABLE - OS:KEY\_NOT\_FOUND ### Retrieve `` Retrieves the value stored for the given key. If no value exists for the key, behavior depends on the defaultValue parameter. If the parameter was not provided or was resolved to a null value, then an OS:KEY\_NOT\_FOUND error is thrown. Otherwise, the defaultValue is returned, but that value is not stored. Finally, this operation is synchronized on the key level. No other operation can access the same key on the same object store while this operation is running. If the runtime is running in cluster mode, this synchronization is also guaranteed across nodes. #### Parameters

Name	Type	Description	Default Value	Required
Key	String	The key of the value to be retrieved.		x
Default Value	Any	Value to be returned if the key doesn't exist in the store.
Object Store	One of: Object Store Object Store (Object Store v2) Private Object Store	A reference to the object store to use. If not defined, the runtime's default partition is used.
Target Variable	String	The name of a variable to store the operation's output.
Target Value	String	An expression to evaluate against the operation's output and store the expression outcome in the target variable.	`#[payload]`

#### Output

Type

Any

#### Throws - OS:INVALID\_KEY - OS:KEY\_NOT\_FOUND - OS:STORE\_NOT\_AVAILABLE ### Retrieve All `` Retrieves all the key value pairs in the object store. #### Parameters

Name	Type	Description	Default Value
Object Store	One of: Object Store Object Store (Object Store v2) Private Object Store	A reference to the object store to use. If not defined, the runtime's default partition is used.
Target Variable	String	The name of a variable to store the operation's output.
Target Value	String	An expression to evaluate against the operation's output and store the expression outcome in the target variable.	`#[payload]`

#### Output

Type

Object

#### Throws - OS:STORE\_NOT\_AVAILABLE ### Retrieve All Keys `` Returns a List containing all keys that the object store currently holds values for. #### Parameters

Name	Type	Description	Default Value
Object Store	One of: Object Store Object Store (Object Store v2) Private Object Store	A reference to the object store to use. If not defined, the runtime's default partition is used.
Target Variable	String	The name of a variable to store the operation's output.
Target Value	String	An expression to evaluate against the operation's output and store the expression outcome in the target variable.	`#[payload]`

#### Output

Type	Array of String

#### Throws - OS:STORE\_NOT\_AVAILABLE ### Store `` Stores the given value using the given key. This operation can be used either for storing new values or updating existing ones, depending on the value of the failIfPresent. When that parameter is set to `false` (default value), then any pre-existing value associated with that key is overwritten. If the parameter is set to `true`, then an `OS:KEY_ALREADY_EXISTS` error is thrown instead. Another important consideration is regarding null values. It is not allowed to store a null value. However, a common use case is to obtain a value (most likely by evaluating a expression or transformation), testing the value for not null, storing it if present and doing nothing otherwise. The `failOnNullValue` parameter simplifies this use case. Setting it to `false` makes the connector skip null values, which prevents the need to use a `` router to check the condition, while using the default value of `true` makes the connector throw a `NULL_VALUE` error. Finally, this operation is synchronized on the key level. No other operation can access the same key on the same object store while this operation is running. If the runtime is running in cluster mode, this synchronization is also guaranteed across nodes. Running the same application with store operations across multiple nodes without clustering enabled might lead to inconsistent results due to the absence of coordinated locking. #### Parameters

Name	Type	Description	Default Value	Required
Key	String	The key of the value to be stored.		x
Value	Any	The value to be stored. Should not be null if `failOnNullValue` is set to true.	`#[payload]`
Fail If Present	Boolean	Whether to fail or update the pre-existing value if the key already exists on the store.	false
Fail On Null Value	Boolean	Whether to fail or skip the operation if the value is null.	true
Object Store	One of: Object Store Object Store (Object Store v2) Private Object Store	A reference to the object store to use. If not defined, the runtime's default partition is used.

#### Output

Type

Void

#### Throws - OS:INVALID\_KEY - OS:KEY\_ALREADY\_EXISTS - OS:KEY\_NOT\_FOUND - OS:NULL\_VALUE - OS:STORE\_NOT\_AVAILABLE ## Types ### Reconnection

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	Reconnect Reconnect Forever	The reconnection strategy to use.

### Reconnect

Field	Type	Description	Default Value
Frequency	Number	How often in milliseconds to reconnect.
Count	Number	How many reconnection attempts to make.
blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.	true

### Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often in milliseconds to reconnect.
blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.	true

### Object Store > [!NOTE] These settings do not apply to [Object Store v2](https://docs.mulesoft.com/object-store/).

Field	Type	Description	Default Value
Persistent	Boolean	Whether the store is persistent or transient.	true
Max entries	Number	The max number of entries allowed. Exceeding entries are removed when the expiration thread runs. If absent, then the described object store has no size boundaries.
Entry ttl	Number	The entry timeout. If absent, then the described object store has no time boundaries. If `entryTtl` is set to a value lower than or equal to zero, then the object store never expires.
Entry ttl unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	An entry’s time to live (`#entryTtl`).	SECONDS
Expiration interval	Number	How frequently the expiration thread should run. The default value is 1 minute. The `expirationInterval` field requires that the `maxEntries` or `entryTtl` fields also be set. If neither is set, then putting a value in `Expiration Interval` has no effect and the expiration thread does not run. If `expirationInterval` is set to a value lower than or equal to zero, then the object store never expires.	1
Expiration interval unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The expiration interval (`#expirationInterval`).	MINUTES
Configuration Reference	Object Store Connector	A reference to an `os:config` element used to declare this object store. If not provided, the Mule runtime’s default ObjectStoreManager is used. Setting this parameter is necessary only when you want to use a nondefault object store implementation: for example, if you want to have a store that is backed by Redis or JDBC.

### Object Store (Object Store v2) > [!NOTE] These settings apply only to [Object Store v2](https://docs.mulesoft.com/object-store/).

Field	Type	Description	Default Value
Persistent	Boolean	Whether the store is persistent or transient.	true
Max entries		Not configurable for Object Store v2. The maximum number of entries is unlimited.
Entry ttl	Number	The entry timeout. Ignored if the value of `expirationInterval` is less than or equal to `0`. Minimum value: 1 second Maximum value: 30 days Object Store v2 supports two TTL behaviors: Rolling TTL: Each entry access (read or write) extends the expiration timer. This behavior applies only when you omit `entryTtl` from the configuration (Mule 4.2.1 and later). Entries persist as long as the application accesses them at least once a week. Static TTL: The system fixes the expiration timer at the moment of the write operation. Reads don’t extend this timer. The system evicts the entry at `creation_time + entryTtl`. If the field contains: No value Mule versions 4.2.1 and later: Rolling TTL Mule versions earlier than 4.2.1: Static TTL of 30 days by default Less than or equal to `0` TTL is static and set to the maximum value (2592000 seconds/30 days). Reads do not extend the entry’s lifetime. Positive number TTL is static and set to the specified value (between 1 and 2592000 seconds) Greater than 30 days TTL is static and set to the maximum value (2592000 seconds/30 days). Specifying any `entryTtl` value, including `0`, configures the store with static TTL. To use rolling TTL, omit the `entryTtl` field entirely. Adding `entryTtl="0"` to a configuration that previously omitted the field changes the eviction behavior from rolling to static (30 days from entry creation, regardless of read activity). For information about the rolling and static TTL behavior, see Time to Live (TTL).	2592000 seconds (30 days)
Entry ttl unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The unit for the entry’s time to live (`entryTtl`).	SECONDS
Expiration interval	Positive number	How frequently the expiration thread runs. The `expirationInterval` field requires that the `entryTtl` field is set; otherwise, it is ignored. If `expirationInterval` is set to a positive value less than the value of `entryTtl`, the entry expires based on the `entryTtl` configuration. If `expirationInterval` is set to a value less than or equal to zero, `entryTtl` is ignored.	1 minute
Expiration interval unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The expiration interval (`expirationInterval`).	MINUTES
Configuration Reference	Object Store Connector	A reference to an `os:config` element used to declare this object store. If not provided, the Mule runtime’s default ObjectStoreManager is used. Setting this parameter is necessary only when you want to use a nondefault object store implementation: for example, if you want to have a store that is backed by Redis or JDBC.

### Object Store Connector

Field	Type	Description	Default Value
Config Name	String
Lock Timeout	Number	Timeout for acquiring ObjectStore locks. If not specified, operations wait indefinitely.
Lock Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the lock timeout parameter.	SECONDS

### Private Object Store > [!NOTE] These settings do not apply to [Object Store v2](https://docs.mulesoft.com/object-store/).

Field	Type	Description	Default Value
Alias	String	A friendly name to refer to this store in the management user interface. Provide this alias if you would like it to be easier to identify this store. If not provided, Mule auto generates an ID. Use an alias for consistent OAuth token refresh behavior. Without an alias, each Mule app node creates its own partition. This can lead to issues with OAuth token refresh, as each node might try to refresh the token independently. By providing an alias, you make sure that the Mule app uses the same partition across restarts. As long as the cached key or value is not expired, the caching scope is hit, and the Mule app continues to use the same token. This prevents unnecessary token refreshes and improves application efficiency.
Persistent	Boolean	Whether the store is persistent or transient.	true
Max entries	Number	The maximum number of entries allowed. Exceeding entries are removed when the expiration thread runs. If absent, then the described object store has no size boundaries.
Entry ttl	Number	The entry timeout. If absent, then the described object store has no time boundaries.
Entry ttl unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	An entry’s time to live (`#entryTtl`).	SECONDS
Expiration interval	Number	How frequently the expiration thread should run. The default value is 1 minute. The `expirationInterval` field requires that the `maxEntries` or `entryTtl` fields also be set. If neither is set, then putting a value in `expirationInterval` has no effect and the expiration thread does not run. If `expirationInterval` is set to a value lower than or equal to zero, then the object store never expires.	1
Expiration interval unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	The expiration interval (`#expirationInterval`).	MINUTES
Configuration Reference	Object Store Connector	A reference to an `os:config` element which is used to declare this object store. If not provided, the Mule runtime’s default ObjectStoreManager is used. Setting this parameter is necessary only when you want to use a nondefault object store implementation: for example, if you want to have a store that is backed by Redis or JDBC.

## See Also - [Salesforce Help](https://help.salesforce.com)