IBM WebSphere® DataPower® XC10 Appliance
Release 2.0 Client API Specification
A B C D E F G H I J K L M N O P Q R S T U V W

A

accept(LogElement) - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequenceFilter
Returns true if the given LogElement should be used; false if the given LogElement should not be used.
ACCESS_BY_CREATOR_ONLY_COMPLEMENT - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
The access by creator only authorization is enabled to complement the ObjectGrid map authorization.
ACCESS_BY_CREATOR_ONLY_DISABLED - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
The access by creator only authorization is disabled.
ACCESS_BY_CREATOR_ONLY_SUPERSEDE - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
The access by creator only authorization is enabled to supersede the ObjectGrid map authorization.
activate() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
 
activate() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
 
activate() - Method in interface com.ibm.websphere.objectgrid.plugins.Evictor
This method is called to activate the Evictor.
addBackingMapConfiguration(BackingMapConfiguration) - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Add a BackingMapConfiguration to this ObjectGridConfiguration.
addConfigProperty(ConfigProperty) - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Add a ConfigProperty to this object.
addEventListener(EventListener) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Adds an EventListener.
addEventListener(ObjectGridEventListener) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Deprecated. This method is deprecated in version 7.1.1, use the ObjectGrid.addEventListener(EventListener) method.
addMapEventListener(EventListener) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Adds an EventListener to this BackingMap.
addMapEventListener(MapEventListener) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Deprecated. This method is deprecated in version 7.1.1, use the BackingMap.addMapEventListener(EventListener) method.
addMapIndexPlugin(MapIndexPlugin) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Adds an MapIndexPlugin to this Map.
addPlugin(Plugin) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Add a Plugin to this BackingMapConfiguration.
addPlugin(Plugin) - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Add a Plugin to this ObjectGridConfiguration.
addQueryMapping(QueryMapping) - Method in class com.ibm.websphere.objectgrid.config.QueryConfig
Add a QueryMapping to this QueryConfig
addQueryRelationship(QueryRelationship) - Method in class com.ibm.websphere.objectgrid.config.QueryConfig
Add a QueryRelationship to this QueryConfig
AgentManagerMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to access different attributes and statistical data about a specific Agent on a server process.
ALL - Static variable in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Constant representing a all shard types
apply(LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
 
apply(LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Maintains a bi-directional queue ordered on last access.
apply(LogSequence) - Method in interface com.ibm.websphere.objectgrid.plugins.Evictor
Called after a transaction has committed to allow the evictor to track object usage in the BackingMap.
associateKeyword(Serializable, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Deprecated. Use Index or query function to get Objects with specific attributes
ASYNCHRONOUS_REPLICA - Static variable in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Constant representing an asynchronous replica shard type.
AUTHORIZATION_MECHANISM_CUSTOM - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant representing custom authorization
AUTHORIZATION_MECHANISM_JAAS - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant representing JAAS authorization
AvailabilityState - Class in com.ibm.websphere.objectgrid
Each shard in a distributed ObjectGrid has an availability state associated with it.

B

BackingMap - Interface in com.ibm.websphere.objectgrid
This is the public interface to the BackingMap.
BackingMapConfiguration - Interface in com.ibm.websphere.objectgrid.config
A BackingMapConfiguration object can be used to override BackingMap settings on the client side.
BAD_CONFIGURATION - Static variable in exception com.ibm.websphere.objectgrid.ConnectException
This failure code indicates the provided configuration was corrupt.
balanceShardTypes(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
The placement service will examine the distribution of primaries and replicas for a given mapSet and attempt (if zone rules and other balancing constraints allow) to achieve a consistent primary to replica ratio across the set of containers.
balanceStatus(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Check the balance status (suspended or resumed) for a specified MapSet.
BeanFactory - Interface in com.ibm.websphere.objectgrid.plugins
Implement this interface to allow bean factories like Spring or Google guice to be integrated.
beforeCommit(TransactionCallback.BeforeCommit.TransactionContext) - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback.BeforeCommit
Invoked at the beginning of a Session.commit().
begin(TxID) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
 
begin(TxID) - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback
Invoked when starting a Session transaction.
begin() - Method in interface com.ibm.websphere.objectgrid.Session
Begins a new transaction.
beginNoWriteThrough() - Method in interface com.ibm.websphere.objectgrid.Session
Starts a new transaction that does not write changes through to a Loader or ObjectGrid server.
BOOLEAN_JAVA_LANG - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.BOOLEAN_JAVA_LANG can be used to set a property of type java.lang.Boolean on a plugin.
BOOLEAN_PRIM - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.BOOLEAN_PRIM can be used to set a property of type boolean on a plugin.
BYTE_JAVA_LANG - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.BYTE_JAVA_LANG can be used to set a property of type java.lang.Byte on a plugin.
BYTE_PRIM - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.BYTE_PRIM can be used to set a property of type byte on a plugin.

C

CacheEntry - Interface in com.ibm.websphere.objectgrid.plugins
This interface represents a cache entry in an ObjectGrid map.
CacheEntryException - Exception in com.ibm.websphere.objectgrid.plugins
This exception indicates an error occurred during a cache entry operation.
CacheEntryException() - Constructor for exception com.ibm.websphere.objectgrid.plugins.CacheEntryException
Constructs a new CacheEntryException with null as its detail message.
CacheEntryException(String) - Constructor for exception com.ibm.websphere.objectgrid.plugins.CacheEntryException
Constructs a new CacheEntryException with the specified detail message.
CacheEntryException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.CacheEntryException
Constructs a new CacheEntryException with the specified detail message and cause.
CacheEntryException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.CacheEntryException
Constructs a new CacheEntryException with a specified cause.
CALLER_SUBJECT - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
A constant representing the caller Subject type
CALLER_SUBJECT_STRING - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
A constant representing the caller Subject type
CannotGenerateCredentialException - Exception in com.ibm.websphere.objectgrid.security.plugins
This exception indicates a credential cannot be generated.
CannotGenerateCredentialException() - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.CannotGenerateCredentialException
Constructs a new CannotGenerateCredentialException with null as its detail message.
CannotGenerateCredentialException(String) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.CannotGenerateCredentialException
Constructs a new CannotGenerateCredentialException with the specified detail message.
CannotGenerateCredentialException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.CannotGenerateCredentialException
Constructs a new CannotGenerateCredentialException with the specified detail message and cause.
CannotGenerateCredentialException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.CannotGenerateCredentialException
Constructs a new CannotGenerateCredentialException with a specified cause.
CannotGetObjectGridSessionException - Exception in com.ibm.websphere.objectgrid.spring
This can be thrown by getSession if a new Session cannot be obtained for any reason.
CannotGetObjectGridSessionException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.spring.CannotGetObjectGridSessionException
Constructs a new CannotGetObjectGridSessionException with the specified detail message and cause.
CannotGetObjectGridSessionException(String) - Constructor for exception com.ibm.websphere.objectgrid.spring.CannotGetObjectGridSessionException
Constructs a new CannotGetObjectGridSessionException with the specified detail message.
CatalogServiceManagementMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows user to manipulate the behaviors of heartbeat and leader manager.
CHAR_PRIM - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.CHAR_PRIM can be used to set a property of type char on a plugin.
CHARACTER_JAVA_LANG - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.CHARACTER_JAVA_LANG can be used to set a property of type java.lang.Character on a plugin.
clear() - Method in interface com.ibm.websphere.objectgrid.JavaMap
Clear all keys from the Map.
clear() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Clear all keys from the Map.
CLEAR - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the CLEAR operation.
clearCopyMode() - Method in interface com.ibm.websphere.objectgrid.JavaMap
Resets the CopyMode back to the one in the BackingMap.
clearCopyMode() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Resets the CopyMode back to the one in the BackingMap.
CLIENT - Static variable in interface com.ibm.websphere.objectgrid.BackingMap
Constant used to indicate this map is a client to a server map
CLIENT - Static variable in interface com.ibm.websphere.objectgrid.ObjectGrid
Indicates the ObjectGrid is a client-side distributed ObjectGrid.
CLIENT_CERTIFICATE_AUTHENTICATION_NEVER - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant indicating client certificate authentication is not supported.
CLIENT_CERTIFICATE_AUTHENTICATION_REQUIRED - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant indicating client certificate authentication is required.
CLIENT_CERTIFICATE_AUTHENTICATION_SUPPORTED - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant indicating client certificate authentication is supported.
CLIENT_PROPS_FILE_PATH_KEY - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
The system property key to override the location of the client properties file.
ClientClusterContext - Interface in com.ibm.websphere.objectgrid
This interface is a context to represent which cluster/domain the client connected to using one of the ObjectGridManager.connect methods.
ClientProperties - Interface in com.ibm.websphere.objectgrid.client
The set of properties used to define various preference for ObjectGrid clients.
CLIENTPROPERTIESFILEPATHKEY - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
Deprecated. The CLIENTPROPERTIESFILEPATHKEY is deprecated in version 7.0. Use the CLIENT_PROPS_FILE_PATH_KEY property.
ClientReplicableMap - Interface in com.ibm.websphere.objectgrid
This interface represents a replicable client map.
ClientReplicableMap.Mode - Class in com.ibm.websphere.objectgrid
Client Replication mode
ClientSecurityConfiguration - Interface in com.ibm.websphere.objectgrid.security.config
This interface represents the client side security configurations.
ClientSecurityConfigurationFactory - Class in com.ibm.websphere.objectgrid.security.config
This class is a factory class for creating ClientSecurityConfiguration and SSLConfiguration objects.
ClientSecurityConfigurationFactory() - Constructor for class com.ibm.websphere.objectgrid.security.config.ClientSecurityConfigurationFactory
 
ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when a method call to the Client/Server TransactionCallback detects the user is attempting to perform a write against multiple maps in different Map Sets, Partition Sets or Replication groups.
ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException() - Constructor for exception com.ibm.websphere.objectgrid.ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException
Constructs a new ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException with null as its detail message.
ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException(String) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException
Constructs a new ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException with the specified detail message.
ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException
Constructs a new ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException with the specified detail message and cause.
ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException
Constructs a new ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException with a specified cause.
close() - Method in interface com.ibm.websphere.objectgrid.Session
Closes this session, freeing all resources that are held.
CODE_CLEAR - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for CLEAR.
CODE_DELETE - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for DELETE.
CODE_EVICT - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for EVICT.
CODE_FETCH - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for FETCH.
CODE_INSERT - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for INSERT.
CODE_TOUCH - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for TOUCH.
CODE_UNDO_BEFORE_IMAGE_KEYWORDS - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The code constant for UNDO_BEFORE_IMAGE_KEYWORDS.
CODE_UNDO_NOT_NEEDED - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The code constant for UNDO_NOT_NEEDED.
CODE_UPDATE - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for UPDATE.
collectContainerStatus(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Retrieves the container status for all containers in the domain.
COLLISION_ARBITER - Static variable in interface com.ibm.websphere.objectgrid.config.PluginType
PluginType.COLLISION_ARBITER can be used to attach a CollisionArbiter plugin to an ObjectGrid.
com.ibm.websphere.objectgrid - package com.ibm.websphere.objectgrid
These are the main application APIs for the ObjectGrid.
com.ibm.websphere.objectgrid.client - package com.ibm.websphere.objectgrid.client
This package contains the primary interfaces and classes for setting behaviors for ObjectGrid clients for this process.
com.ibm.websphere.objectgrid.config - package com.ibm.websphere.objectgrid.config
This package contains the interfaces and a factory class for creating ObjectGrid configuration objects programatically.
com.ibm.websphere.objectgrid.management - package com.ibm.websphere.objectgrid.management
This package contains the interfaces for all ObjectGrid MBeans.
com.ibm.websphere.objectgrid.plugins - package com.ibm.websphere.objectgrid.plugins
These are the interfaces for adding plugins to the Grid core framework.
com.ibm.websphere.objectgrid.plugins.builtins - package com.ibm.websphere.objectgrid.plugins.builtins
This package contains built-in plugins for ObjectGrid core.
com.ibm.websphere.objectgrid.security - package com.ibm.websphere.objectgrid.security
This package has the class MapPermission and class AdminPermission which represents the permissions for to access the ObjectGrid maps and ObjectGrid administration respectively.
com.ibm.websphere.objectgrid.security.config - package com.ibm.websphere.objectgrid.security.config
This package contains the ObjectGrid client security configurations.
com.ibm.websphere.objectgrid.security.plugins - package com.ibm.websphere.objectgrid.security.plugins
This package contains the interfaces for adding plug-ins to the ObjectGrid security framework and assoicated Exception classes.
com.ibm.websphere.objectgrid.security.plugins.builtins - package com.ibm.websphere.objectgrid.security.plugins.builtins
This package contains the built-in implementation for the security plugins.
com.ibm.websphere.objectgrid.spring - package com.ibm.websphere.objectgrid.spring
This package holds the Spring specific APIs for ObjectGrid.
commit(TxID) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
 
commit(TxID) - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback
Invoked when committing a Session transaction.
commit() - Method in interface com.ibm.websphere.objectgrid.Session
Commits a transaction.
compareTo(Object) - Method in class com.ibm.websphere.objectgrid.plugins.LogElement.Type
 
ConfigProperty - Interface in com.ibm.websphere.objectgrid.config
ConfigProperty can be used to attach properties to a Plugin.
ConfigPropertyType - Class in com.ibm.websphere.objectgrid.config
ConfigPropertyType is used to set the type of an attribute on a Plugin.
connect(ClientSecurityConfiguration, URL) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Use this method to connect to an embedded ObjectGrid server.
connect(String, ClientSecurityConfiguration, URL) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Connects a client process to a remote ObjectGrid catalog server or catalog server cluster (a dynamic ObjectGrid deployment topology).
connect(URL, String, ClientSecurityConfiguration, URL) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Deprecated. The static deployment topology is deprecated in version 7.0. Use the dynamic deployment topology.
connect(String, HostPortConnectionAttributes[], ClientSecurityConfiguration, URL) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Deprecated. The static deployment topology is deprecated in version 7.0. Use the dynamic deployment topology.
connect(String, String, String, ClientSecurityConfiguration, URL) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Deprecated. The static deployment topology is deprecated in version 7.0. Use the dynamic deployment topology.
ConnectException - Exception in com.ibm.websphere.objectgrid
This exception is used to indicate that the client was unable to connect to the server
ConnectException() - Constructor for exception com.ibm.websphere.objectgrid.ConnectException
Constructs a new ConnectException with null as its detail message.
ConnectException(String) - Constructor for exception com.ibm.websphere.objectgrid.ConnectException
Constructs a new ConnectException with the specified detail message.
ConnectException(String, int) - Constructor for exception com.ibm.websphere.objectgrid.ConnectException
Constructs a new ConnectException with the specified detail message.
ConnectException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ConnectException
Constructs a new ConnectException with a specified cause.
ConnectException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ConnectException
Constructs a new ConnectException with the specified detail message and cause.
ConnectException(String, Throwable, int) - Constructor for exception com.ibm.websphere.objectgrid.ConnectException
Constructs a new ConnectException with the specified detail message and cause.
CONNECTION_REFUSED - Static variable in exception com.ibm.websphere.objectgrid.ConnectException
This failure code indicates that the server may not be available.
ContainerMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to perform operations on and get status from an ObjectGrid container running in a dynamic environment.
containsKey(Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Returns true if this map contains a mapping for the specified key.
containsKey(Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Returns true if this map contains a mapping for the specified key.
containsValue(Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.
CONTINUOUS_REPLICATION - Static variable in interface com.ibm.websphere.objectgrid.ClientReplicableMap
Full replication mode.
COPY_ON_READ - Static variable in class com.ibm.websphere.objectgrid.CopyMode
The COPY_ON_READ mode improves performance over the COPY_ON_READ_AND_COMMIT mode by eliminating the copy that occurs when a transaction is committed.
COPY_ON_READ_AND_COMMIT - Static variable in class com.ibm.websphere.objectgrid.CopyMode
The COPY_ON_READ_AND_COMMIT mode is the default mode.
COPY_ON_WRITE - Static variable in class com.ibm.websphere.objectgrid.CopyMode
The COPY_ON_WRITE mode improves performance over the COPY_ON_READ_AND_COMMIT mode by eliminating the copy that occurs when ObjectMap.get is called for the first time by a transaction for a given key.
COPY_TO_BYTES - Static variable in class com.ibm.websphere.objectgrid.CopyMode
The COPY_TO_BYTES mode is similar to the COPY_ON_READ_AND_COMMIT mode in that it ensures that an application never has a reference to the value object that is in the BackingMap.
COPY_TO_BYTES_RAW - Static variable in class com.ibm.websphere.objectgrid.CopyMode
When set, all ObjectMap APIs that return a SerializedValue rather than the original Java Object, allowing access to the serialized form of the data, preventing inflation of object into Java Object form.
CopyMode - Class in com.ibm.websphere.objectgrid
This class is used to define the "copy" mode when the setCopyMode method of the BackingMap interface is used.
COREGROUP_MEMBERSHIP_CHANGE - Static variable in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Constant representing a core group membership change notification.
createBackingMapConfiguration(String) - Static method in class com.ibm.websphere.objectgrid.config.ObjectGridConfigFactory
Create a BackingMapConfiguration object
createConfigProperty(ConfigPropertyType, String, String) - Static method in class com.ibm.websphere.objectgrid.config.ObjectGridConfigFactory
Create a ConfigPropety object for use on a Plugin.
createDynamicIndex(String, boolean, String, DynamicIndexCallback) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Creates a dynamic index on the BackingMap.
createDynamicIndex(MapIndexPlugin, DynamicIndexCallback) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Creates a dynamic index on the BackingMap.
createMap(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Creates a BackingMap, but does not associate it with this ObjectGrid.
createObjectGrid() - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Creates a local, in-memory instance of an ObjectGrid.
createObjectGrid(String, boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Creates a local, in-memory instance of an ObjectGrid with the specified name.
createObjectGrid(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Creates and caches a local, in-memory ObjectGrid instance with the specified name.
createObjectGrid(String, URL, boolean, boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Creates a local, in-memory ObjectGrid instance based on the specified ObjectGrid name and the ObjectGrid XML configuration file.
createObjectGrid(String, URL) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Creates a local, in-memory ObjectGrid instance based on the specified ObjectGrid name and the ObjectGrid XML configuration file.
createObjectGridConfiguration(String) - Static method in class com.ibm.websphere.objectgrid.config.ObjectGridConfigFactory
Create an ObjectGridConfiguration object.
createObjectGrids(URL, boolean, boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Creates a List of a local, in-memory ObjectGrid instances based upon the ObjectGrid configurations in the specified ObjectGrid descriptor XML file.
createObjectGrids(URL) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Creates a List of a local, in-memory ObjectGrid instances based upon the ObjectGrid configurations in the specified ObjectGrid descriptor XML file.
createObjectQuery(String) - Method in interface com.ibm.websphere.objectgrid.Session
Creates an instance of an object query for executing a query over the ObjectMaps visible to this session.
createOSGiServicePlugin(PluginType, String) - Static method in class com.ibm.websphere.objectgrid.config.ObjectGridConfigFactory
Create an OSGi Service Plugin for a BackingMapConfiguration or an ObjectGridConfiguration
createPlugin(PluginType, String) - Static method in class com.ibm.websphere.objectgrid.config.ObjectGridConfigFactory
Create a Plugin for a BackingMapConfiguration or an ObjectGridConfiguration
CREATION_TIME - Static variable in class com.ibm.websphere.objectgrid.TTLType
A TTLType.CREATION_TIME indicates an entry expiration time is the sum of the creation time of the entry plus the "time to live" value.
Credential - Interface in com.ibm.websphere.objectgrid.security.plugins
This interface represents a credential used by an ObjectGrid client.
CREDENTIAL_AUTHENTICATION_NEVER - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant indicating credential authentication is not supported.
CREDENTIAL_AUTHENTICATION_REQUIRED - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant indicating credential authentication is required.
CREDENTIAL_AUTHENTICATION_SUPPORTED - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant indicating credential authentication is supported.
CredentialGenerator - Interface in com.ibm.websphere.objectgrid.security.plugins
This plugin is used to get a Credential representing this client.

D

deactivate() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
 
deactivate() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
 
deactivate() - Method in interface com.ibm.websphere.objectgrid.plugins.Evictor
This method is called to deactivate the Evictor.
DEFAULT_LOCK_TIMEOUT - Static variable in interface com.ibm.websphere.objectgrid.BackingMap
Default lock timeout used if setLockTimeout(int) is not invoked.
DEFAULT_NUMBER_OF_BUCKETS - Static variable in interface com.ibm.websphere.objectgrid.BackingMap
Default number of lock buckets used if setNumberOfBuckets(int) is not invoked.
DEFAULT_NUMBER_OF_HEAPS - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Default number of binary heaps to create if the setNumberOfHeaps(int) method is not called.
DEFAULT_NUMBER_OF_LOCK_BUCKETS - Static variable in interface com.ibm.websphere.objectgrid.BackingMap
Default number of lock buckets used if setNumberOfLockBuckets(int) is not invoked.
DEFAULT_NUMBER_OF_QUEUES - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Default number of LRU queues to create if the setNumberOfLRUQueues(int) method is not called.
DEFAULT_SLEEP_TIME - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Default sleep time for evictor thread if the setSleepTime(int) method is not called.
DEFAULT_SLEEP_TIME - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Default sleep time for evictor thread if the setSleepTime(int) method is not called.
DEFAULT_TX_TIMEOUT_VALUE - Static variable in interface com.ibm.websphere.objectgrid.ObjectGrid
The default transaction time out value of 10 minutes if no transaction time out value is set.
DEFAULTCLIENTPROPERTYFILE - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
The default name of client property file
defineMap(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Defines a BackingMap that will be used by the application.
DELETE - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the DELETE operation.
destroy() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Destroys this instance.
destroy() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
 
destroy() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
 
destroy() - Method in interface com.ibm.websphere.objectgrid.plugins.Evictor
Called when the BackingMap associated with this evictor is destroyed.
destroy() - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventGroup.ShardLifecycle
Called when the ObjectGrid associated with this listener is destroyed.
destroy() - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventListener
Called when the ObjectGrid associated with this listener is destroyed.
disableClientReplication() - Method in interface com.ibm.websphere.objectgrid.ClientReplicableMap
Disables the replication for this client.
disconnect(ClientClusterContext) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Disconnects a client process from an ObjectGrid server
dismissLink(String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementMediationServiceMBean
Dismiss a previously established link with the foreign domain specified.
DOUBLE_JAVA_LANG - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.DOUBLE_JAVA_LANG can be used to set a property of type java.lang.Double on a plugin.
DOUBLE_PRIM - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.DOUBLE_PRIM can be used to set a property of type double on a plugin.
DuplicateKeyException - Exception in com.ibm.websphere.objectgrid
A DuplicateKeyException exception is thrown if a key cannot be inserted into a BackingMap because an object with the same key already exists.
DuplicateKeyException() - Constructor for exception com.ibm.websphere.objectgrid.DuplicateKeyException
Constructs a new DuplicateKeyException with null as its detail message.
DuplicateKeyException(String) - Constructor for exception com.ibm.websphere.objectgrid.DuplicateKeyException
Constructs a new DuplicateKeyException with the specified detail message.
DuplicateKeyException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.DuplicateKeyException
Constructs a new DuplicateKeyException with the specified detail message and cause.
DuplicateKeyException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.DuplicateKeyException
Constructs a new DuplicateKeyException with a specified cause.
DynamicServerMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to access different attributes about a specific server process in a dynamic environment.

E

enableClientReplication(ClientReplicableMap.Mode, int[], ReplicationMapListener) - Method in interface com.ibm.websphere.objectgrid.ClientReplicableMap
Make the client map a replica of the server side map.
entryEvicted(Object, Object) - Method in interface com.ibm.websphere.objectgrid.plugins.MapEventListener
Invoked when the specified entry is evicted from the map.
entrySet() - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.
equals(Object) - Method in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
 
equals(Object) - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
 
equals(Object) - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
 
equals(SSLConfiguration) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Checks two SSLConfiguration objects for equality.
equals(Object) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
Checks two UserPasswordCredential objects for equality.
equals(Object) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
Checks two UserPasswordCredentialGenerator objects for equality.
equals(Object) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredential
Checks two WSTokenCredential objects for equality.
equals(Object) - Method in interface com.ibm.websphere.objectgrid.security.plugins.Credential
Checks two Credential objects for equality.
equals(TxID) - Method in interface com.ibm.websphere.objectgrid.TxID
Checks for equality between two TxID objects.
establishLink(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementMediationServiceMBean
Establish a link between this domain and the foreign domain specified.
EVICT - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the EVICT operation.
evictEntries(List) - Method in interface com.ibm.websphere.objectgrid.plugins.EvictionEventCallback
If an Evictor chooses not to implement the EvictorData interface, this method can be used to evict a map entry.
EvictionEventCallback - Interface in com.ibm.websphere.objectgrid.plugins
An instance of EvictionEventCallback is passed into the Evictor at initialization time.
EVICTIONTRIGGER_MEMORY_USAGE_THRESHOLD - Static variable in interface com.ibm.websphere.objectgrid.BackingMap
The eviction trigger string constant to enable memory based eviction using memory usage threshold provided by the java.lang.management.MemoryPoolMXBean.
evictMapEntries(List) - Method in interface com.ibm.websphere.objectgrid.plugins.EvictionEventCallback
This method is the preferred method for the Evictor to use when evicting map entries.
EVICTOR - Static variable in interface com.ibm.websphere.objectgrid.config.PluginType
PluginType.EVICTOR can be used to attach an Evictor to a BackingMap.
Evictor - Interface in com.ibm.websphere.objectgrid.plugins
Data contained in a BackingMap are evicted when the map is full.
EvictorData - Interface in com.ibm.websphere.objectgrid.plugins
This interface is optionally used by an implementator of the Evictor interface.
EvictorData.SpecialEvictorData - Class in com.ibm.websphere.objectgrid.plugins
Special value class used for representing the key not being found in the BackingMap.
EvictorData.SpecialEvictorData() - Constructor for class com.ibm.websphere.objectgrid.plugins.EvictorData.SpecialEvictorData
 
ExpiredCredentialException - Exception in com.ibm.websphere.objectgrid.security.plugins
This exception indicates that the credential used for authentication is expired.
ExpiredCredentialException() - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.ExpiredCredentialException
Constructs a new ExpiredCredentialException with null as its detail message.
ExpiredCredentialException(String) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.ExpiredCredentialException
Constructs a new ExpiredCredentialException with the specified detail message.
ExpiredCredentialException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.ExpiredCredentialException
Constructs a new ExpiredCredentialException with the specified detail message and cause.
ExpiredCredentialException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.ExpiredCredentialException
Constructs a new ExpiredCredentialException with a specified cause.

F

FAILED_SECURITY - Static variable in exception com.ibm.websphere.objectgrid.ConnectException
This failure code indicates the a failure to authenticate.
FETCH - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the FETCH operation.
FIELD_ACCESS - Static variable in class com.ibm.websphere.objectgrid.config.QueryMapping
This constant indicates to use direct field access to read the field values
FLOAT_JAVA_LANG - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.FLOAT_JAVA_LANG can be used to set a property of type java.lang.Float on a plugin.
FLOAT_PRIM - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.FLOAT_PRIM can be used to set a property of type float on a plugin.
flush() - Method in interface com.ibm.websphere.objectgrid.JavaMap
Pushes the current set of changes for the JavaMap instance to the Loader without committing the changes.
flush() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Pushes the current set of changes for the ObjectMap instance to the Loader without committing the changes.
flush() - Method in interface com.ibm.websphere.objectgrid.Session
Forces the current changes in the Session to the Loader or ObjectGrid server.

G

get(Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
get(Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Retrieves the object from the cache at the given key.
get(Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Retrieves the object from the cache at the given key.
get(Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
getAccessedSessionsCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets acessed sessions count
getAccessToNonExistentSessionCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets access to non-existent session count
getAccessType() - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Retrieve the method in which the query engine will access the value class object stored in the BackingMap.
getActivatedShardCount() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Retrieve the total number of shards that have been activated for the life of this ObjectGrid container.
getActiveCatalogServerNames() - Method in interface com.ibm.websphere.objectgrid.management.QuorumManagerMBean
Retrieves the names of the known active catalog service processes.
getActiveCatalogServers() - Method in interface com.ibm.websphere.objectgrid.management.QuorumManagerMBean
Retrieve the known number of active catalog service processes.
getActiveRequestCount() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieves the number of requests currently being processed by this shard.
getActiveSessionsCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets active sessions count
getActiveShardCount() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Retrieve the number of active shards hosted in this ObjectGrid container.
getActiveThreadCount() - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Retrieves the approximate number of active threads in the pool.
getAffinityBreaksCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets affinity breaks count
getAfterImage() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Gets the "after image" value object.
getAgentInflationTime(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the specified agent's inflation time attribute loaded up by the retrieveStatsModule() method.
getAgentManager() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Returns the Agent Manager that allows DataGrid operations to be performed on the objects within this Map.
getAgentSerializationTime(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the specified agent's serialization time attribute loaded up by the retrieveStatsModule() method.
getAlias() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the SSL alias name for this SSL configuration.
getAll(List) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Gets a list of entries from the map.
getAll(List, Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
getAll(List) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Gets a list of entries from the map.
getAll(List, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
getAllChanges() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns an iterator for processing all of the changes for a LogSequence.
getAllForUpdate(List) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Same as the getAll(List) method except that if pessimistic lock strategy is used for this map, an upgradable lock mode is obtained for these map entries.
getAllForUpdate(List, Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
getAllForUpdate(List) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Same as the getAll(List) method except that if pessimistic lock strategy is used for this map, an upgradable lock mode is obtained for these map entries.
getAllForUpdate(List, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
getAT() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredential
Gets the authetication token for this credential.
getAuthenticationRetryCount() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the authentication retry count for this client security configuration.
getAvailableProcessors() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns the number of available processors for the JVM hosting this server.
getBackingMapConfigurations() - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Get the List of BackingMapConfiguration objects that are attached to this ObjectGridConfiguration object
getBatchUpdateCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's batchupdate count attribute loaded up by the retrieveStatsModule() method.
getBean(String) - Method in interface com.ibm.websphere.objectgrid.plugins.BeanFactory
This returns an instance of the bean with the specified name.
getBeanFactoryForObjectGrid(String) - Static method in class com.ibm.websphere.objectgrid.spring.ObjectGridSpringFactory
This returns the currently registered external bean factory for a named object grid.
getBeanInShardScope(ObjectGrid, String) - Static method in class com.ibm.websphere.objectgrid.spring.ObjectGridSpringFactory
This returns an instance of the named Spring bean with the current shard scope using the specified ObjectGrid instance.
getBeforeImage() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Gets the "before image" of the value object.
getCacheDiscardsCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets cache discards count
getCacheEntry() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Returns the CacheEntry for this key.
getCause() - Method in interface com.ibm.websphere.objectgrid.IObjectGridException
Provides JDK 1.4 Throwable.getCause() behavior.
getCause() - Method in exception com.ibm.websphere.objectgrid.ObjectGridException
Returns the cause of this ObjectGridException or null if the cause is nonexistent or unknown.
getCause() - Method in exception com.ibm.websphere.objectgrid.ObjectGridRuntimeException
Returns the cause of this ObjectGridRuntimeException or null if the cause is nonexistent or unknown.
getCertReqSubjectDN() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the required subject DN in the peer certificate for this SSL configuration.
getChangesByKeys(Collection) - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns an iterator for processing the LogElements that have the requested keys.
getChangesByTypes(Collection) - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns an iterator for processing the LogElements that are of the requested type.
getClassName() - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Get the String representation of the class name of this Plugin
getClientCertificateAuthentication() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the client certificate authentication type for this client security configuration.
getClientProperties(String) - Method in interface com.ibm.websphere.objectgrid.ClientClusterContext
Retrieve the ClientProperties object for this ClientClusterContext for the specified ObjectGrid name.
getClientSecurityConfiguration() - Static method in class com.ibm.websphere.objectgrid.security.config.ClientSecurityConfigurationFactory
Creates a new client security configuration with all its attributes set to their default values.
getClientSecurityConfiguration(String) - Static method in class com.ibm.websphere.objectgrid.security.config.ClientSecurityConfigurationFactory
Creates a new client security configuration based on a client security property file.
getClientSecurityConfiguration(Properties) - Static method in class com.ibm.websphere.objectgrid.security.config.ClientSecurityConfigurationFactory
Creates a new client security configuration based on a Properties object.
getClusterName() - Method in interface com.ibm.websphere.objectgrid.ClientClusterContext
Gets the name of the cluster or domain to which the client is connected
getCode() - Method in class com.ibm.websphere.objectgrid.plugins.LogElement.Type
Gets the type code for this object.
getCollisionArbiter() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Retrieves the CollisionArbiter that this grid is using to resolve revision collisions.
getCommittedValue() - Method in interface com.ibm.websphere.objectgrid.plugins.CacheEntry
Returns the committed value for this entry.
getConfigProperties() - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Get the ConfigProperty objects that have been set on this object.
getConfigPropertyType() - Method in interface com.ibm.websphere.objectgrid.config.ConfigProperty
Get the ConfigPropertyType of this object.
getContainerName() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Retrieve the name of the container.
getContainerName() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieves the name of the container that is hosting this shard.
getContextProvider() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the JSSE context provider for this SSL configuration.
getCopyKey() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets whether keys are copied for this BackingMap.
getCopyMode() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the CopyMode being used by this BackingMap.
getCoreGroups() - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Gets the coregroup status.
getCreatedSessionsCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets the map count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getCredential() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
Creates a new UserPasswordCredential object using this object's user name and password.
getCredential() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
Creates a new WSTokenCredential object using this object's using the security information from the Subject associated with the current thread.
getCredential() - Method in interface com.ibm.websphere.objectgrid.security.plugins.CredentialGenerator
Gets a Credential which represents the client.
getCredentialAuthenticationType() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the credential authentication type for this client security configuration.
getCredentialGenerator() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the CredentialGenerator object for this client security configuration.
getCredentialGeneratorClass() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the CredentialGenerator implementation class name set in the client security property file.
getCredentialGeneratorProps() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the CredentialGenerator properties set in the client security property file.
getCurrentRevision() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Retrieves the current revision number of this ObjectGrid shard.
getCurrentValue() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Gets the value for this LogElement.
getDeactivatedShardCount() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Retrieve the total number of shards that have been deactivated for the life of this ObjectGrid container.
getDomainName() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Retrieve the name of the catalog server grouping administering this container.
getDomainName() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Retrieves the domain name of this ObjectGrid shard.
getDomainName() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieve the name of the catalog server grouping administering this shard.
getEntityManager() - Method in interface com.ibm.websphere.objectgrid.Session
Retrieve the EntityManager associated with this Session.
getEntityMetadata() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Retreive the metadata for the entity associated with this backing map.
getEntityMetadata() - Method in interface com.ibm.websphere.objectgrid.JavaMap
Retrieve the metadata for the entity associated with this map.
getEntityMetadata() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Retrieve the metadata for the entity associated with this map.
getEventListeners() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Returns the current list of EventListeners.
getEvictionTriggers() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Returns the types of additional eviction triggers.
getEvictionTriggers() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Gets the list of eviction triggers for this BackingMapConfiguration.
getEvictor() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the Evictor being used by this BackingMap.
getEvictorData(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.EvictionEventCallback
Gets the evictor data for a specified BackingMap cache entry.
getFailureCode() - Method in exception com.ibm.websphere.objectgrid.ConnectException
Returns the failure code that was set by one of the constructors that accepts a failure code, or UNKNOWN if one of the other constructors was called.
getFailureCount(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the specified agent's failure count attribute loaded up by the retrieveStatsModule() method.
getFindCollisionCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's collision count attribute loaded up by the retrieveStatsModule() method.
getFindCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's find count attribute loaded up by the retrieveStatsModule() method.
getFindDurationTime() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's find duration time attribute loaded up by the retrieveStatsModule() method.
getFindFailureCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's failure count attribute loaded up by the retrieveStatsModule() method.
getFindResultCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's result count attribute loaded up by the retrieveStatsModule() method.
getForUpdate(Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Same as get(Object) method except that if pessimistic lock strategy is used for this map, an upgradable lock mode is obtained for this map entry.
getForUpdate(Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
getForUpdate(Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Same as get(Object) method except that if pessimistic lock strategy is used for this map, an upgradable lock mode is obtained for this map entry.
getForUpdate(Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
getForwardedRequestCount() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieves the number of requests that this shard has forwarded since its inception.
getFreeMemory() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns the available memory in bytes for the JVM hosting this server.
getHeartBeatFrequencyLevel() - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Retrieves the heartbeat frequency level.
getHostName() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns the host name for this process.
getId() - Method in class com.ibm.websphere.objectgrid.AvailabilityState
Returns the internal identifier for this state.
getIndex(String) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Returns a reference to the named index that can be used with this Map.
getIndex(String) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Returns a reference to the named index that can be used with this Map.
getIndex(String, boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Returns a reference to the named index that can be used with this Map.
getInvalidatedByTimeoutCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets invalidated by timeout count
getInvalidatedSessionsCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets invalidated sessions count
getInvocationCount(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the specified agent's invocation count attribute loaded up by the retrieveStatsModule() method.
getInvRelationshipField() - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Retrieve the inverse relationship attribute name of a bi-directional relationship.
getJavaMap() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Returns an implementation of java.util.Map that is backed by this ObjectMap.
getKey() - Method in interface com.ibm.websphere.objectgrid.plugins.CacheEntry
Returns the key for this entry.
getKey() - Method in interface com.ibm.websphere.objectgrid.plugins.EvictorData
Retrieves the key object for this EvictorData instance.
getKey() - Method in class com.ibm.websphere.objectgrid.plugins.EvictorData.SpecialEvictorData
Dummy implementation method since this class will not be called.
getKey() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Returns the key for this LogElement.
getKeyStore() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the key store file path name for this SSL configuration.
getKeyStorePassword() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the password of the key store for this SSL configuration.
getKeyStoreType() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the type of the key store for this SSL configuration.
getKeywords() - Method in interface com.ibm.websphere.objectgrid.plugins.CacheEntry
Returns the list of keywords associated with this entry.
getKnownRevisions() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
An ObjectGrid shard may exist over several different lifetimes.
getLastAccessTime() - Method in interface com.ibm.websphere.objectgrid.plugins.CacheEntry
Returns the last time this entry was accessed.
getLastAccessTime() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Returns the last access time associated with this LogElement.
getLifetimeId() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Retrieves the lifetime id for this ObjectGrid shard.
getLinkedDomains() - Method in interface com.ibm.websphere.objectgrid.management.PlacementMediationServiceMBean
Retrieve the foreign domains that have an active link with the local domain.
getListenerHost() - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Retrieves the host to be used by the ORB.
getListenerPort() - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Retrieves the port to be used by the ORB.
getListOfMapNames() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Gets the list of map names currently defined for this ObjectGrid instance.
getLoader() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the Loader being used by this BackingMap.
getLocalPlatformTransactionManager() - Static method in class com.ibm.websphere.objectgrid.spring.ObjectGridSpringFactory
This returns an ObjectGrid PlatformLocalTransactionManager.
getLockRequestQueueDetails() - Method in exception com.ibm.websphere.objectgrid.LockTimeoutException
Provides detailed information about the state of the lock queue when the lock timeout occurred.
getLockStrategy() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the LockStrategy object being used by this BackingMap.
getLockTimeout() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the lock timeout value used by the lock manager for this BackingMap.
getLogSequences() - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback.BeforeCommit.TransactionContext
The LogSequences that reflect the pending changes to the map.
getMap(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Returns a BackingMap previously configured by calling the defineMap(String) or setMaps(List) method.
getMap(String) - Method in interface com.ibm.websphere.objectgrid.Session
Returns the ObjectMap for the specified name.
getMapBatchUpdateMaxTime() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the maximum batch update time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMapBatchUpdateMeanTime() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the mean batch update time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMapBatchUpdateMinTime() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the minimum batch update time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMapBatchUpdateTotalTime() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the total batch update time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMapCountStatistic() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the map count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMapEventListeners() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the current list of EventListeners.
getMapGetCountStatistic() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the get count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMapHitCountStatistic() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the hit count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMapHitRateStatistic() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the hit rate attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMapIndexPlugins() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Returns the current list of MapIndexPlugin objects for this BackingMap.
getMapName() - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Retrieve the BackingMap name associated with this mapping.
getMapName() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the name of the map associated with this MBean.
getMapName() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns the name of the map that these changes apply to.
getMapSetName() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Retrieves the name of the MapSet that this BackingMap is currently associated with.
getMapSetName() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieve the name of the MapSet in which the shard resides.
getMapStatsModule() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets a string representation of the MapStatsModule attributes loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMapType() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Returns the type of BackingMap.
getMapType() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Returns the type of the underlying BackingMap.
getMapUsedBytes() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the used bytes attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getMaximumSize() - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Retrieves the maximum number of threads in the pool.
getMaxMemory() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns the maximum memory in bytes for the JVM hosting this server.
getMaxSize() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Gets the maximum size of each binary heap.
getMaxSize() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Gets the maximum size of each LRU queue.
getMemoryCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets memory count
getMessage() - Method in exception com.ibm.websphere.objectgrid.LockTimeoutException
Returns the detail message string of this exception.
getMinimumSize() - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Retrieves the minimum number of threads in the pool.
getName() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the name of the BackingMap.
getName() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Get the name of this BackingMapConfiguration
getName() - Method in interface com.ibm.websphere.objectgrid.config.ConfigProperty
Get the name of this object.
getName() - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Get the name of this ObjectGridConfiguration
getName() - Method in interface com.ibm.websphere.objectgrid.JavaMap
Returns the name of the JavaMap as defined by the configuration.
getName() - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Retrieves the name of the ThreadPool.
getName() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Gets the name of this ObjectGrid.
getName() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Returns the name of the ObjectMap as defined by the configuration.
getNewKeywords() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Returns any new keywords that have been associated with this entry as a result of this transaction.
getNextKey(long) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Retrieves a key off the map in first-in-first-out (FIFO) insert order.
getNextKey(long) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Retrieves a key off the map in first-in-first-out (FIFO) insert order.
getNullValuesSupported() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets whether this BackingMap supports null values or not.
getNumberOfBuckets() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the number of buckets defined for this BackingMap.
getNumberOfBuckets() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Gets the number of buckets defined for this BackingMapConfiguration.
getNumberOfHeaps() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Gets number of binary heaps being used.
getNumberOfLockBuckets() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the number of lock buckets defined for the hash map used by lock manager for this backing map.
getNumberOfLRUQueues() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Gets number of LRU queues being used.
getNumberOfServers() - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Retrieves the number eXtreme Scale servers that are currently registered with the catalog service.
getNumOfPartitions() - Method in interface com.ibm.websphere.objectgrid.PartitionManager
Returns the number of configured partitions for this PartitionManager.
getOAT() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredential
Gets the opaque authorization token for this credential.
getObjectGrid() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the ObjectGrid that owns this BackingMap.
getObjectGrid(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Returns a cached local, in-memory ObjectGrid instance by name.
getObjectGrid(ClientClusterContext, String) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Returns a client ObjectGrid instance corresponding to an ObjectGrid in an ObjectGrid cluster.
getObjectGrid(ClientClusterContext, String, ObjectGridConfiguration) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Returns a client ObjectGrid instance corresponding to an ObjectGrid in an ObjectGrid cluster.
getObjectGrid() - Method in interface com.ibm.websphere.objectgrid.Session
Returns the ObjectGrid that owns this session.
getObjectGridAdministrator(ClientClusterContext) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Deprecated. The static deployment topology is deprecated in version 7.0. Use the dynamic deployment topology.
getObjectGridManager() - Static method in class com.ibm.websphere.objectgrid.ObjectGridManagerFactory
Returns the ObjectGridManager singleton.
getObjectGridName() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the name of the ObjectGrid containing the map associated with this MBean.
getObjectGridName() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets the name of the ObjectGrid associated with this MBean.
getObjectGridName() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieve the name of the ObjectGrid in which the shard resides.
getObjectGridName() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns the name of the ObjectGrid that houses the map that these changes apply to.
getObjectGridNames() - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Gets the names of all ObjectGrids and their mapsets in the domain.
getObjectGrids() - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Gets a List of the local, in-memory ObjectGrid instances that have been previously cached.
getObjectGridState(ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.StateManager
Get the AvailabilityState of an ObjectGrid.
getObjectGridType() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Returns the type of ObjectGrid.
getObjectTransformer() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the ObjectTransformer object being used by this BackingMap and/or Loader.
getOGCount() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets the ObjectGrid count attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getOGMaxTranTime() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets the maximum transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getOGMeanTranTime() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets the mean transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getOGMinTranTime() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets the minimum transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getOGStatsModule() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets a string representation of the OGStatsModule attributes loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getOGTotalTranTime() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets the total transaction time attribute loaded up by the retrieveStatsModule() or refreshStatsModule() method.
getOGTransPerSecond() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Transactions per second attribute loaded up by the retrieveStatsModule call.
getOptimisticCallback() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the OptimisticCallback being used by this BackingMap and/or Loader or null if the LockStrategy is not optimistic.
getOSGiService() - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Get the OSGi service name configured for this Plugin.
getOverrideObjectGridConfigurations() - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Deprecated. This method is replaced in 7.1.1 with the getObjectGrid method that takes a ObjectGridConfigurations.
getParentMapName() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's parent map name
getPartition(Object) - Method in interface com.ibm.websphere.objectgrid.PartitionManager
Obtains a 0-based partition number determined by the input parameter's hashCode() method.
getPartitionCount(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the specified agent's partition count attribute loaded up by the retrieveStatsModule() method.
getPartitionId() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the partition identifier being used by this BackingMap.
getPartitionId() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Retrieves the partition identifier for this map instance.
getPartitionLists(List) - Method in interface com.ibm.websphere.objectgrid.PartitionManager
This method is very similar to getPartitions(List), except it returns the keys organized by the partition identifiers.
getPartitionManager() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Allows access to the PartitionManager that is defined for this BackingMap.
getPartitionName() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retreive the name of the partition in which the shard resides.
getPartitions(List) - Method in interface com.ibm.websphere.objectgrid.PartitionManager
Obtains the 0-based partition numbers for each of the keys in the input List of keys.
getPassword() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
Gets the password for this credential.
getPassword() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
Gets the password for this credential generator.
getPendingChanges() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns an iterator for processing all of the "pending" changes for a LogSequence (for example, pending inserts, updates, and deletes).
getPlanCreationTime(String) - Method in interface com.ibm.websphere.objectgrid.management.QueryManagerMBean
Gets the query's plan creation time attribute loaded up by the retrieveStatsModule() method.
getPlugins() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Get the Plugins that have been attached to this BackingMapConfiguration.
getPlugins() - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Get the Plugins that have been attached to this ObjectGridConfiguration.
getPluginType() - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Get the PluginType for this Plugin.
getPreferZones() - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Retrieve the preferred zones.
getPreLoadMode() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Returns whether this BackingMap will be asynchronously preloaded or not if a Loader is set.
getPrimaryKeyField() - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Retrieve the name of the attribute in the value class object that is also the primary key of the BackingMap.
getPrimaryShardLinks() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Get the shard's list of foreign or domestic linked primaries.
getProcessedRequestCount() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieves the number of requests that this shard has processed since its inception.
getProtocol() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the SSL protocol for this SSL configuration.
getQueryExecutionCount(String) - Method in interface com.ibm.websphere.objectgrid.management.QueryManagerMBean
Gets the query's execution count attribute loaded up by the retrieveStatsModule() method.
getQueryExecutionTime(String) - Method in interface com.ibm.websphere.objectgrid.management.QueryManagerMBean
Gets the query's execution time attribute loaded up by the retrieveStatsModule() method.
getQueryFailureCount(String) - Method in interface com.ibm.websphere.objectgrid.management.QueryManagerMBean
Gets the query's failure count attribute loaded up by the retrieveStatsModule() method.
getQueryMappings() - Method in class com.ibm.websphere.objectgrid.config.QueryConfig
Retrieve all added QueryMappings
getQueryRelationships() - Method in class com.ibm.websphere.objectgrid.config.QueryConfig
Retrieve all added QueryRelationships
getQueryResultCount(String) - Method in interface com.ibm.websphere.objectgrid.management.QueryManagerMBean
Gets the query's result count attribute loaded up by the retrieveStatsModule() method.
getQuorumCatalogServers() - Method in interface com.ibm.websphere.objectgrid.management.QuorumManagerMBean
Retrieve the number of catalog service processes required for quorum.
getReadOnly() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Retrieves the map type.
getReduceTime(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the specified agent's total reduce time attribute loaded up by the retrieveStatsModule() method.
getRelationshipField() - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Retrieve the name of the attribute in the source class that references the key of the target class.
getReplicationGroup() - Method in exception com.ibm.websphere.objectgrid.UnavailableServiceException
Returns the replication group identifier for this exception.
getReplicationMode() - Method in interface com.ibm.websphere.objectgrid.ClientReplicableMap
Returns the current replication mode
getRequestRetryTimeout() - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Retrieves the current request retry timeout.
getRequestRetryTimeout() - Method in interface com.ibm.websphere.objectgrid.Session
Retrieves the current request retry timeout for this session.
getResultInflationTime(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the specified agent's result inflation time attribute loaded up by the retrieveStatsModule() method.
getResultSerializationTime(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the specified agent's result serialization time attribute loaded up by the retrieveStatsModule() method.
getSafeToShutdown() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns true if a replica exists for each primary hosted on this server.
getSerializerAccessor() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Retrieve the SerializerAccessor for this map.
getServerName() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the name of the server containing the replication group member for the map associated with this MBean.
getServerName() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets the name of the server containing the replication group member for the ObjectGrid associated with this MBean.
getServerName() - Method in interface com.ibm.websphere.objectgrid.management.ServerMBean
Gets the name of the server associated with this MBean.
getServers() - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Retrieves a CompositeData of each eXtreme Scale server that is currently registered with the catalog service.
getSession() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Gets a Session object that can be used by a single thread at a time.
getSession(Subject) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Allows the use of a specific Subject rather than use the SubjectSource configured on the ObjectGrid to get a Session.
getSession(CredentialGenerator) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Get a session using a CredentialGenerator.
getSession() - Method in interface com.ibm.websphere.objectgrid.spring.SpringLocalTxManager
This returns a managed session for the ObjectGrid associated with this thread.
getSession() - Method in interface com.ibm.websphere.objectgrid.TxID
Returns the Session that owns this TxID.
getSessionHandle() - Method in interface com.ibm.websphere.objectgrid.Session
Retrieves a handle for this session.
getSessionID() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets the ID of the session instance associated with this MBean.
getSessionStatsModule() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets a string representation of the SessionStatsModule attributes loaded up by the retrieveStatsModule() method.
getSleepTime() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Gets the sleep time being used in seconds.
getSleepTime() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Gets the sleep time being used in seconds.
getSlot(int) - Method in interface com.ibm.websphere.objectgrid.TxID
Gets the context information currently associated with this transaction.
getSourceClass() - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Retrieve the name of the class representing the source of a relationship.
getSSLConfiguration() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the SSLConfiguration object associated with this client security configuration.
getSSLConfiguration() - Static method in class com.ibm.websphere.objectgrid.security.config.ClientSecurityConfigurationFactory
Creates a new SSL configuration with all its attributes set to their default values.
getSSLConfiguration(String, String, String, String, String, String, String, String, String) - Static method in class com.ibm.websphere.objectgrid.security.config.ClientSecurityConfigurationFactory
Creates a new SSL configuration using the specified attributes.
getState() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Retrieve the current life cycle state of this map.
getState() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieve the state of the shard.
getState() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Retrieve the current life cycle state of this ObjectGrid.
getStatsSpec() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Retrieve the current statistics specification for the server.
getStatus() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Retrieve the status information for the shards in this container.
getTargetClass() - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Retrieve the name of the class representing the target of a relationship.
getTimeBasedDBUpdateConfig() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Get the time-based database update configuration object.
getTimeToLive() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets the number of seconds for an entry to live.
getTimeToLive() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Gets the "time to live" for each map entry.
getTotalDurationTime(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the specified agent's total run time attribute loaded up by the retrieveStatsModule() method.
getTotalMemory() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns the total memory in bytes for the JVM hosting this server.
getTotalRequestCount() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieves the number of requests that this shard has processed or forwarded since its inception.
getTraceSpec() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Retrieve the current trace specification for the server.
getTraceSpecification() - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Retrieves the trace specification for the current JVM.
getTransactionCallback() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Retrieves the TransactionCallback object.
getTransactionIsolation() - Method in interface com.ibm.websphere.objectgrid.Session
Retrieves the current transaction isolation level for this session.
getTransactionTimeout() - Method in interface com.ibm.websphere.objectgrid.Session
Gets current transaction timeout for this Session.
getTransactionType() - Method in interface com.ibm.websphere.objectgrid.Session
Retrieves the transaction type that is set with the Session.setTransactionType(String) method.
getTransportType() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the transport type for this client security configuration.
getTrustStore() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the trust store file path name for this SSL configuration.
getTrustStorePassword() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the password of the trust store for this SSL configuration.
getTrustStoreType() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the type of the trust store for this SSL configuration.
getTTL() - Method in interface com.ibm.websphere.objectgrid.plugins.CacheEntry
Returns the time-to-live value for this entry.
getTtlEvictorType() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets how expiration time of a BackingMap entry is computed.
getTtlEvictorType() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Gets the "time to live" Evictor type for this BackingMapConfiguration.
getTxID() - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback.BeforeCommit.TransactionContext
Retrieve the TxID for the transaction.
getTxID() - Method in interface com.ibm.websphere.objectgrid.Session
Gets the TxID transaction identifier, if a transaction is active.
getTxIDString() - Method in exception com.ibm.websphere.objectgrid.TransactionTimeoutException
Get the String representation of the TxID for the transaction that timed out.
getTxIsolation() - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Retrieves the default transaction isolation level.
getTxIsolation() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Retrieves the default transaction isolation level.
getTxTimeout() - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Gets the transaction timeout.
getTxTimeout() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Gets transaction timeout setting for this ObjectGrid instance.
getType() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieve the type of the shard.
getType() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Gets the type of this LogElement.
getType() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
Gets the subject type.
getUndoType() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Returns what operation must be performed to "undo" a prior change the transaction made to the map entry.
getUserName() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
Gets the user name for this credential.
getUserName() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
Gets the user name for this credential.
getValue() - Method in interface com.ibm.websphere.objectgrid.config.ConfigProperty
Get the value that is assigned to this ConfigProperty.
getValueClass() - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Retrieve the type of object that is stored in the BackingMap.
getVersionedValue() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Gets the versioned object at the time the object was first associated with the transaction.
getViewMap(String) - Method in interface com.ibm.websphere.objectgrid.Session
Deprecated. Stream query is deprecated in version 7.0.
getWriteBehind() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Get the write-behind parameter.
getZoneName() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Retrieve the name of the zone grouping that this container belongs to.
getZoneName() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns the zone name for this process

H

hashCode() - Method in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
 
hashCode() - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
 
hashCode() - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
 
hashCode() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
Returns the hashcode of the UserPasswordCredential object.
hashCode() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
Returns the hashcode of the UserPasswordCredentialGenerator object.
hashCode() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredential
Returns the hashcode of the WSTokenCredential object.
hashCode() - Method in interface com.ibm.websphere.objectgrid.security.plugins.Credential
Returns the hashcode of the Credential object
hashCode() - Method in interface com.ibm.websphere.objectgrid.TxID
Returns the hashcode of the Tx identifier.
HashIndexMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to access different attributes and statistical data about a specific HashIndex on a server process.
HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE - Static variable in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Constant representing a heartbeat frequency level at an aggressive rate.
HEARTBEAT_FREQUENCY_LEVEL_RELAXED - Static variable in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Constant representing a heartbeat frequency level at relaxed rate.
HEARTBEAT_FREQUENCY_LEVEL_TYPICAL - Static variable in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Constant representing a heartbeat frequency level at a typical rate.

I

ibmClearDirtyAttributes() - Method in interface com.ibm.websphere.objectgrid.plugins.ValueProxyInfo
Clears the list of dirty attributes.
ibmGetDirtyAttributes() - Method in interface com.ibm.websphere.objectgrid.plugins.ValueProxyInfo
Returns a list of dirty attributes based on the value interface set on the map.
ibmGetRealValue() - Method in interface com.ibm.websphere.objectgrid.plugins.ValueProxyInfo
Returns the real value object this proxy represents.
initCause(Throwable) - Method in interface com.ibm.websphere.objectgrid.IObjectGridException
Provides JDK 1.4 Throwable.initCause() behavior.
initCause(Throwable) - Method in exception com.ibm.websphere.objectgrid.ObjectGridException
Initializes the cause of this ObjectGridException to the specified value.
initCause(Throwable) - Method in exception com.ibm.websphere.objectgrid.ObjectGridRuntimeException
Initializes the cause of this ObjectGridRuntimeException to the specified value.
initialize() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Begins the bootstrapping of the ObjectGrid and Session instances.
initialize(BackingMap, EvictionEventCallback) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
 
initialize(BackingMap, EvictionEventCallback) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
 
initialize(ObjectGrid) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
 
initialize(BackingMap, EvictionEventCallback) - Method in interface com.ibm.websphere.objectgrid.plugins.Evictor
Called by a BackingMap instance during the evictor initialization time.
initialize(Session) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventGroup.ShardLifecycle
Invoked when an ObjectGrid is initialized.
initialize(Session) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventListener
Invoked when an ObjectGrid is initialized.
initialize(ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback
Invoked when an ObjectGrid is initialized.
insert(Object, Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Performs an explicit insert of a given entry.
insert(Object, Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
insert(Object, Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Performs an explicit insert of a given entry.
insert(Object, Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
INSERT - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the INSERT operation.
INT_PRIM - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.INT_PRIM can be used to set a property of type int on a plugin.
INTEGER_JAVA_LANG - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.INTEGER_JAVA_LANG can be used to set a property of type java.lang.Integer on a plugin.
INVALID_PARTITION - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
INVALID_PARTITION indicates that no partition was found for the requested shard.
invalidate(Object, boolean) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Invalidates an entry in the cache based on the key parameter.
invalidate(Object, boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Invalidates an entry in the cache based on the key parameter.
invalidateAll(Collection, boolean) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Invalidate a set of cache entries based on the Collection of keys provided.
invalidateAll(Collection, boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Invalidate a set of cache entries based on the Collection of keys provided.
invalidateUsingKeyword(Serializable, boolean) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
invalidateUsingKeyword(Serializable, boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
InvalidCredentialException - Exception in com.ibm.websphere.objectgrid.security.plugins
This exception indicates that the credential used for authentication is invalid.
InvalidCredentialException() - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.InvalidCredentialException
Constructs a new InvalidCredentialException with null as its detail message.
InvalidCredentialException(String) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.InvalidCredentialException
Constructs a new InvalidCredentialException with the specified detail message.
InvalidCredentialException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.InvalidCredentialException
Constructs a new InvalidCredentialException with the specified detail message and cause.
InvalidCredentialException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.InvalidCredentialException
Constructs a new InvalidCredentialException with a specified cause.
IObjectGridException - Interface in com.ibm.websphere.objectgrid
This interface is used to ensure JDK 1.4 Throwable chaining behavior for all exceptions thrown by ObjectGrid even when an earlier JDK is used (e.g.
isBootStrapListShuffled() - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Retrieves the value of the BootStrapListShuffled property.
isBytes() - Method in class com.ibm.websphere.objectgrid.CopyMode
Is the copy mode one of the copy modes that indicate copy to bytes?
isCascaded() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Answers true if this LogElement is a result of a cascade operation.
isCommitting() - Method in interface com.ibm.websphere.objectgrid.Session
Returns whether the current session transaction is performing a session commit() operation.
isDirty() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns whether this LogSequence has any LogElements that would "dirty" a Map.
isEmpty() - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.
isExternalTransactionActive(Session) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
This method returns true if a WebSphere JTA transaction is active.
isExternalTransactionActive(Session) - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback
Called when an application attempts to use a Session with no transaction active.
isFlushing() - Method in interface com.ibm.websphere.objectgrid.Session
Returns whether the current session transaction is performing a session flush() operation.
isInBackingMap() - Method in interface com.ibm.websphere.objectgrid.plugins.CacheEntry
Indicates whether this entry is in the BackingMap
isMarkedRollbackOnly() - Method in interface com.ibm.websphere.objectgrid.Session
Returns whether or not the current active session transaction is marked as being rollback only as a result of a prior call to the markRollbackOnly(Throwable) method on this Session.
isPending() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Answers true if this change has NOT been applied to the loader.
isPreferLocalHost() - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
This method is reserved for future use.
isPreferLocalProcess() - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
This method is reserved for future use.
isRollback() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns whether or not this LogSequence was generated to rollback a transaction.
isSecurityEnabled() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Checks whether security is enabled on this ObjectGrid or not.
isSecurityEnabled() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets whether security is enabled for this client security configuration.
isSessionHandleSet() - Method in interface com.ibm.websphere.objectgrid.Session
Determines if a SessionHandle is currently set on this Session.
isSingleSignOnEnabled() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets whether single sign on is enabled for this client security configuration.
isTransactionActive() - Method in interface com.ibm.websphere.objectgrid.Session
Determines if a transaction is currently active.
isTransactionActive() - Method in exception com.ibm.websphere.objectgrid.TransactionException
Returns true if the transaction is active.
isWriteThroughEnabled() - Method in interface com.ibm.websphere.objectgrid.Session
Returns whether the current session transaction is writing through to the back end Loader or ObjectGrid server(true), or if the changes are only applying to the BackingMap (false) or client respectively.
ivTransactionRolledBack - Variable in exception com.ibm.websphere.objectgrid.TransactionException
Indicates whether the transaction was rolled back or not.

J

JavaMap - Interface in com.ibm.websphere.objectgrid
This interface is a handle to a named Map.

K

KEY_NOT_FOUND - Static variable in interface com.ibm.websphere.objectgrid.plugins.EvictorData
A special value indicating that the key was not found.
KeyNotFoundException - Exception in com.ibm.websphere.objectgrid
Normally, record not found means a null is returned.
KeyNotFoundException() - Constructor for exception com.ibm.websphere.objectgrid.KeyNotFoundException
Constructs a new KeyNotFoundException with null as its detail message.
KeyNotFoundException(String) - Constructor for exception com.ibm.websphere.objectgrid.KeyNotFoundException
Constructs a new KeyNotFoundException with the specified detail message.
KeyNotFoundException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.KeyNotFoundException
Constructs a new KeyNotFoundException with the specified detail message and cause.
KeyNotFoundException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.KeyNotFoundException
Constructs a new KeyNotFoundException with a specified cause.
keySet() - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.

L

LAST_ACCESS_TIME - Static variable in class com.ibm.websphere.objectgrid.TTLType
A TTLType.LAST_ACCESS_TIME indicates an entry expiration time is the sum of the last access time of the entry plus the "time to live" value.
LAST_UPDATE_TIME - Static variable in class com.ibm.websphere.objectgrid.TTLType
A TTLType.LAST_UPDATE_TIME indicates an entry expiration time is the sum of the last update time of the entry plus the "time to live" value.
LFUEvictor - Class in com.ibm.websphere.objectgrid.plugins.builtins
This class manages a BackingMap using a simple Least Frequently Used (LFU) algorithm.
LFUEvictor() - Constructor for class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Creates a LFUEvictor object with default values for the maximum size per heap, the number of heaps, and sleep time between sweeps of the heaps by the evictor thread.
listCoreGroupMembers(String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
List the coregroup members for a given coregroup.
listObjectGridPlacement(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
List the placement of shards for each container in the domain.
listObjectGridPlacementStatus(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
List the current placement status.
listPartition(String, String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
List the partition placement status in the domain.
listShards(String, String, String, int) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
List the shard placement status.
listVerifiedRoutingTable(String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Calling this method will return an XML string of the current known routing table.
LoaderException - Exception in com.ibm.websphere.objectgrid.plugins
This exception is the base exception for any exceptions encountered by a Loader.
LoaderException() - Constructor for exception com.ibm.websphere.objectgrid.plugins.LoaderException
Constructs a new LoaderException with null as its detail message.
LoaderException(String) - Constructor for exception com.ibm.websphere.objectgrid.plugins.LoaderException
Constructs a new LoaderException with the specified detail message.
LoaderException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.LoaderException
Constructs a new LoaderException with the specified detail message and cause.
LoaderException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.LoaderException
Constructs a new LoaderException with a specified cause.
LOCAL - Static variable in interface com.ibm.websphere.objectgrid.BackingMap
Constant used to indicate this map is not a distributed map.
LOCAL - Static variable in interface com.ibm.websphere.objectgrid.ObjectGrid
Indicates the ObjectGrid is a local ObjectGrid.
LockDeadlockException - Exception in com.ibm.websphere.objectgrid
This exception is used by the lock manager to indicate that it detected a deadlock.
LockDeadlockException() - Constructor for exception com.ibm.websphere.objectgrid.LockDeadlockException
Constructs a new LockDeadlockException with null as its detail message.
LockDeadlockException(String) - Constructor for exception com.ibm.websphere.objectgrid.LockDeadlockException
Constructs a new LockDeadlockException with the specified detail message.
LockException - Exception in com.ibm.websphere.objectgrid
A general locking exception indicating something went wrong with locking operations.
LockException() - Constructor for exception com.ibm.websphere.objectgrid.LockException
Constructs a new LockException with null as its detail message.
LockException(String) - Constructor for exception com.ibm.websphere.objectgrid.LockException
Constructs a new LockException with the specified detail message.
LockException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.LockException
Constructs a new LockException with the specified detail message and cause.
LockException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.LockException
Constructs a new LockException with a specified cause.
LockInternalFailureException - Exception in com.ibm.websphere.objectgrid
This exception is used by the lock manager to indicate it detected some internal programming error while processing a lock or unlock request.
LockInternalFailureException() - Constructor for exception com.ibm.websphere.objectgrid.LockInternalFailureException
Constructs a new LockInternalFailureException with null as its detail message.
LockInternalFailureException(String) - Constructor for exception com.ibm.websphere.objectgrid.LockInternalFailureException
Constructs a new LockInternalFailureException with the specified detail message.
LockInternalFailureException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.LockInternalFailureException
Constructs a new LockInternalFailureException with the specified detail message and cause.
LockInternalFailureException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.LockInternalFailureException
Constructs a new LockInternalFailureException with a specified cause.
LockStrategy - Class in com.ibm.websphere.objectgrid
LockStrategy provides an enumerated type idiom for use on the BackingMap.setLockStrategy(LockStrategy) method.
LockTimeoutException - Exception in com.ibm.websphere.objectgrid
This exception is used by the lock manager to indicate that the maximum wait time for a lock has been exceeded.
LockTimeoutException() - Constructor for exception com.ibm.websphere.objectgrid.LockTimeoutException
Constructs a new LockTimeoutException with null as its detail message.
LockTimeoutException(String) - Constructor for exception com.ibm.websphere.objectgrid.LockTimeoutException
Constructs a new LockTimeoutException with the specified detail message.
LockTimeoutException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.LockTimeoutException
Constructs a new LockTimeoutException with the specified detail message and cause.
LockTimeoutException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.LockTimeoutException
Constructs a new LockTimeoutException with a specified cause.
LogElement - Interface in com.ibm.websphere.objectgrid.plugins
LogElements are the individual entries within a LogSequence.
LogElement.Type - Class in com.ibm.websphere.objectgrid.plugins
The Type class is used to represent a LogElement type.
LogSequence - Interface in com.ibm.websphere.objectgrid.plugins
LogSequence is the ordered list of changes performed against a given map for a given transaction.
LogSequenceFilter - Interface in com.ibm.websphere.objectgrid.plugins
This interface can be used to filter a LogSequence.
LONG_JAVA_LANG - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.LONG_JAVA_LANG can be used to set a property of type java.lang.Long on a plugin.
LONG_PRIM - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.LONG_PRIM can be used to set a property of type long on a plugin.
LRUEvictor - Class in com.ibm.websphere.objectgrid.plugins.builtins
This evictor manages a BackingMap using a simple Least Recently Used (LRU) algorithm.
LRUEvictor() - Constructor for class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Creates a new LRUEvictor object with default values for the maximum size per LRU queue, the number of queues, and sleep time between sweeps by the evictor thread.

M

MAP_EVENT_LISTENER - Static variable in interface com.ibm.websphere.objectgrid.config.PluginType
PluginType.MAP_EVENT_LISTENER can be used to attach a MapEventListener to a BackingMap.
MAP_LIFECYCLE_LISTENER - Static variable in interface com.ibm.websphere.objectgrid.config.PluginType
PluginType.MAP_LIFECYCLE_LISTENER can be used to attach a BackingMapLifecycleListener plugin to an BackingMap
MAP_SERIALIZER_PLUGIN - Static variable in interface com.ibm.websphere.objectgrid.config.PluginType
PluginType.MAP_SERIALIZER_PLUGIN can be used to attach a MapSerializerPlugin to a BackingMap to serialize keys.
MapEventListener - Interface in com.ibm.websphere.objectgrid.plugins
This callback interface is implemented by the application when it wants to receive events about a Map such as the eviction of a map entry.
MapMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to access different attributes and statistical data about a specific map on a server process.
MAPSET_UNSUPPORTED_ON_CONTAINER - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
MAPSET_UNSUPPORTED_ON_CONTAINER indicates that an attempt was made to reserve a shard from a map set that is not supported on this container.
markRollbackOnly(Throwable) - Method in interface com.ibm.websphere.objectgrid.Session
Marks the current transaction as being rollback only.
modifyServerTraceSpec(String) - Method in interface com.ibm.websphere.objectgrid.management.ServerMBean
Deprecated. This is deprecated in version 7.1. See DynamicServerMBean.setTraceSpec(String)

N

NEVER_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for value Never indicating an option is not supported.
NO_COPY - Static variable in class com.ibm.websphere.objectgrid.CopyMode
The NO_COPY mode allows an application to promise that it will never modify a value object obtained using an ObjectMap.get method in exchange for performance improvements.
NoActiveTransactionException - Exception in com.ibm.websphere.objectgrid
An exception indicating there is no active transaction.
NoActiveTransactionException() - Constructor for exception com.ibm.websphere.objectgrid.NoActiveTransactionException
Constructs a new NoActiveTransactionException with null as its detail message.
NoActiveTransactionException(String) - Constructor for exception com.ibm.websphere.objectgrid.NoActiveTransactionException
Constructs a new NoActiveTransactionException with the specified detail message.
NoActiveTransactionException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.NoActiveTransactionException
Constructs a new NoActiveTransactionException with the specified detail message and cause.
NoActiveTransactionException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.NoActiveTransactionException
Constructs a new NoActiveTransactionException with a specified cause.
NONE - Static variable in interface com.ibm.websphere.objectgrid.ClientReplicableMap
No replication mode, aka normal mode.
NONE - Static variable in class com.ibm.websphere.objectgrid.LockStrategy
NONE indicates internal LockManager use is not needed since concurrency control is provided outside of ObjectGrid either by a persistence manager using objectgrid as a side cache, the application, or by a Loader plugin (for example, uses database locks to control concurrency).
NONE - Static variable in class com.ibm.websphere.objectgrid.TTLType
A TTLType.NONE indicates an entry has no expiration time and is allowed to live in the BackingMap until the application explicitly removes or invalidates the entry or a user defined evictor evicts it.

O

ObjectGrid - Interface in com.ibm.websphere.objectgrid
This object is used for creating sessions to the ObjectGrid.
OBJECTGRID_EVENT_LISTENER - Static variable in interface com.ibm.websphere.objectgrid.config.PluginType
PluginType.OBJECTGRID_EVENT_LISTENER can be used to attach an ObjectGridEventListener plugin to an ObjectGrid
OBJECTGRID_LIFECYCLE_LISTENER - Static variable in interface com.ibm.websphere.objectgrid.config.PluginType
PluginType.OBJECTGRID_LIFECYCLE_LISTENER can be used to attach an ObjectGridLifecycleListener plugin to an ObjectGrid
ObjectGridConfigFactory - Class in com.ibm.websphere.objectgrid.config
This is the configuration factory for ObjectGrid configuration entities.
ObjectGridConfigFactory() - Constructor for class com.ibm.websphere.objectgrid.config.ObjectGridConfigFactory
 
ObjectGridConfiguration - Interface in com.ibm.websphere.objectgrid.config
An ObjectGridConfiguration object can be used to override ObjectGrid plugins on the client side.
ObjectGridConfigurationException - Exception in com.ibm.websphere.objectgrid.config
Thrown when a problem with the current configuration is found.
ObjectGridConfigurationException() - Constructor for exception com.ibm.websphere.objectgrid.config.ObjectGridConfigurationException
Constructs a new ObjectGridConfigurationException with null as its detail message.
ObjectGridConfigurationException(String) - Constructor for exception com.ibm.websphere.objectgrid.config.ObjectGridConfigurationException
Constructs a new ObjectGridConfigurationException with the specified detail message.
ObjectGridConfigurationException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.config.ObjectGridConfigurationException
Constructs a new ObjectGridConfigurationException with a specified cause.
ObjectGridConfigurationException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.config.ObjectGridConfigurationException
Constructs a new ObjectGridConfigurationException with the specified detail message and cause.
ObjectGridEventGroup - Interface in com.ibm.websphere.objectgrid.plugins
This is a set of single method interfaces for fine grained events delivered for an ObjectGrid.
ObjectGridEventGroup.ShardEvents - Interface in com.ibm.websphere.objectgrid.plugins
These events are fired when a shard is made a primary shard and when the shard is demoted from a primary.
ObjectGridEventGroup.ShardLifecycle - Interface in com.ibm.websphere.objectgrid.plugins
These events are fired when an ObjectGrid shard is initialized and destroyed.
ObjectGridEventGroup.TransactionEvents - Interface in com.ibm.websphere.objectgrid.plugins
These events are called every single transaction.
ObjectGridEventListener - Interface in com.ibm.websphere.objectgrid.plugins
This interface is used to create an implementation of an event listener for an ObjectGrid.
ObjectGridException - Exception in com.ibm.websphere.objectgrid
Base exception class for all checked exceptions thrown by the ObjectGrid product.
ObjectGridException() - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridException
Constructs a new ObjectGridException with null as its detail message.
ObjectGridException(String) - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridException
Constructs a new ObjectGridException with the specified detail message.
ObjectGridException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridException
Constructs a new ObjectGridException with a specified cause.
ObjectGridException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridException
Constructs a new ObjectGridException with the specified detail message and cause.
ObjectGridManager - Interface in com.ibm.websphere.objectgrid
ObjectGridManager is responsible for creating or retrieving local ObjectGrid instances and connecting to distributed ObjectGrid servers.
ObjectGridManagerFactory - Class in com.ibm.websphere.objectgrid
This factory class is a high level helper class to get ObjectGridManager instances.
ObjectGridManagerFactory() - Constructor for class com.ibm.websphere.objectgrid.ObjectGridManagerFactory
 
ObjectGridMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to access different attributes and statistical data about a specific ObjectGrid on a server process.
ObjectGridRuntimeException - Exception in com.ibm.websphere.objectgrid
This exception is the base class for all runtime exceptions thrown by the cache.
ObjectGridRuntimeException() - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridRuntimeException
Constructs a new ObjectGridRuntimeException with null as its detail message.
ObjectGridRuntimeException(String) - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridRuntimeException
Constructs a new ObjectGridRuntimeException with the specified detail message.
ObjectGridRuntimeException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridRuntimeException
Constructs a new ObjectGridRuntimeException with a specified cause.
ObjectGridRuntimeException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridRuntimeException
Constructs a new ObjectGridRuntimeException with the specified detail message and cause.
ObjectGridSecurityException - Exception in com.ibm.websphere.objectgrid.security
This exception represents a general ObjectGrid security exception.
ObjectGridSecurityException() - Constructor for exception com.ibm.websphere.objectgrid.security.ObjectGridSecurityException
Constructs a new ObjectGridSecurityException with null as its detail message.
ObjectGridSecurityException(String) - Constructor for exception com.ibm.websphere.objectgrid.security.ObjectGridSecurityException
Constructs a new ObjectGridSecurityException with the specified detail message.
ObjectGridSecurityException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.ObjectGridSecurityException
Constructs a new ObjectGridSecurityException with the specified detail message and cause.
ObjectGridSecurityException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.ObjectGridSecurityException
Constructs a new ObjectGridSecurityException with a specified cause.
ObjectGridSpringFactory - Class in com.ibm.websphere.objectgrid.spring
This class serves as a factory to construct instances of the various Spring specific APIs.
ObjectGridSpringFactory() - Constructor for class com.ibm.websphere.objectgrid.spring.ObjectGridSpringFactory
 
ObjectGridTransactionException - Exception in com.ibm.websphere.objectgrid.spring
The ObjectGrid platform transaction manager can throw this unchecked exception whenever errors occur.
ObjectGridTransactionException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.spring.ObjectGridTransactionException
Constructs a new ObjectGridTransactionException with the specified detail message and cause.
ObjectGridTransactionException(String) - Constructor for exception com.ibm.websphere.objectgrid.spring.ObjectGridTransactionException
Constructs a new ObjectGridTransactionException with the specified detail message.
ObjectMap - Interface in com.ibm.websphere.objectgrid
This is a handle to a named Map.
OFFLINE - Static variable in class com.ibm.websphere.objectgrid.AvailabilityState
An AvailabilityState.OFFLINE indicates that a shard is offline and unable to process requests.
onData(LogSequence) - Method in interface com.ibm.websphere.objectgrid.plugins.ReplicationMapListener
This method is invoked when a data change is replicated to the client replication map.
ONLINE - Static variable in class com.ibm.websphere.objectgrid.AvailabilityState
An AvailabilityState.ONLINE indicates that a shard is online.
OPTIMISTIC - Static variable in class com.ibm.websphere.objectgrid.LockStrategy
OPTIMISTIC is typically used for a map that does not have a Loader plugin, the map is read mostly, and locking is neither provided by a persistence manager using ObjectGrid as a side cache or by the application itself.
overrideQuorum() - Method in interface com.ibm.websphere.objectgrid.management.QuorumManagerMBean
This operation forces surviving catalog service grid processes to reestablish a quorum.

P

partitionLogSequence(LogSequence) - Method in interface com.ibm.websphere.objectgrid.PartitionManager
Partitions a LogSequence based on the partitioning algorithm for the Map.
PartitionManager - Interface in com.ibm.websphere.objectgrid
This interface will be used for calculating the proper partition for a given input key.
PESSIMISTIC - Static variable in class com.ibm.websphere.objectgrid.LockStrategy
PESSIMISTIC is typically used for a map that does not have a Loader plugin and locking is neither provided by a persistence manager using ObjectGrid as a side cache, by a Loader plugin, or by the application itself.
PlacementMediationServiceMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to perform operations on and get status from the PlacementMediationService running in a dynamic environment.
PlacementServiceMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to perform operations on and get status from the PlacementService running in a dynamic environment.
Plugin - Interface in com.ibm.websphere.objectgrid.config
This interface represents an ObjectGrid or BackingMap plugin.
PluginType - Interface in com.ibm.websphere.objectgrid.config
Every Plugin has a PluginType.
PRELOAD - Static variable in class com.ibm.websphere.objectgrid.AvailabilityState
An AvailabilityState.PRELOAD indicates that a shard is in the preload state.
preloadCompleted(Throwable) - Method in interface com.ibm.websphere.objectgrid.plugins.MapEventListener
Invoked when the preloading of this map has completed.
PRIMARY - Static variable in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Constant representing a primary shard type.
processLogSequence(LogSequence) - Method in interface com.ibm.websphere.objectgrid.Session
Processes a LogSequence.
PROP_LISTENER_HOST - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
Listener host property key for the client properties file.
PROP_LISTENER_PORT - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
Listener port property key for the client properties file.
PROP_PREFER_LOCAL_HOST - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
Currently, this property is not used.
PROP_PREFER_LOCAL_PROCESS - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
Currently, this property is not used.
PROP_PREFER_ZONES - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
Prefer zones property key for the client properties file.
PROP_REQUEST_RETRY_TIMEOUT - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
The requestRetryTimeout which indicates how long to retry a request (in milliseconds).
PROP_SHUFFLE_BOOTSTRAP_ADDRESSES - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
The shuffleBoostrapAddresses property is used to determine if the catalog service grid addresses should be randomized when used by a client when bootstrapping to the grid.
PROPERTY_ACCESS - Static variable in class com.ibm.websphere.objectgrid.config.QueryMapping
This constant indicates to use JavaBean property-style get methods to read the field values from the Java object stored in the BackingMap.
put(Object, Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
put(Object, Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Puts the Object value into the cache at location represented by key.
put(Object, Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Puts the Object value into the cache at location represented by key.
put(Object, Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
putAll(Map, Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
putAll(Map) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Puts each of the Object values into the cache at location represented by the corresponding key contained in the Map.
putAll(Map) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Puts each of the Object value into the cache at location represented by key contained in the Map.
putAll(Map, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
putOverrideObjectGridConfigurations(String, List) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Deprecated. This method is replaced in 7.1.1 with the getObjectGrid method that takes a ObjectGridConfigurations.
putSlot(int, Object) - Method in interface com.ibm.websphere.objectgrid.TxID
Sets some context information to be associated with this transaction.

Q

QueryConfig - Class in com.ibm.websphere.objectgrid.config
This QueryConfig represents a schema configuration for a QueryManager.
QueryConfig() - Constructor for class com.ibm.websphere.objectgrid.config.QueryConfig
Default constructor.
QueryManagerMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to perform operations on and get status from an ObjectGrid Query Manager running in a dynamic environment.
QueryMapping - Class in com.ibm.websphere.objectgrid.config
A QueryMapping maps a Java class to a BackingMap and allows a map to be included in a query.
QueryMapping() - Constructor for class com.ibm.websphere.objectgrid.config.QueryMapping
Default constructor.
QueryMapping(String, String, String) - Constructor for class com.ibm.websphere.objectgrid.config.QueryMapping
Constructor for creating a basic QueryMapping instance wiht a default access type of QueryMapping.PROPERTY_ACCESS.
QueryMapping(String, String, String, int) - Constructor for class com.ibm.websphere.objectgrid.config.QueryMapping
Constructor for creating a QueryMapping instance.
QueryRelationship - Class in com.ibm.websphere.objectgrid.config
A QueryRelationship represents a relationship between two BackingMap value classes.
QueryRelationship(String, String, String, String) - Constructor for class com.ibm.websphere.objectgrid.config.QueryRelationship
Constructor for creating a QueryRelationship instance.
QUEUE_TIMEOUT_INFINITE - Static variable in interface com.ibm.websphere.objectgrid.ObjectMap
Used as a parameter on the ObjectMap.getNextKey(long) method, specifies the method should block until a key becomes available.
QUEUE_TIMEOUT_NONE - Static variable in interface com.ibm.websphere.objectgrid.ObjectMap
Used as a parameter on the ObjectMap.getNextKey(long) method, specifies to return a null value if the map is empty.
QUIESCE - Static variable in class com.ibm.websphere.objectgrid.AvailabilityState
An AvailabilityState.QUIESCE indicates that a shard is in quiesce.
QUIESCE_COMPLETE - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
QUIESCE_COMPLETE is the MBean notification type for a completed quiesce.
quiesceContainer(Boolean) - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Prepare the container for a potential shutdown by moving replica shards, verifying that primaries have required sync replicas and preventing the placement of new shards.
QuorumManagerMBean - Interface in com.ibm.websphere.objectgrid.management
Each catalog service has a QuorumManager and an associated MBean.

R

ReadOnlyException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when an attempt is made to modifying operations on a read only maps.
ReadOnlyException() - Constructor for exception com.ibm.websphere.objectgrid.ReadOnlyException
Constructs a new ReadOnlyException with null as its detail message.
ReadOnlyException(String) - Constructor for exception com.ibm.websphere.objectgrid.ReadOnlyException
Constructs a new ReadOnlyException with the specified detail message.
ReadOnlyException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ReadOnlyException
Constructs a new ReadOnlyException with the specified detail message and cause.
ReadOnlyException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ReadOnlyException
Constructs a new ReadOnlyException with a specified cause.
registerEntities(URL) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Registers one ore more entities from an entity XML file.
registerEntities(Class[]) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Register one or more entities based on the class metadata.
registerSpringBeanFactoryAdapter(String, Object) - Static method in class com.ibm.websphere.objectgrid.spring.ObjectGridSpringFactory
This returns an adapter for a Spring based bean factory.
release(String, String, String) - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Release a shard that has been previously reserved by this container.
RELEASE_SUCCESSFUL - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
RELEASE_SUCCESSFUL indicates that the attempt to release the shard was successful.
RELEASE_UNSUPPORTED_WITH_PER_CONTAINER - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
RELEASE_UNSUPPORTED_WITH_PER_CONTAINER indicates that the shard is part of a map set using the PER_CONTAINER placement strategy.
remove(Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Removes the Object value from the cache represented by key.
remove(Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Removes the Object value from the cache represented by key.
removeAll(Collection) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Batch remove from the Map.
removeAll(Collection) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Batch remove from the Map.
removeDynamicIndex(String) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Removes a dynamic index on the BackingMap.
removeEventListener(EventListener) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Removes an EventListener.
removeEventListener(ObjectGridEventListener) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Deprecated. This method is deprecated in version 7.1.1, use the ObjectGrid.removeEventListener(EventListener) method.
removeMapEventListener(EventListener) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Removes an EventListener from this BackingMap.
removeMapEventListener(MapEventListener) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Deprecated. This method is deprecated in version 7.1.1, use the BackingMap.removeMapEventListener(EventListener) method.
removeObjectGrid(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Removes a local, in-memory ObjectGrid from the cache of ObjectGrid instances.
removeObjectGrid(String, boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Removes a local, in-memory ObjectGrid from the cache of ObjectGrid instances and optionally destroys its associated resources.
replaceLostShards(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Lost shards are placed onto the UNREPAIRED container when autoReplaceLostShards is disabled.
replicationExits() - Method in interface com.ibm.websphere.objectgrid.plugins.ReplicationMapListener
This method is invoked when replication has been disabled for this map.
ReplicationMapListener - Interface in com.ibm.websphere.objectgrid.plugins
This interface is used to create an implementation of an event listener for client-side maps that are in replication mode.
replicationStarts() - Method in interface com.ibm.websphere.objectgrid.plugins.ReplicationMapListener
This method is invoked when a snapshot mode replica has been synchronized with the client or a continuous replica has started replicating.
ReplicationVotedToRollbackTransactionException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when a transaction was rolled back because some/all of the replicas failed to apply the transaction when in synchronous replication mode.
ReplicationVotedToRollbackTransactionException() - Constructor for exception com.ibm.websphere.objectgrid.ReplicationVotedToRollbackTransactionException
Constructs a new ReplicationVotedToRollbackTransactionException with null as its detail message.
ReplicationVotedToRollbackTransactionException(String) - Constructor for exception com.ibm.websphere.objectgrid.ReplicationVotedToRollbackTransactionException
Constructs a new ReplicationVotedToRollbackTransactionException with the specified detail message.
ReplicationVotedToRollbackTransactionException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ReplicationVotedToRollbackTransactionException
Constructs a new ReplicationVotedToRollbackTransactionException with the specified detail message and cause.
ReplicationVotedToRollbackTransactionException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ReplicationVotedToRollbackTransactionException
Constructs a new ReplicationVotedToRollbackTransactionException with a specified cause.
REQUIRED_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for value Required indicating an option is required.
RESERVATION_PRIOR_TO_INITIAL_PLACEMENT - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
RESERVATION_PRIOR_TO_INITIAL_PLACEMENT indicates that the attempt to reserve the shard was processed successfully.
RESERVATION_SUCCESSFUL - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
RESERVATION_SUCCESSFUL indicates that the attempt to reserve the shard was successful.
reserve(String, String, String, String) - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Reserve a specific shard on this container.
RESERVE_UNSUPPORTED_WITH_PER_CONTAINER - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
RESERVE_UNSUPPORTED_WITH_PER_CONTAINER indicates that the shard is part of a map set using the PER_CONTAINER placement strategy.
reserveSlot(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Allows plugins on this ObjectGrid to reserve slots for use to store context data.
resumeBalancing(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Execute balancing operation at next opportunity and allow execution of future balancing attempts for the map set specified.
retrieveAllServersJMXAddresses() - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Retrieves a List of JMX addresses for all servers that have registered with the placement service.
retrieveEntries(String) - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Operation to iterate through all of the entries in this map, convert the key to string form, then match the string against the regular expression if passed, finally return the matching entries.
retrieveMapSetName(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Retrieves the name of the MapSet in which the specified map is defined.
retrieveServerJMXAddress(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Retrieves a List of JMX address strings for a specific host and server name that has registered with the placement service.
retrieveStatsModule(String) - Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
Gets the AgentStatsModule used to retrieve statistics associated with the specified agent class
retrieveStatsModule() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the HashIndexStatsModule used to retrieve statistics associated with this index
retrieveStatsModule() - Method in interface com.ibm.websphere.objectgrid.management.MapMBean
Gets the MapStatsModule used to retrieve statistics associated with the map for this MBean.
retrieveStatsModule() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets the OGStatsModule used to retrieve statistics associated with the ObjectGrid for this MBean.
retrieveStatsModule(String) - Method in interface com.ibm.websphere.objectgrid.management.QueryManagerMBean
Gets the QueryStatsModule used to retrieve statistics associated with the specified query String
retrieveStatsModule() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets the SessionStatsModule used to retrieve statistics associated with the session for this MBean.
retrieveStatus(String, String) - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Retrieve the status information for the shards in this container, filtered by ObjectGrid and/or mapset.
ROLE_SWAP_REQUESTED_WITH_SAME_TYPE - Static variable in interface com.ibm.websphere.objectgrid.management.ShardMBean
Indicates that this shard is the same type of shard as the requested swap type.
ROLE_SWAP_SUCCESSFUL - Static variable in interface com.ibm.websphere.objectgrid.management.ShardMBean
Indicates that the role swap was executed successfully.
ROLE_SWAP_TIMEOUT - Static variable in interface com.ibm.websphere.objectgrid.management.ShardMBean
Indicates that this shard has timed out waiting to inherit its requested role
rollback(TxID) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
 
rollback(TxID) - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback
Invoked when rolling back a Session transaction.
rollback() - Method in interface com.ibm.websphere.objectgrid.Session
Rolls back a transaction.
rollingBack(LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
 
rollingBack(LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
 
run() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Periodically wakes up and evicts entries.
run() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Manages the map's size and sends eviction events to the Map.
RUN_AS_SUBJECT - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
A constant representing the runAs Subject type
RUN_AS_SUBJECT_STRING - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
A constant representing the runAs Subject type

S

SCOPE_SHARD - Static variable in class com.ibm.websphere.objectgrid.spring.ObjectGridSpringFactory
Scope identifier for shard scope: "shard".
SECURE_TOKEN_MANAGER_CUSTOM_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for "custom" type of the secure token manager.
SECURE_TOKEN_MANAGER_DEFAULT_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for "default" type of the secure token manager.
SECURE_TOKEN_MANAGER_NONE_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for "none" type of the secure token manager.
SecurityConstants - Class in com.ibm.websphere.objectgrid.security
This class contains the constants used for security configuration.
SecurityConstants() - Constructor for class com.ibm.websphere.objectgrid.security.SecurityConstants
 
SERVER - Static variable in interface com.ibm.websphere.objectgrid.BackingMap
Constant used to indicate this map is a server map.
SERVER - Static variable in interface com.ibm.websphere.objectgrid.ObjectGrid
Indicates the ObjectGrid is a server-side distributed ObjectGrid.
SERVER_COREGROUP_MEMBERSHIP_CHANGE - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
SERVER_DEFINITION_NOT_FOUND - Static variable in exception com.ibm.websphere.objectgrid.ConnectException
This failure code indicates the definition of cluster cannot be accessed.
SERVER_EVENT_STARTED - Static variable in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Constant representing an eXtreme Scale server start notification.
SERVER_EVENT_STOPPED - Static variable in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Constant representing an eXtreme Scale server stop notification.
ServerMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to access different attributes about a specific server process.
Session - Interface in com.ibm.websphere.objectgrid
This interface represents a session container for ObjectMaps.
SessionMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to access different attributes and statistical data about a specific session.
SessionNotReentrantException - Exception in com.ibm.websphere.objectgrid
A Session object can only be used by a single thread concurrently to perform map operations.
SessionNotReentrantException(String, boolean) - Constructor for exception com.ibm.websphere.objectgrid.SessionNotReentrantException
Constructs a new SessionNotReentrantException with the specified detail message and a special indication of whether the transaction was rolled back as a result of this exception.
setAccessByCreatorOnlyMode(int) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Set the "access by creator only" mode.
setAccessType(int) - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Set the method in which the query engine will access the value class object stored in the BackingMap.
setAlias(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the SSL alias name for this SSL configuration.
setAuthenticationRetryCount(int) - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Sets the authentication retry count for this client security configuration.
setAuthorizationMechanism(int) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the authorization mechanism.
setBackingMapConfigurations(List) - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Set the BackingMapConfiguration objects for this ObjectGridConfiguration.
setBootStrapListShuffled(boolean) - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Sets the value of the BootStrapListShuffled property.
setCertReqSubjectDN(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the required subject DN in the peer certificate for this SSL configuration.
setClassName(String) - Method in interface com.ibm.websphere.objectgrid.config.Plugin
The class name that is set must be an implementor of the PluginTypeImpl for this Plugin.
setClientCertificateAuthentication(int) - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Set the client certificate authentication type for this client security configuration.
setClientProperties(String, URL) - Method in interface com.ibm.websphere.objectgrid.ClientClusterContext
Sets the ClientProperties properties for the selected ObjectGrid using the specified client properies file.
setCollisionArbiter(CollisionArbiter) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the CollisionArbiter that is responsible for arbitration of revision conflicts.
setConfigProperties(List) - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Set the ConfigProperties for this object
setConfigPropertyType(ConfigPropertyType) - Method in interface com.ibm.websphere.objectgrid.config.ConfigProperty
Set the ConfigPropertyType for this object.
setContextProvider(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the JSSE context provider for this SSL configuration.
setCopyKey(boolean) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets whether or not the key needs to be copied when a map entry is created.
setCopyMode(CopyMode, Class) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the CopyMode.
setCopyMode(CopyMode, Class) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Allows the CopyMode for the Map to be overridden on this map on this session only.
setCopyMode(CopyMode, Class) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Allows the CopyMode for the Map to be overridden on this map on this session only.
setCredentialAuthenticationType(int) - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Sest the credential authentication type for this client security configuration.
setCredentialGenerator(CredentialGenerator) - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Sets the CredentialGenerator object for this client security configuration.
setDefaultKeyword(Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
setDefaultKeyword(Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
setEventListeners(List) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Deprecated. This method is deprecated in version 7.1.1. Use the ObjectGrid.addEventListener(EventListener) or ObjectGrid.removeEventListener(EventListener) methods. Plug-ins that implement the ObjectGridLifecycleListener interface are automatically registered with the grid. Using this method will remove those automatically added listeners.
setEvictionTriggers(String) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the types of additional eviction triggers, all evictors for the backing map will use the provided set of triggers.
setEvictionTriggers(String) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Sets the eviction triggers for this BackingMapConfiguration.
setEvictor(Evictor) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Associates an Evictor with this BackingMap.
setEvictorData(Object, EvictorData) - Method in interface com.ibm.websphere.objectgrid.plugins.EvictionEventCallback
Sets the evictor data for a specified BackingMap cache key.
setInvRelationshipField(String) - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Set the inverse relationship attribute name of a bi-directional relationship.
setKeyStore(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the key store file path name for this SSL configuration.
setKeyStorePassword(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the password of the key store for this SSL configuration.
setKeyStoreType(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the type of key store for this SSL configuration.
setLoader(Loader) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Associates a Loader with this BackingMap.
setLockRequestQueueDetails(String) - Method in exception com.ibm.websphere.objectgrid.LockTimeoutException
Sets the details of the lock requests on the lock request queue at the time the lock timeout occurred.
setLockStrategy(LockStrategy) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the LockStrategy.
setLockTimeout(int) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the lock timeout used by the lock manager for this BackingMap.
setLockTimeout(int) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Overrides the BackingMap's lock timeout for this ObjectMap.
setMapAuthorization(MapAuthorization) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Deprecated. in WAS XD 6.1. Use setObjectGridAuthorization(ObjectGridAuthoirzation) instead to plug in custom authorizations. If both setMapAuthorization(MapAuthorization) and setObjectGridAuthorization(ObjectGridAuthoirzation) are used, ObjectGrid will use the provided MapAuthorization to authorize map accesses, even though this method is deprecated.
setMapEventListeners(List) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Deprecated. This method is deprecated in version 7.1.1. Use the BackingMap.addMapEventListener(EventListener) or BackingMap.removeMapEventListener(EventListener) methods. Plugins that implement the ObjectGridLifecycleListener interface are automatically registered with the grid. Using this method will remove those automatically added listeners.
setMapIndexPlugins(List) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the list of MapIndexPlugin objects for this BackingMap.
setMapName(String) - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Set the BackingMap name associated with this mapping.
setMaps(List) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Clears any BackingMaps that have been previously defined on this ObjectGrid and replaces them with the List of BackingMaps provided.
setMaximumSize(int) - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Sets the maximum thread pool size.
setMaxSize(int) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Sets the maximum size of each binary heap.
setMaxSize(int) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Sets the maximum size of each LRU queue.
setMinimumSize(int) - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Sets the minimum thread pool size.
setName(String) - Method in interface com.ibm.websphere.objectgrid.config.ConfigProperty
Set the name of this object.
setName(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the name of this ObjectGrid.
setNullValuesSupported(boolean) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets whether this BackingMap supports null values.
setNumberOfBuckets(int) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the number of buckets used by this BackingMap.
setNumberOfBuckets(int) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Sets the number of buckets for this BackingMapConfiguration.
setNumberOfHeaps(int) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Sets the number of binary heaps to use.
setNumberOfLockBuckets(int) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the number of lock buckets used by the lock manager for this BackingMap.
setNumberOfLRUQueues(int) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Sets the number of LRU queues to use.
setObjectGridAuthorization(ObjectGridAuthorization) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the ObjectGridAuthorization for this ObjectGrid instance.
setObjectGridForThread(ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.spring.SpringLocalTxManager
This indicates the ObjectGrid to use on this thread when a session is requested.
setObjectGridState(AvailabilityState, ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.StateManager
Set the AvailabilityState for an ObjectGrid.
setObjectTransformer(ObjectTransformer) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the ObjectTransformer object for use by this BackingMap and/or Loader.
setOptimisticCallback(OptimisticCallback) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the OptimisticCallback.
setOSGiService(String) - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Set the OSGi service name configured for this Plugin.
setOverrideObjectGridConfigurations(Map) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Deprecated. This method is replaced in 7.1.1 with the getObjectGrid method that takes a ObjectGridConfigurations.
setPassword(String) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
Sets the password for this credential.
setPermissionCheckPeriod(int) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the permission check period.
setPlugins(List) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Set the Plugins for this BackingMapConfiguration.
setPlugins(List) - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Set the Plugins for this ObjectGridConfiguration.
setPluginType(PluginType) - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Set the PluginType for this Plugin.
setPreferLocalHost(boolean) - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
This method is reserved for future use.
setPreferLocalProcess(boolean) - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
This method is reserved for future use.
setPreferZones(String[]) - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Prefer routing to specific zones.
setPreloadMode(boolean) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the preload mode if a Loader is set for this BackingMap.
setPrimaryKeyField(String) - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Set the name of the attribute in the value class object that is also the primary key of the BackingMap.
setProperties(String) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
Sets additional properties namely a user name and password.
setProperties(String) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
Sets additional properties namely the subject type.
setProperties(String) - Method in interface com.ibm.websphere.objectgrid.security.plugins.CredentialGenerator
Set the user defined properties to the factory.
setProtocol(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the SSL protocol for this SSL configuration.
setQueryConfig(QueryConfig) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Set the QueryConfig object for this ObjectGrid.
setReadOnly(boolean) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the map type of this BackingMap.
setRelationshipField(String) - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Set the name of the attribute in the source class that references the key of the target class.
setReplicationGroup(int) - Method in exception com.ibm.websphere.objectgrid.UnavailableServiceException
Sets the replication group identifier for this exception.
setRequestRetryTimeout(long) - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Set the request retry timeout to indicate how long to retry a request (in milliseconds) when recoverable failures occur, such as fail-over exceptions.
setRequestRetryTimeout(long) - Method in interface com.ibm.websphere.objectgrid.Session
Set the request retry timeout to indicate how long to retry a request (in milliseconds) when recoverable failures occur, such as fail-over exceptions.
setSecurityEnabled() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Enables the ObjectGrid security.
setSecurityEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Sets whether or not security is enabled for this client security configuration.
setSessionHandle(SessionHandle) - Method in interface com.ibm.websphere.objectgrid.Session
Apply a SessionHandle to this session.
setSingleSignOnEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Sets whether or not single sign on is enabled for this client security configuration.
setSleepTime(int) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
Sets the sleep time to use in seconds.
setSleepTime(int) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
Sets the sleep time to use in seconds.
setSourceClass(String) - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Set the name of the class representing the source of a relationship.
setSSLConfiguration(SSLConfiguration) - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Sets the SSLConfiguration object associated with this client security configuration.
setStatsSpec(String) - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Set the statistics specification for the server.
setSubjectSource(SubjectSource) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the SubjectSource plugin.
setSubjectValidation(SubjectValidation) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the SubjectValidation for this ObjectGrid instance.
setTargetClass(String) - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Set the name of the class representing the target of a relationship.
setTimeBasedDBUpdateConfig(TimeBasedDBUpdateConfig) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Set the time-based database update configuration object.
setTimeToLive(int) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets "time to live" of each map entry in seconds.
setTimeToLive(int) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Sets "time to live" of each BackingMap entry in seconds.
setTimeToLive(int) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Establishes the number of seconds that any given cache entry can live for, which is refered to as "time to live" or TTL.
setTimeToLive(int) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Establishes the number of seconds that any given cache entry can live for, which is referred to as "time to live" or TTL.
setTraceEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Enables or disables ObjectGrid trace for the JVM.
setTraceFileName(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Sets the trace output to go to a file instead of System.out.
setTraceSpec(String) - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Set the trace specification for the server.
setTraceSpecification(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Set the trace specification for the current JVM.
setTransactionCallback(TransactionCallback) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the TransactionCallback object.
setTransactionIsolation(int) - Method in interface com.ibm.websphere.objectgrid.Session
Attempts to change the transaction isolation level for this session.
setTransactionTimeout(int) - Method in interface com.ibm.websphere.objectgrid.Session
Sets the transaction timeout for the next transaction started by this Session object to a specified number of seconds.
setTransactionType(String) - Method in interface com.ibm.websphere.objectgrid.Session
Sets the transaction type for future transactions.
setTransportType(int) - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Sets the transport type for this client security configuration.
setTrustStore(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the trust store file path name for this SSL configuration.
setTrustStorePassword(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the password of the trust store for this SSL configuration.
setTrustStoreType(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the type of the trust store for this SSL configuration.
setTtlEvictorType(TTLType) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets how expiration time of a BackingMap entry is computed.
setTtlEvictorType(TTLType) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Set the "time to live" Evictor type for this BackingMapConfiguration.
setTxIsolation(int) - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Sets the default transaction isolation level for all sessions created by the ObjectGrid.
setTxIsolation(int) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the default transaction isolation level for all sessions created by the ObjectGrid.
setTxTimeout(int) - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Sets the transaction timeout
setTxTimeout(int) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the transaction timeout value to a specified number of seconds.
setType(int) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
Sets the subject type, either RUN_AS_SUBJECT or CALLER_SUBJECT.
setUserName(String) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
Sets the user name for this credential.
setValue(String) - Method in interface com.ibm.websphere.objectgrid.config.ConfigProperty
Set the value of this ConfigProperty.
setValueClass(String) - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Set the type of object that is stored in the BackingMap.
setVersionedValue(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Used to update the versioned object after an update of map entry occurs.
setWriteBehind(String) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Enable write-behind updates for this map.
SHARD_ALREADY_RESERVED - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
SHARD_ALREADY_RESERVED indicates that the shard is already reserved elsewhere and cannot be reserved on the specified container.
SHARD_NOT_RESERVED_ON_CONTAINER - Static variable in interface com.ibm.websphere.objectgrid.management.ContainerMBean
SHARD_NOT_RESERVED_ON_CONTAINER indicates that the attempt to release the shard from the requesting container failed because the specified shard was not found to be reserved by the requesting container.
shardActivated(ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventGroup.ShardEvents
This is called when a shard is promoted to a primary.
shardDeactivate(ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventGroup.ShardEvents
This is called when a primary shard is demoted to a replica.
ShardMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to perform operations on and get status from a shard running in a dynamic environment.
SHORT_JAVA_LANG - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.SHORT_JAVA_LANG can be used to set a property of type java.lang.Short on a plugin.
SHORT_PRIM - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.SHORT_PRIM can be used to set a property of type short on a plugin.
size() - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.
size() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns the total number of LogElements within this LogSequence.
SLOT_NAME - Static variable in interface com.ibm.websphere.objectgrid.TxID
All slots should be reserved using this name.
SNAPSHOT_REPLICATION - Static variable in interface com.ibm.websphere.objectgrid.ClientReplicableMap
Snapshot replication mode.
SpringLocalTxManager - Interface in com.ibm.websphere.objectgrid.spring
This interface has the methods for interacting with the ObjectGrid Spring LocalTransactionManager.
SSL_REQUIRED - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant indicating SSL transport is required.
SSL_REQUIRED_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for value SSL-Required indicating SSL transport type is required.
SSL_SUPPORTED - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant indicating SSL transport is supported.
SSL_SUPPORTED_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for value SSL-Supported indicating SSL transport type is supported.
SSLConfiguration - Interface in com.ibm.websphere.objectgrid.security.config
This interface represents an SSL Configuration.
StateManager - Interface in com.ibm.websphere.objectgrid
The StateManager can be used to retrieve the availability state of an ObjectGrid.
stopServer() - Method in interface com.ibm.websphere.objectgrid.management.ServerMBean
Stops the server associated with this MBean.
STRING_JAVA_LANG - Static variable in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
ConfigPropertyType.STRING_JAVA_LANG can be used to set a property of type java.lang.String on a plugin.
SUPPORTED_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for value Supported indicating an option is supported.
suspendBalancing(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Prevent future balancing attempts for a specific map set.
swapWithPrimary() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Causes this shard to swap roles with the primary shard for the partition.
SYNCHRONOUS_REPLICA - Static variable in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Constant representing a synchronous replica shard type.

T

TargetNotAvailableException - Exception in com.ibm.websphere.objectgrid
A TargetNotAvailableException indicates the ObjectGrid target is not available.
TargetNotAvailableException() - Constructor for exception com.ibm.websphere.objectgrid.TargetNotAvailableException
Constructs a new TargetNotAvailableException with null as its detail message.
TargetNotAvailableException(String) - Constructor for exception com.ibm.websphere.objectgrid.TargetNotAvailableException
Constructs a new TargetNotAvailableException with the specified detail message.
TargetNotAvailableException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.TargetNotAvailableException
Constructs a new TargetNotAvailableException with a specified cause.
TargetNotAvailableException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.TargetNotAvailableException
Constructs a new TargetNotAvailableException with the specified detail message and cause.
TCP_IP - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
Constant indicating TCP/IP is the only supported transport.
TCPIP_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for value TCP/IP indicating a transport type of TCP/IP is used.
teardown() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Tears down and stops the container in a way to allow partitions to be moved to new locations.
tearDownServers(String[]) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Each of the container servers that are passed into this method will be stopped.
terminate() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Terminates a container without coordinating partition movement, partitions will failover.
ThreadPoolMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows user to access the thread pool properties.
toString() - Method in class com.ibm.websphere.objectgrid.AvailabilityState
 
toString() - Method in class com.ibm.websphere.objectgrid.ClientReplicableMap.Mode
 
toString() - Method in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
 
toString() - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
 
toString() - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
 
toString() - Method in class com.ibm.websphere.objectgrid.CopyMode
Returns a string representation of the CopyMode.
toString() - Method in class com.ibm.websphere.objectgrid.LockStrategy
Returns a string representation of the LockStrategy.
toString() - Method in class com.ibm.websphere.objectgrid.plugins.LogElement.Type
 
toString() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
 
toString() - Method in class com.ibm.websphere.objectgrid.TTLType
Returns a string representation of the TTLType.
touch(Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Updates the last access time in the BackingMap without retrieving the value to the JavaMap.
touch(Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
touch(Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Updates the last access time in the BackingMap without retrieving the value to the ObjectMap.
touch(Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
TOUCH - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the TOUCH operation.
TRANSACTION_CALLBACK - Static variable in interface com.ibm.websphere.objectgrid.config.PluginType
PluginType.TRANSACTION_CALLBACK can be used to attach a TransactionCallback plugin to an ObjectGrid.
TRANSACTION_NO_TIMEOUT - Static variable in interface com.ibm.websphere.objectgrid.Session
A special value for the timeout parameter of the setTransactionTimeout(int) method.
TRANSACTION_READ_COMMITTED - Static variable in interface com.ibm.websphere.objectgrid.Session
A transaction isolation level constant indicating that dirty reads are prevented; non-repeatable reads and phantom reads can occur.
TRANSACTION_READ_UNCOMMITTED - Static variable in interface com.ibm.websphere.objectgrid.Session
A transaction isolation level constant indicating that dirty reads, non-repeatable reads and phantom reads can occur.
TRANSACTION_REPEATABLE_READ - Static variable in interface com.ibm.websphere.objectgrid.Session
A transaction isolation level constant indicating that dirty reads and non-repeatable reads are prevented; phantom reads can occur.
TRANSACTION_TYPE_DEFAULT - Static variable in interface com.ibm.websphere.objectgrid.Session
A string indicating the default transaction type
TransactionAffinityException - Exception in com.ibm.websphere.objectgrid
This exception is thrown for inflight transaction when server fails over.
TransactionAffinityException() - Constructor for exception com.ibm.websphere.objectgrid.TransactionAffinityException
Constructs a new TransactionAffinityException with null as its detail message.
TransactionAffinityException(String) - Constructor for exception com.ibm.websphere.objectgrid.TransactionAffinityException
Constructs a new TransactionAffinityException with the specified detail message.
TransactionAffinityException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.TransactionAffinityException
Constructs a new TransactionAffinityException with the specified detail message and cause.
TransactionAffinityException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.TransactionAffinityException
Constructs a new TransactionAffinityException with a specified cause.
TransactionAlreadyActiveException - Exception in com.ibm.websphere.objectgrid
An exception indicating a transaction is already active for the current session.
TransactionAlreadyActiveException() - Constructor for exception com.ibm.websphere.objectgrid.TransactionAlreadyActiveException
Constructs a new TransactionAlreadyActiveException with null as its detail message.
TransactionAlreadyActiveException(String) - Constructor for exception com.ibm.websphere.objectgrid.TransactionAlreadyActiveException
Constructs a new TransactionAlreadyActiveException with the specified detail message.
TransactionAlreadyActiveException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.TransactionAlreadyActiveException
Constructs a new TransactionAlreadyActiveException with a specified cause.
TransactionAlreadyActiveException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.TransactionAlreadyActiveException
Constructs a new TransactionAlreadyActiveException with the specified detail message and cause.
transactionBegin(String, boolean) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventGroup.TransactionEvents
Signals the beginning of a Session transaction.
transactionBegin(String, boolean) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventListener
Signals the beginning of a Session transaction.
TransactionCallback - Interface in com.ibm.websphere.objectgrid.plugins
Calling methods on a Session will send corresponding events to the TransactionCallback.
TransactionCallback.BeforeCommit - Interface in com.ibm.websphere.objectgrid.plugins
The BeforeCommit optional mix-in interface for the TransactionCallback plug-in interface allows plug-ins to be notified at the beginning of a Session.commit().
TransactionCallback.BeforeCommit.TransactionContext - Interface in com.ibm.websphere.objectgrid.plugins
The TransactionContext identifies various information that's available to the beforeCommit() method.
TransactionCallbackException - Exception in com.ibm.websphere.objectgrid.plugins
This exception is thrown when a method call to TransactionCallback fails.
TransactionCallbackException() - Constructor for exception com.ibm.websphere.objectgrid.plugins.TransactionCallbackException
Constructs a new TransactionCallbackException with null as its detail message.
TransactionCallbackException(String) - Constructor for exception com.ibm.websphere.objectgrid.plugins.TransactionCallbackException
Constructs a new TransactionCallbackException with the specified detail message.
TransactionCallbackException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.TransactionCallbackException
Constructs a new TransactionCallbackException with the specified detail message and cause.
TransactionCallbackException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.TransactionCallbackException
Constructs a new TransactionCallbackException with a specified cause.
transactionEnd(String, boolean, boolean, Collection) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventGroup.TransactionEvents
Signals the ending of a Session transaction.
transactionEnd(String, boolean, boolean, Collection) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventListener
Signals the ending of a Session transaction.
TransactionException - Exception in com.ibm.websphere.objectgrid
A general transaction exception indicating something went wrong with a transaction.
TransactionException(String, boolean) - Constructor for exception com.ibm.websphere.objectgrid.TransactionException
Constructs a new TransactionException with the specified detail message and a special indication of whether the transaction was rolled back as a result of this exception.
TransactionException(Throwable, boolean) - Constructor for exception com.ibm.websphere.objectgrid.TransactionException
Constructs a new TransactionException with a specified cause and a specified indication of whether the transaction was rolled back as a result of this exception.
TransactionException(TransactionException, boolean) - Constructor for exception com.ibm.websphere.objectgrid.TransactionException
Constructs a new TransactionException with a specified cause and a specified indication of whether the transaction was rolled back as a result of this exception.
TransactionException(String, Throwable, boolean) - Constructor for exception com.ibm.websphere.objectgrid.TransactionException
Constructs a new TransactionException with the specified detail message, cause, and indication of whether the transaction was rolled back as a result of this exception.
TransactionException(String, TransactionException, boolean) - Constructor for exception com.ibm.websphere.objectgrid.TransactionException
Constructs a new TransactionException with the specified detail message, cause, and indication of whether the transaction was rolled back as a result of this exception.
TransactionQuiesceException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when partition/shard/mapset/replication group/ replication group member/server/cluster/objectgrid is entered quiesce process for various reasons such as shard movement, partition relocation, system update, server shutdown, and others.
TransactionQuiesceException() - Constructor for exception com.ibm.websphere.objectgrid.TransactionQuiesceException
Constructs a new TransactionQuiesceException with null as its detail message.
TransactionQuiesceException(String) - Constructor for exception com.ibm.websphere.objectgrid.TransactionQuiesceException
Constructs a new TransactionQuiesceException with the specified detail message.
transactionTimedOut() - Method in interface com.ibm.websphere.objectgrid.Session
Determines whether the current session transaction has timed out.
TransactionTimeoutException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when a transaction exceeds the transaction timeout that was specified on the ObjectGrid or Session.
TransactionTimeoutException(String, String) - Constructor for exception com.ibm.websphere.objectgrid.TransactionTimeoutException
Constructs a new TransactionTimeoutException with the specified detail message.
triggerPlacement(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Placement normally occurs implicitly after an event such as an ObjectGrid container starting or stopping.
TTL_FOREVER - Static variable in interface com.ibm.websphere.objectgrid.ObjectMap
A constant indicating the time-to-live value is "forever".
TTLType - Class in com.ibm.websphere.objectgrid
Every BackingMap in ObjectGrid has a built in timed based evictor that is referred to as "time to live" evictor or TTL evictor.
TxID - Interface in com.ibm.websphere.objectgrid
This interface is an opaque identifier for a transaction.
TYPE_INACTIVE - Static variable in interface com.ibm.websphere.objectgrid.management.ShardMBean
Indicates the shard type is the inactive role.
TYPE_PRIMARY - Static variable in interface com.ibm.websphere.objectgrid.management.ShardMBean
Indicates the shard type is the primary role.
TYPE_REPLICA_ASYNCHRONOUS - Static variable in interface com.ibm.websphere.objectgrid.management.ShardMBean
Indicates the shard type is the asynchronous replica role.
TYPE_REPLICA_SYNCHRONOUS - Static variable in interface com.ibm.websphere.objectgrid.management.ShardMBean
Indicates the shard type is the synchronous replica role.

U

UnavailableServiceException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when all servers are dead or when all services are unavailable even though servers are running.
UnavailableServiceException() - Constructor for exception com.ibm.websphere.objectgrid.UnavailableServiceException
Constructs a new UnavailableServiceException with null as its detail message.
UnavailableServiceException(String) - Constructor for exception com.ibm.websphere.objectgrid.UnavailableServiceException
Constructs a new UnavailableServiceException with the specified detail message.
UnavailableServiceException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.UnavailableServiceException
Constructs a new UnavailableServiceException with the specified detail message and cause.
UnavailableServiceException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.UnavailableServiceException
Constructs a new UnavailableServiceException with a specified cause.
UndefinedMapException - Exception in com.ibm.websphere.objectgrid
This exception indicates that the map which an application tries to access is not defined in the ObjectGrid.
UndefinedMapException() - Constructor for exception com.ibm.websphere.objectgrid.UndefinedMapException
Constructs a new UndefinedMapException with null as its detail message.
UndefinedMapException(String) - Constructor for exception com.ibm.websphere.objectgrid.UndefinedMapException
Constructs a new UndefinedMapException with the specified detail message.
UndefinedMapException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.UndefinedMapException
Constructs a new UndefinedMapException with the specified detail message and cause.
UndefinedMapException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.UndefinedMapException
Constructs a new UndefinedMapException with a specified cause.
UNDO_BEFORE_IMAGE_KEYWORDS - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the UNDO action to remove new keyword associations that were introduced in this LogElement.
UNDO_NOT_NEEDED - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents an UNDO action is NOT required for this LogElement.
UNKNOWN - Static variable in class com.ibm.websphere.objectgrid.AvailabilityState
An AvailabilityState.UNKNOWN indicates that the availability state of the shard could not be determined.
UNKNOWN - Static variable in exception com.ibm.websphere.objectgrid.ConnectException
This failure code indicates the reason for the connect failure is unknown.
update(Object, Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Performs an explicit update of a given entry.
update(Object, Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Deprecated. Use Index or query function to get Objects with specific attributes
update(Object, Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Performs an explicit update of a given entry.
update(Object, Object, Serializable) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Deprecated. Use Index or query function to get Objects with specific attributes
UPDATE - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the UPDATE operation.
USE_DEFAULT - Static variable in interface com.ibm.websphere.objectgrid.ObjectMap
A constant indicating the time-to-live value or lock timeout value is the default setting.
UserPasswordCredential - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class represents a credential containing a user ID and password.
UserPasswordCredential(String, String) - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
Creates a UserPasswordCredential with the specified user name and password.
UserPasswordCredentialGenerator - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This credential generator creates UserPasswordCredential objects.
UserPasswordCredentialGenerator() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
Creates a UserPasswordCredentialGenerator with no user name or password.
UserPasswordCredentialGenerator(String, String) - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
Creates a UserPasswordCredentialGenerator with a specified user name and password

V

ValueProxyInfo - Interface in com.ibm.websphere.objectgrid.plugins
This interface can be used by value objects to inform a BackingMap or Loader which attribute(s) have been dirtied.
values() - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.

W

wasTransactionRolledBack() - Method in exception com.ibm.websphere.objectgrid.TransactionException
Returns true if the transaction was rolled back.
WebSphereTransactionCallback - Class in com.ibm.websphere.objectgrid.plugins.builtins
A TransactionCallback plugin used to automatically enlist the ObjectGrid transaction as a volatile participant in a WebSphere JTA transaction.
WebSphereTransactionCallback() - Constructor for class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
The default constructor.
whenOccurred() - Method in exception com.ibm.websphere.objectgrid.TransactionTimeoutException
Gives the time when this TransactionTimeoutException was created.
WSTokenCredential - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class represents a WebSphere Application Server security token credential.
WSTokenCredential(byte[], byte[]) - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredential
Creates a new WebSphere token credential with the specified security tokens.
WSTokenCredentialGenerator - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class represents a credential generator when running in WebSphere Application Server.
WSTokenCredentialGenerator() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
Creates a new WSTokenCredentialGenerator with a default runAs subject type.
WSTokenCredentialGenerator(int) - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
Creates a new WSTokenCredentialGenerator with the specified subject type.

A B C D E F G H I J K L M N O P Q R S T U V W
IBM WebSphere® DataPower® XC10 Appliance
Release 2.0 Client API Specification

© Copyright International Business Machines Corp 2005,2011. All rights reserved.