com.ibm.websphere.objectgrid.config
Interface BackingMapConfiguration

public interface BackingMapConfiguration

A BackingMapConfiguration object can be used to override BackingMap settings on the client side. The com.ibm.websphere.objectgrid.plugins.Evictor and the com.ibm.websphere.objectgrid.plugins.MapEventListener Plugins can be overridden. Other Evictor related settings can be adjusted as well as client, near-cache specific options.

Use the com.ibm.websphere.objectgrid.config.ObjectGridConfigFactory.createBackingMapConfiguration(String) method to create a BackingMapConfiguration

Since:

WAS XD 6.0.1.2, XC10

See Also:

Evictor, MapEventListener, Plugin, ObjectGridConfigFactory

Method Summary

void	addPlugin(Plugin plugin) Add a Plugin to this BackingMapConfiguration.
String	getEvictionTriggers() Gets the list of eviction triggers for this BackingMapConfiguration.
OutputFormat	getKeyOutputFormat() Retrieves the data format for all data access APIs that return cache keys.
String	getName() Get the name of this BackingMapConfiguration
int	getNumberOfBuckets() Deprecated. Deprecated in 8.6. Buckets are no longer required. Use the isNearCacheEnabled() flag to disable the near cache in the ObjectGrid configuration XML file.
List	getPlugins() Get the Plugins that have been attached to this BackingMapConfiguration.
int	getTimeToLive() Gets the "time to live" for each map entry.
TTLType	getTtlEvictorType() Gets the "time to live" Evictor type for this BackingMapConfiguration.
OutputFormat	getValueOutputFormat() Retrieves the data format for all data access APIs that return cache values.
Boolean	isNearCacheEnabled() If true, the client local cache is enabled for supported configurations.
Boolean	isNearCacheInvalidationEnabled() If true, clients with local caches are automatically invalidated when the data grid map is updated.
Boolean	isNearCacheLastAccessTTLSyncEnabled() If true, clients automatically send time-to-live access information to the remote data grid when accessed and the TTLType.LAST_ACCESS_TIME TTL evictor type is configured.
void	setEvictionTriggers(String evictionTriggers) Sets the eviction triggers for this BackingMapConfiguration.
void	setKeyOutputFormat(OutputFormat dataFormat) Sets the data format for all data access APIs that return cache keys.
void	setNearCacheEnabled(Boolean nearCacheEnabled) Enables or disables the client local cache for supported configurations.
void	setNearCacheInvalidationEnabled(Boolean nearCacheInvalidationEnabled) Set to true to enable client near cache invalidation.
void	setNearCacheLastAccessTTLSyncEnabled(Boolean nearCacheLastAccessTTLSyncEnabled) Enables or disables time-to-live access information synchronization to the remote data grid when accessed and the TTLType.LAST_ACCESS_TIME TTL evictor type is configured.
void	setNumberOfBuckets(int numBuckets) Deprecated. Deprecated in 8.6. Buckets are no longer required. Use the isNearCacheEnabled() flag to disable the near cache in the ObjectGrid configuration XML file.
void	setPlugins(List pluginList) Set the Plugins for this BackingMapConfiguration.
void	setTimeToLive(int seconds) Sets "time to live" of each BackingMap entry in seconds.
void	setTtlEvictorType(TTLType ttlEvictorType) Set the "time to live" Evictor type for this BackingMapConfiguration.
void	setValueOutputFormat(OutputFormat dataFormat) Sets the data format for all data access APIs that return cache values.

Method Detail

getName

String getName()

Get the name of this BackingMapConfiguration

Returns:

The name of this BackingMapConfiguration

addPlugin

void addPlugin(Plugin plugin)

Add a Plugin to this BackingMapConfiguration. The Plugins that can be overridden on a client-side BackingMap are com.ibm.websphere.objectgrid.plugins.Evictor and com.ibm.websphere.objectgrid.plugins.MapEventListener.

Parameters:

plugin -

See Also:

setPlugins(List)

setPlugins

void setPlugins(List pluginList)

Set the Plugins for this BackingMapConfiguration. Any Plugins that were previously attached to this BackingMapConfiguration object will be overridden.

Parameters:

pluginList - - a List of Plugins

See Also:

addPlugin(Plugin)

getPlugins

List getPlugins()

Get the Plugins that have been attached to this BackingMapConfiguration.

Returns:

a List of Plugin objects

getNumberOfBuckets

int getNumberOfBuckets()

Deprecated. Deprecated in 8.6. Buckets are no longer required. Use the isNearCacheEnabled() flag to disable the near cache in the ObjectGrid configuration XML file.

Gets the number of buckets defined for this BackingMapConfiguration.

Returns:

the number of buckets defined

setNumberOfBuckets

void setNumberOfBuckets(int numBuckets)

Deprecated. Deprecated in 8.6. Buckets are no longer required. Use the isNearCacheEnabled() flag to disable the near cache in the ObjectGrid configuration XML file.

Sets the number of buckets for this BackingMapConfiguration. This will be used by the BackingMap.

The BackingMap implementation uses a hash map for its implementation. If there are a lot of entries in the BackingMap then more buckets means better performance because the risk of collisions is lower as the number of buckets grows. More buckets also means more concurrency.

Parameters:

numBuckets -

See Also:

BackingMap.setNumberOfBuckets(int)

getTimeToLive

int getTimeToLive()

Gets the "time to live" for each map entry. The value is in seconds.

Returns:

the "time to live" in seconds

setTimeToLive

void setTimeToLive(int seconds)

Sets "time to live" of each BackingMap entry in seconds.

If this method is not called, the lifetime of an entry is forever (or until the application explicitly removes or invalidates the entry, or a user defined Evictor evicts the entry).

Parameters:

seconds -

getTtlEvictorType

TTLType getTtlEvictorType()

Gets the "time to live" Evictor type for this BackingMapConfiguration. If setTtlEvictorType was not called, this method will return null and the BackingMap based off this BackingMapConfiguration will use TTLType.NONE

Returns:

the "time to live" Evictor type or null if setTtlEvictorType(TTLType) was not called

See Also:

setTimeToLive(int)

setTtlEvictorType

void setTtlEvictorType(TTLType ttlEvictorType)

Set the "time to live" Evictor type for this BackingMapConfiguration. This is used to determine how expiration time of a BackingMap entry is computed.

If this method is not called, TTLType.NONE is used to indicate the map entry has no expiration time (e.g. is allowed to live until explicitly removed or invalidated by the application, or evicted by a user defined Evictor).

Parameters:

ttlEvictorType -

See Also:

BackingMap.setTtlEvictorType(TTLType)

getEvictionTriggers

String getEvictionTriggers()

Gets the list of eviction triggers for this BackingMapConfiguration.

See BackingMap for a list of valid eviction triggers.

Returns:

a semicolon separated list of eviction triggers or null if setEvictionTriggers(String) was not called

Since:

WAS XD 6.1.0.3

setEvictionTriggers

void setEvictionTriggers(String evictionTriggers)

Sets the eviction triggers for this BackingMapConfiguration. All evictors will use the eviction supplied triggers.

See BackingMap for a list of valid eviction triggers.

Parameters:

evictionTriggers - a semicolon separated list of eviction triggers

Since:

WAS XD 6.1.0.3

isNearCacheInvalidationEnabled

Boolean isNearCacheInvalidationEnabled()

If true, clients with local caches are automatically invalidated when the data grid map is updated.

Returns:

true if client near cache invalidation is enabled, false if client near cache invalidation is disabled, or null if the override is not specified.

Since:

8.6

setNearCacheInvalidationEnabled

void setNearCacheInvalidationEnabled(Boolean nearCacheInvalidationEnabled)

Set to true to enable client near cache invalidation. When enabled, the client will receive events from the remote data grid to invalidate data from the local cache.

Parameters:

nearCacheInvalidationEnabled - If true, the client near cache invalidation is enabled. If false, invalidation is disabled. If null, the override is not specified and the client will use the setting from the remote data grid.

Since:

8.6

isNearCacheLastAccessTTLSyncEnabled

Boolean isNearCacheLastAccessTTLSyncEnabled()

If true, clients automatically send time-to-live access information to the remote data grid when accessed and the TTLType.LAST_ACCESS_TIME TTL evictor type is configured.

Returns:

True if last-access time-to-live information is sent to the remote data grid, false if last-access time information is not sent, or null if the override is not specified.

Since:

8.6

setNearCacheLastAccessTTLSyncEnabled

void setNearCacheLastAccessTTLSyncEnabled(Boolean nearCacheLastAccessTTLSyncEnabled)

Enables or disables time-to-live access information synchronization to the remote data grid when accessed and the TTLType.LAST_ACCESS_TIME TTL evictor type is configured.

Parameters:

nearCacheLastAccessTTLSyncEnabled - If true, the last-access time-to-live information is sent to the remote data grid. If false, the last-access information is not sent. If null, the override is not specified and the client will use the setting from the remote data grid.

Since:

8.6

isNearCacheEnabled

Boolean isNearCacheEnabled()

If true, the client local cache is enabled for supported configurations. The client near cache can only be enabled when using optimistic locking or when locking is disabled.

Returns:

True if the client near cache is enabled, false if the near cache is disabled, or null of the override is not specified.

Since:

8.6

setNearCacheEnabled

void setNearCacheEnabled(Boolean nearCacheEnabled)

Enables or disables the client local cache for supported configurations. The client near cache can only be enabled when using optimistic locking or when locking is disabled.

Parameters:

nearCacheEnabled - If true, the client local cache is enabled for supported configurations. If false, the client local cache is disabled. If null, the override is not specified and the client will use the setting from the remote data grid.

getKeyOutputFormat

OutputFormat getKeyOutputFormat()

Retrieves the data format for all data access APIs that return cache keys.

Returns:

the data format or null if the default should be used.

Since:

8.6

setKeyOutputFormat

void setKeyOutputFormat(OutputFormat dataFormat)

Sets the data format for all data access APIs that return cache keys.

Parameters:

dataFormat - the data format to use or null to use the default.

Since:

8.6

getValueOutputFormat

OutputFormat getValueOutputFormat()

Retrieves the data format for all data access APIs that return cache values.

Returns:

the data format.

Since:

8.6

setValueOutputFormat

void setValueOutputFormat(OutputFormat dataFormat)

Sets the data format for all data access APIs that return cache values.

Parameters:

dataFormat - the data format to use or null to use the default.

Since:

8.6