IBM WebSphereTM eXtreme Scale, Release 8.6
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 X Z

A

abort() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
Indicates the user is not accepted
abort() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPLoginModule
Deprecated. Called if the LoginContext's overall authentication failed.
abort() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleLDAPLoginModule
 
AbstractCQFilter<KeyType,ValueType,AttributeType,MatchType> - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This is an abstract class which all continuous query filters must extend.
AbstractCQFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.AbstractCQFilter
 
accept(LogElement) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
This is used to filter the LogElements written to each message.
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.
AccessType - Enum in com.ibm.websphere.projector.annotations
Overrides or explicitly defines the the method in which the persistence layer accesses the entity's persistent state.
AccessType - Class in com.ibm.websphere.projector.md
The method in which the persistent state of an entity is accessed.
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.
ActiveCountStatistic - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a CountStatistic object which also provides the count changes in the last period.
ActiveLongStatistic - Interface in com.ibm.websphere.objectgrid.stats
This interface is used for gathering long type statistic data for a certain time period.
ActiveTimeStatistic - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a TimeStatistic object which also provides the number of time data being added in the last period.
add(long) - Method in interface com.ibm.websphere.objectgrid.stats.TimeStatistic
Adds a time value to this statistic.
addAssociationKey(int, Tuple) - Method in interface com.ibm.websphere.projector.Tuple
Add a single association key for an association.
addAssociationKeys(int, Tuple[]) - Method in interface com.ibm.websphere.projector.Tuple
Add multiple association keys for an association.
addBackingMapConfiguration(BackingMapConfiguration) - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Add a BackingMapConfiguration to this ObjectGridConfiguration.
addChild(StatsFact) - Method in interface com.ibm.websphere.objectgrid.stats.StatsGroup
Adds a child to this group.
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.
addListener(ContinuousQueryListener<KeyType, ValueType>) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryTopic
Add a Continuous Query Listener to this topic.
addMap(BackingMapConfiguration) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Add a BackingMapConfiguration to this MapSet.
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.
addMapSet(MapSet) - Method in interface com.ibm.websphere.objectgrid.deployment.ObjectGridDeployment
Add a MapSet to this ObjectGridDeployment.
addObjectGridDeployment(ObjectGridDeployment) - Method in interface com.ibm.websphere.objectgrid.deployment.DeploymentPolicy
Add an ObjectGridDeployment to this DeploymentPolicy.
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
addShardMapping(ShardMapping) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Add a ShardMapping to this MapSet.
addZone(String) - Method in interface com.ibm.websphere.objectgrid.deployment.ZoneRule
Add a zone to this ZoneRule
afterPropertiesSet() - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
Initializes this cache.
afterPropertiesSet() - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCatalogServiceDomainBean
Initializes the connection to the Catalog Service Domain.
afterPropertiesSet() - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridClientBean
Initializes the client bean.
AGENT_ALL - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for all of the AgentManager agent and entity query statistics
AGENT_ALL_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for all of the AgentManager agent and entity query statistics
AgentManager - Interface in com.ibm.websphere.objectgrid.datagrid
The AgentManager is the primary interface for submitting MapGridAgent or ReduceGridAgent instances to the ObjectGrid.
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.
AgentPermission - Class in com.ibm.websphere.objectgrid.security
This class represents permissions to the datagrid agents.
AgentPermission(String, String) - Constructor for class com.ibm.websphere.objectgrid.security.AgentPermission
Constructs a new AgentPermission for the named map with the specified actions.
AgentPermission(String, String, String) - Constructor for class com.ibm.websphere.objectgrid.security.AgentPermission
Constructs a new AgentPermission for the named map with the specified actions.
AgentStatsModule - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a statistic module for an Agent.
ALL - Static variable in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Constant representing a all shard types
ALL - Static variable in class com.ibm.websphere.objectgrid.security.MapPermission
All permission constant
ALL - Static variable in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
All permission constant
ALL - Static variable in class com.ibm.websphere.objectgrid.security.ServerMapPermission
All permission constant
ALL - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for all of the statistics
ALL_PERMISSION - Static variable in class com.ibm.websphere.objectgrid.security.MapPermission
All permissions String
ALL_PERMISSION - Static variable in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
All permissions String
ALL_PERMISSION - Static variable in class com.ibm.websphere.objectgrid.security.ServerMapPermission
All permissions String
ALL_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for all of the statistics
AndFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This filter returns true if and only if all its child filters are true.
AndFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.AndFilter
 
AndFilter(ContinuousQueryFilter...) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.AndFilter
Construct a filter which will pass only if all child filters pass.
ANONYMOUS_NAME - Static variable in class com.ibm.websphere.objectgrid.security.AnonymousPrincipal
A string representing the anonymous user's name.
AnonymousPrincipal - Class in com.ibm.websphere.objectgrid.security
This Principal class represents an anonymous user.
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.
applyContext(DataObjectContext) - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectContextAware
Apply a non-null DataObjectContext to this object.
arbitrateCollision(CollisionData) - Method in interface com.ibm.websphere.objectgrid.revision.CollisionArbiter
Indicates that a revision event has discovered a write operation has occurred on two primaries simultaneously.
Association - Interface in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
An association between two maps.
AssociationType - Class in com.ibm.websphere.projector.md
The type of relationship or association between entities.
ASYNCHRONOUS_REPLICA - Static variable in class com.ibm.websphere.objectgrid.deployment.ShardType
Represents an asynchronous replica shard.
ASYNCHRONOUS_REPLICA - Static variable in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Constant representing an asynchronous replica shard type.
Attribute - Interface in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
Identifies an attribute.
attributePath - Variable in class com.ibm.websphere.objectgrid.continuousquery.filter.CompareFilter
 
AttributeType - Enum in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
Identifies all types that can be set on an Attribute.
authenticate(Credential) - Method in interface com.ibm.websphere.objectgrid.security.plugins.Authenticator
Authenticates a user represented by the credential object.
authenticate(Credential) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.CertificateMappingAuthenticator
Deprecated. Authenticates a ClientCertificateCredential.
authenticate(Credential) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginAuthenticator
Authenticates a UserPasswordCredential.
authenticate(Credential) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPAuthenticator
Authenticates a UserPasswordCredential.
authenticate(String, String) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPAuthenticatorHelper
Deprecated. Authenticates the user to the LDAP directory.
authenticate(Credential) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenAuthenticator
Authenticates the WSTokenCredential and returns a Subject object.
Authenticator - Interface in com.ibm.websphere.objectgrid.security.plugins
This plugin can be used to authenticate an ObjectGrid client to an ObjectGrid server based on the credential provided by the client.
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
AUTO - Static variable in class com.ibm.websphere.objectgrid.em.FlushModeType
The persistent context is automatically flushed prior to running the query.
AvailabilityException - Exception in com.ibm.websphere.objectgrid
An AvailabilityException is thrown when a target is not in the proper state to handle a request that it receives.
AvailabilityException() - Constructor for exception com.ibm.websphere.objectgrid.AvailabilityException
Constructs a new AvailabilityException with null as its detail message.
AvailabilityException(String) - Constructor for exception com.ibm.websphere.objectgrid.AvailabilityException
Constructs a new AvailabilityException with the specified detail message.
AvailabilityException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.AvailabilityException
Constructs a new AvailabilityException with the specified detail message and cause.
AvailabilityException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.AvailabilityException
Constructs a new AvailabilityException with a specified cause.
AvailabilityState - Class in com.ibm.websphere.objectgrid
Each shard in a distributed ObjectGrid has an availability state associated with it.
AvailabilityTransitionException - Exception in com.ibm.websphere.objectgrid
An AvailabilityTransitionException is thrown when an error is encountered while trying to place a target into a new availability state.
AvailabilityTransitionException() - Constructor for exception com.ibm.websphere.objectgrid.AvailabilityTransitionException
Constructs a new AvailabilityTransitionException with null as its detail message.
AvailabilityTransitionException(String) - Constructor for exception com.ibm.websphere.objectgrid.AvailabilityTransitionException
Constructs a new AvailabilityTransitionException with the specified detail message.
AvailabilityTransitionException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.AvailabilityTransitionException
Constructs a new AvailabilityTransitionException with the specified detail message and cause.
AvailabilityTransitionException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.AvailabilityTransitionException
Constructs a new AvailabilityTransitionException with a specified cause.

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.
BackingMapLifecycleListener - Interface in com.ibm.websphere.objectgrid.plugins
Listener for BackingMap life cycle events.
BackingMapLifecycleListener.LifecycleEvent - Interface in com.ibm.websphere.objectgrid.plugins
The LifecycleEvent describes the situation that caused a change in the lifecycle of the BackingMap.
BackingMapLifecycleListener.State - Enum in com.ibm.websphere.objectgrid.plugins
The state of a BackingMap's life cycle.
BackingMapPlugin - Interface in com.ibm.websphere.objectgrid.plugins
BackingMap plug-ins implement this interface to be invoked when the plug-in should be initialized and destroyed.
backingMapStateChanged(BackingMapLifecycleListener.LifecycleEvent) - Method in interface com.ibm.websphere.objectgrid.plugins.BackingMapLifecycleListener
Invoked when there is a change to the BackingMap's life cycle.
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.
Basic - Annotation Type in com.ibm.websphere.projector.annotations
Identifies a field or method as a basic persistable attribute.
BasicMapSerializerPlugin - Class in com.ibm.websphere.objectgrid.plugins.io
A basic implementation of a MapSerializerPlugin plug-in that can reference an arbitrary KeyDataSerializer and ValueDataSerializer.
BasicMapSerializerPlugin() - Constructor for class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Default constructor.
BasicMapSerializerPlugin(KeySerializerPlugin, ValueSerializerPlugin) - Constructor for class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Constructor that sets a KeySerializerPlugin and ValueSerializerPlugin.
batchUpdate(TxID, LogSequence) - Method in class com.ibm.websphere.objectgrid.jpa.JPAEntityLoader
Write the data from ObjectGrid entity maps to JPA.
batchUpdate(TxID, LogSequence) - Method in class com.ibm.websphere.objectgrid.jpa.JPALoader
Write the data from ObjectGrid entity maps to JPA.
batchUpdate(TxID, LogSequence) - Method in interface com.ibm.websphere.objectgrid.plugins.Loader
Called to tell the Loader to write the provided changes to the backend.
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() - Method in interface com.ibm.websphere.objectgrid.em.EntityTransaction
Begin a new transaction.
begin(TxID) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
This method is called when the ObjectGrid transaction is started.
begin(TxID) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
Deprecated.  
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.
BinaryLogicalFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This is a base class used for binary logic operations.
BinaryLogicalFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.BinaryLogicalFilter
 
BinaryLogicalFilter(ContinuousQueryFilter...) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.BinaryLogicalFilter
Construct a filter which will perform a boolean operation on a set of filters
BluePrintServiceFactory - Class in com.ibm.websphere.objectgrid.plugins.osgi
A built-in BluePrint implementation of the PluginServiceFactory.
BluePrintServiceFactory() - Constructor for class com.ibm.websphere.objectgrid.plugins.osgi.BluePrintServiceFactory
Default Constructor
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.
buildCache(String, Properties) - Method in class com.ibm.websphere.objectgrid.hibernate.cache.ObjectGridHibernateCacheProvider
 
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.
cacheUpdated(ContinuousQueryNotificationEvent<KeyType, ValueType>) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryListener
This method will be called by every ContinuousQueryTopic that this listener is added to.
CALLER_SUBJECT - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSSubjectSourceImpl
A constant representing the caller Subject type
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
callMapAgent(MapGridAgent, Collection) - Method in interface com.ibm.websphere.objectgrid.datagrid.AgentManager
Routes the MapGridAgent instance and invokes the MapGridAgent.process(com.ibm.websphere.objectgrid.Session, ObjectMap, Object) method on each ObjectGrid server partition associated with the input keys and returns each result key and value in a Map.
callMapAgent(MapGridAgent) - Method in interface com.ibm.websphere.objectgrid.datagrid.AgentManager
Routes the MapGridAgent instance and invokes the MapGridAgent.processAllEntries(com.ibm.websphere.objectgrid.Session, ObjectMap) method on all ObjectGrid server partitions and returns each result key and value in a map.
callReduceAgent(ReduceGridAgent, Collection) - Method in interface com.ibm.websphere.objectgrid.datagrid.AgentManager
This method performs a multi-level reduce operation on data in a map.
callReduceAgent(ReduceGridAgent) - Method in interface com.ibm.websphere.objectgrid.datagrid.AgentManager
This performs performs a multi-level reduce operation on data in a map.
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.
CascadeType - Enum in com.ibm.websphere.projector.annotations
Identifies the various relationship cascade options that can be used with the entity association annotations.
CatalogDomainInfo - Interface in com.ibm.websphere.objectgrid
Identifies the configuration attributes of a catalog service domain.
CatalogDomainManager - Interface in com.ibm.websphere.objectgrid
Provides access to catalog domain configuration information for the current environment.
CatalogNetworkPartitioningException - Exception in com.ibm.websphere.objectgrid
This exception is used to indicate that the catalog servers are partitioned into different groups
CatalogNetworkPartitioningException() - Constructor for exception com.ibm.websphere.objectgrid.CatalogNetworkPartitioningException
Constructs a new CatalogNetworkPartitionException with null as its detail message.
CatalogServerProperties - Interface in com.ibm.websphere.objectgrid.server
Defines a set of properties to be used at initialization by the ObjectGrid server runtime.
CatalogServiceManagementMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows user to manipulate the behaviors of heartbeat and leader manager and other catalog service specific actions.
CertificateMappingAuthenticator - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
Deprecated. This plug-in is deprecated in version 8.6. Use the LDAPAuthenticator, the KeyStoreLoginAuthenticator, or a custom Authenticator.
CertificateMappingAuthenticator() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.CertificateMappingAuthenticator
Deprecated. Creates a new CertificateMappingAuthenicator.
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.
checkFFDCNotification() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Triggers a simulated exception to be captured as a first-failure data capture (FFDC) event (and subsequently broadcasted as a JMX notification), as a means to test and verify the monitoring being enabled on the server.
checkLoggingNotification() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Generates a set of log records with various severity levels, providing a simple means to test and verify when the JMX notification monitoring being enabled on the grid server.
checkPermission(Subject, Permission) - Method in interface com.ibm.websphere.objectgrid.security.plugins.ObjectGridAuthorization
Checks whether or not the Principals represented by the specified Subject has the specified Permission.
checkPreloadStatus(Session, BackingMap) - Method in interface com.ibm.websphere.objectgrid.plugins.ReplicaPreloadController
Called when a replica is promoted to primary.
checkServiceAvailability(String, Integer) - Method in interface com.ibm.websphere.objectgrid.management.ServerOSGiMBean
Checks if the specified OSGi service and ranking is available or not.
ClassAlias - Annotation Type in com.ibm.websphere.objectgrid.plugins.io.annotations
Specifies the class alias that you can use to correlate different class names that have the same class alias.
clear() - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Clear the EntityManager's context.
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.
clear() - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
Clears all entries from the cache.
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.
clearInternal() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Clear all maps for a PU.
clearInternal() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Clear the query cache
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_AS_DUAL_ROLES_MODEL_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setInvalidationModel(String) method for setting invalidationModel as CLIENT_AS_DUAL_ROLES_MODEL.
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.
CLIENT_SERVER_MODEL_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setInvalidationModel(String) method for setting invalidationModel as CLIENT_SERVER_MODEL.
ClientCertificateCredential - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class represents a credential which contains a SSL client certificate chain.
ClientCertificateCredential(Certificate[]) - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.ClientCertificateCredential
Creates a new ClientCertificateCredential using the specified certificates.
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.
ClientLoadCallback - Interface in com.ibm.websphere.objectgrid.jpa
A ClientLoadCallback instance receives notifications when a ClientLoader starts and finishes.
ClientLoader - Interface in com.ibm.websphere.objectgrid.jpa
A client loader loads data into ObjectGrid maps.
ClientLoaderFactory - Class in com.ibm.websphere.objectgrid.jpa
A factory used for client loader purpose.
ClientLoaderFactory() - Constructor for class com.ibm.websphere.objectgrid.jpa.ClientLoaderFactory
 
ClientProperties - Interface in com.ibm.websphere.objectgrid.client
The set of properties used to define various preference for ObjectGrid clients.
ClientReplicableMap - Interface in com.ibm.websphere.objectgrid
Deprecated. The client replicated map function is deprecated in version 8.6. Use the ContinuousQueryManager function.
ClientReplicableMap.Mode - Class in com.ibm.websphere.objectgrid
Deprecated. 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
 
ClientServerLoaderException - Exception in com.ibm.websphere.objectgrid
This exception is a base exception for any Client/Server operation exceptions.
ClientServerLoaderException() - Constructor for exception com.ibm.websphere.objectgrid.ClientServerLoaderException
Constructs a new ClientServerLoaderException with null as its detail message.
ClientServerLoaderException(String) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerLoaderException
Constructs a new ClientServerLoaderException with the specified detail message.
ClientServerLoaderException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerLoaderException
Constructs a new ClientServerLoaderException with the specified detail message and cause.
ClientServerLoaderException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerLoaderException
Constructs a new ClientServerLoaderException with a specified cause.
ClientServerMultiplePartitionWriteLoaderException - Exception in com.ibm.websphere.objectgrid
This exception is a base exception for Client/Server operations when a user attempts to write to multiple remote partitions on remote servers in the same transaction.
ClientServerMultiplePartitionWriteLoaderException() - Constructor for exception com.ibm.websphere.objectgrid.ClientServerMultiplePartitionWriteLoaderException
Constructs a new ClientServerMultiplePartitionWriteLoaderException with null as its detail message.
ClientServerMultiplePartitionWriteLoaderException(String) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerMultiplePartitionWriteLoaderException
Constructs a new ClientServerMultiplePartitionWriteLoaderException with the specified detail message.
ClientServerMultiplePartitionWriteLoaderException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerMultiplePartitionWriteLoaderException
Constructs a new ClientServerMultiplePartitionWriteLoaderException with the specified detail message and cause.
ClientServerMultiplePartitionWriteLoaderException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerMultiplePartitionWriteLoaderException
Constructs a new ClientServerMultiplePartitionWriteLoaderException with a specified cause.
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.
ClientServerTransactionCallbackException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when a method call to the Client/Server TransactionCallback encounters a remote request problem.
ClientServerTransactionCallbackException() - Constructor for exception com.ibm.websphere.objectgrid.ClientServerTransactionCallbackException
Constructs a new ClientServerTransactionCallbackException with null as its detail message.
ClientServerTransactionCallbackException(String) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerTransactionCallbackException
Constructs a new ClientServerTransactionCallbackException with the specified detail message.
ClientServerTransactionCallbackException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerTransactionCallbackException
Constructs a new ClientServerTransactionCallbackException with the specified detail message and cause.
ClientServerTransactionCallbackException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ClientServerTransactionCallbackException
Constructs a new ClientServerTransactionCallbackException with a specified cause.
clone() - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
 
close() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Close this data cache
close() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Close this query cache
close() - Method in interface com.ibm.websphere.objectgrid.Session
Closes this session, freeing all resources that are held.
close() - Method in class com.ibm.websphere.xs.ra.XSConnection
Initiates close of the connection handle at the application level.
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_LOCK - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for LOCK.
CODE_TOUCH - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for TOUCH.
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.
CODE_UPSERT - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The type code constant for UPSERT.
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.
CollisionArbiter - Interface in com.ibm.websphere.objectgrid.revision
Decides what value to store when there is a collision on multiple primaries.
CollisionArbiter.Resolution - Class in com.ibm.websphere.objectgrid.revision
Marks how the collision should be resolved.
CollisionData - Interface in com.ibm.websphere.objectgrid.revision
Holds data necessary for arbitrating collisions between entries.
COLUMN_RESYNCATTEMPTS - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
ResyncAttempts column name defined in the CompositeData returned by the getIndoubtList method
COLUMN_ROLE - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Role column name defined in the CompositeData returned by the getIndoubtList method
COLUMN_STATE - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
State column name defined in the CompositeData returned by the getIndoubtList method
COLUMN_TIMESTAMP - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Timestamp column name defined in the CompositeData returned by the getIndoubtList method
COLUMN_XID - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Xid column name defined in the CompositeData returned by the getIndoubtList method
com.ibm.websphere.objectgrid - package com.ibm.websphere.objectgrid
These are the main application APIs for the ObjectGrid.
com.ibm.websphere.objectgrid.adapter - package com.ibm.websphere.objectgrid.adapter
This package contains the interface for ObjectGrid Adaptor to WebSphere persistent manager.
com.ibm.websphere.objectgrid.catalog - package com.ibm.websphere.objectgrid.catalog
This package contains the primary interfaces and classes for the catalog service.
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.continuousquery - package com.ibm.websphere.objectgrid.continuousquery
These are the APIs for the Continuous Query feature of WebSphere eXtreme Scale.
com.ibm.websphere.objectgrid.continuousquery.exception - package com.ibm.websphere.objectgrid.continuousquery.exception
The set of Exceptions which are thrown by the Continuous Query APIs.
com.ibm.websphere.objectgrid.continuousquery.filter - package com.ibm.websphere.objectgrid.continuousquery.filter
These are the Filter implementations which are used to build continuous query definitions.
com.ibm.websphere.objectgrid.datagrid - package com.ibm.websphere.objectgrid.datagrid
This package contains the interfaces for interacting with the data grid API.
com.ibm.websphere.objectgrid.deployment - package com.ibm.websphere.objectgrid.deployment
This package contains the primary interfaces and classes for creating an ObjectGrid deployment policy programmatically.
com.ibm.websphere.objectgrid.em - package com.ibm.websphere.objectgrid.em
This package contains the primary interfaces for the EntityManager.
com.ibm.websphere.objectgrid.em.annotations - package com.ibm.websphere.objectgrid.em.annotations
This package contains all annotations specific to the ObjectGrid EntityManager API.
com.ibm.websphere.objectgrid.hibernate.cache - package com.ibm.websphere.objectgrid.hibernate.cache
This package contains the public classes for the Hibernate L2 cache plugin.
com.ibm.websphere.objectgrid.httpsession - package com.ibm.websphere.objectgrid.httpsession
This package contains classes and interfaces for ObjectGrid HTTP Session plug-in support.
com.ibm.websphere.objectgrid.io - package com.ibm.websphere.objectgrid.io
This package contains i/o streams that combines random access capability of byte buffers and primitive data handling for a more language and system neutral data model.
com.ibm.websphere.objectgrid.jpa - package com.ibm.websphere.objectgrid.jpa
This package contains the APIs used for Java Persistence API (JPA) loaders and JPA client loader.
com.ibm.websphere.objectgrid.jpa.dbupdate - package com.ibm.websphere.objectgrid.jpa.dbupdate
This package contains the APIs used for time-based database update.
com.ibm.websphere.objectgrid.jpa.dbupdate.annotation - package com.ibm.websphere.objectgrid.jpa.dbupdate.annotation
This package contains the annotation APIs used for time-based database update.
com.ibm.websphere.objectgrid.management - package com.ibm.websphere.objectgrid.management
This package contains the interfaces for all ObjectGrid MBeans.
com.ibm.websphere.objectgrid.openjpa - package com.ibm.websphere.objectgrid.openjpa
This package contains classes and interfaces for the ObjectGrid cache plugins for Apache OpenJPA.
com.ibm.websphere.objectgrid.osgi - package com.ibm.websphere.objectgrid.osgi
This package contains the interfaces and classes for querying and managing the OSGi service versions used in the WebSphere eXtreme Scale.
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.plugins.index - package com.ibm.websphere.objectgrid.plugins.index
This package contains the interfaces for the Map index related plug-in framework.
com.ibm.websphere.objectgrid.plugins.io - package com.ibm.websphere.objectgrid.plugins.io
This package contains the plug-in interfaces and classes for building customized data serializers.
com.ibm.websphere.objectgrid.plugins.io.annotations - package com.ibm.websphere.objectgrid.plugins.io.annotations
This package contains the primary Java annotation classes for supporting eXtreme Scale data serialization and de-serialization.
com.ibm.websphere.objectgrid.plugins.io.datadescriptor - package com.ibm.websphere.objectgrid.plugins.io.datadescriptor
This package contains the interfaces and classes that allow a serializer to describe describe any queryable or indexable attributes to eXtreme Scale.
com.ibm.websphere.objectgrid.plugins.io.dataobject - package com.ibm.websphere.objectgrid.plugins.io.dataobject
This package contains the interfaces and classes for interact with data objects using the ObjectMap API and plug-ins when they are in their serialized form.
com.ibm.websphere.objectgrid.plugins.osgi - package com.ibm.websphere.objectgrid.plugins.osgi
This package contains the primary interfaces for eXtreme Scale OSGi plug-ins.
com.ibm.websphere.objectgrid.query - package com.ibm.websphere.objectgrid.query
This package contains the primary interfaces for ObjectQuery API.
com.ibm.websphere.objectgrid.rest - package com.ibm.websphere.objectgrid.rest
This package contains the primary interfaces and classes for the REST data service.
com.ibm.websphere.objectgrid.revision - package com.ibm.websphere.objectgrid.revision
This package contains the interfaces for revision control of data in the grid.
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.server - package com.ibm.websphere.objectgrid.server
This package contains the primary interfaces and classes for starting ObjectGrid servers in an existing process.
com.ibm.websphere.objectgrid.spring - package com.ibm.websphere.objectgrid.spring
This package holds the Spring specific APIs for ObjectGrid.
com.ibm.websphere.objectgrid.stats - package com.ibm.websphere.objectgrid.stats
This package contains the interfaces for ObjectGrid statistic related functions.
com.ibm.websphere.objectgrid.writebehind - package com.ibm.websphere.objectgrid.writebehind
This package contains the utility classes related to write-behind support.
com.ibm.websphere.projector - package com.ibm.websphere.projector
This package contains the primary interfaces and exceptions for the Projector component.
com.ibm.websphere.projector.annotations - package com.ibm.websphere.projector.annotations
This package contains all annotations specific to the Projector.
com.ibm.websphere.projector.md - package com.ibm.websphere.projector.md
This package contains the classes and interfaces for entity metadata introspection.
com.ibm.websphere.xs.ra - package com.ibm.websphere.xs.ra
These are the eXtreme Scale Resource Adapter APIs that allows integration with a Java EE application.
com.ibm.websphere.xs.rest - package com.ibm.websphere.xs.rest
This package contains modules for the WebSphere eXtreme Scale REST Gateway
com.ibm.websphere.xs.sessionmanager - package com.ibm.websphere.xs.sessionmanager
This package contains the interfaces related to eXtreme Scale HTTP session management.
com.ibm.websphere.xsa - package com.ibm.websphere.xsa
This package contains modules for the XC10 REST Gateway.
combine(Statistic) - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Combines the value of the provided statistic with this object.
combine(StatsModule) - Method in interface com.ibm.websphere.objectgrid.stats.StatsModule
Combines the stats in this stats module with stats from another stats module.
commit() - Method in interface com.ibm.websphere.objectgrid.em.EntityTransaction
Commit the current transaction, flushing any uncommitted changes in the EntityManager's context to the cache.
COMMIT - Static variable in class com.ibm.websphere.objectgrid.em.FlushModeType
The EntityManager's context is not automatically flushed prior to running the query.
commit(TxID) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
Commit the entity manager transaction if one is enlisted in this ObjectGrid transaction.
COMMIT - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Indicates that the outcome of this transaction is to commit.
commit(String) - Method in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Heuristically commit the specified transaction at this partition.
commit(Collection, Collection, Collection, Collection) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Commits a transaction
commit(TxID) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
Deprecated.  
commit(TxID) - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback
Invoked when committing a Session transaction.
commit() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
Indicates the user is accepted.
commit() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPLoginModule
Deprecated. Called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).
commit() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleLDAPLoginModule
 
commit() - Method in interface com.ibm.websphere.objectgrid.Session
Commits a transaction.
CompareFilter<KeyType,ValueType,AttributeType,MatchType> - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This is a base class for filters comparing an attribute with a scalar.
CompareFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.CompareFilter
 
CompareFilter(String, MatchType) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.CompareFilter
Construct a filter for comparing an arbitrary object with the filtering criteria.
compareTo(Object) - Method in class com.ibm.websphere.objectgrid.plugins.LogElement.Type
 
CompositeIndex - Annotation Type in com.ibm.websphere.objectgrid.em.annotations
Used in conjunction with the CompositeIndexes annotation, the CompositeIndex annotation defines an index that has multiple attributes associated with it.
CompositeIndexes - Annotation Type in com.ibm.websphere.objectgrid.em.annotations
Defines one or more composite indexes to be used with an entity.
compressed - Variable in class com.ibm.websphere.xsa.RestValue
Deprecated. Flag to indicate if the value is compressed or not
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).
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.
CONNECTIONNAME_DEFAULT - Static variable in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
The default connection name prefix when not specified.
CONNECTIONSTATUS_CONNECTED - Static variable in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
The connection status indicating that a connection has been established.
CONNECTIONSTATUS_DISCONNECTED - Static variable in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
The connection status indicating that client is no longer connected.
Container - Interface in com.ibm.websphere.objectgrid.server
The ObjectGrid Container class hosts the set of partition shards for some ObjectGrid application.
CONTAINER_NOT_ALLOWED_IN_CUSTOM_ZONE - Static variable in exception com.ibm.websphere.objectgrid.ZoneConfigurationException
One of the error codes for this exception.
CONTAINER_NOT_ALLOWED_IN_DEFAULT_ZONE - Static variable in exception com.ibm.websphere.objectgrid.ZoneConfigurationException
One of the error codes for this exception.
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(KeyType) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryCache
Returns true if the cache contains the given key.
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(ValueType) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryCache
Returns true if the cache contains the given value.
containsValue(Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.
CONTENT_TYPE_APP_JSON - Static variable in interface com.ibm.websphere.xs.rest.RestValue
"application/json" HTML content type
CONTENT_TYPE_APP_OCTET - Static variable in interface com.ibm.websphere.xs.rest.RestValue
"application/octet-stream" HTML content type
CONTENT_TYPE_APP_XML - Static variable in interface com.ibm.websphere.xs.rest.RestValue
"application/xml" HTML content type
contentType - Variable in class com.ibm.websphere.xsa.RestValue
Deprecated. Content type of the contained value
CONTINUOUS_REPLICATION - Static variable in interface com.ibm.websphere.objectgrid.ClientReplicableMap
Deprecated. Full replication mode.
ContinuousQueryAttributePathException - Exception in com.ibm.websphere.objectgrid.continuousquery.exception
A ContinuousQueryGetValueException exception is thrown when there is problem processing the attribute path used to retrieve cache entry attribute for continuous query comparison.
ContinuousQueryAttributePathException(String, Object...) - Constructor for exception com.ibm.websphere.objectgrid.continuousquery.exception.ContinuousQueryAttributePathException
 
ContinuousQueryAttributePathException(Throwable, String, Object...) - Constructor for exception com.ibm.websphere.objectgrid.continuousquery.exception.ContinuousQueryAttributePathException
 
ContinuousQueryCache<KeyType,ValueType> - Interface in com.ibm.websphere.objectgrid.continuousquery
A Continuous Query Cache contains the keys and optionally the values that match a defined continuous query.
ContinuousQueryException - Exception in com.ibm.websphere.objectgrid.continuousquery.exception
Represents a general class of failures which can occur during Continuous Query processing.
ContinuousQueryException(String, Object...) - Constructor for exception com.ibm.websphere.objectgrid.continuousquery.exception.ContinuousQueryException
Build an exception that signals a problem when retrieving a value for comparison from an object.
ContinuousQueryException(Throwable, String, Object...) - Constructor for exception com.ibm.websphere.objectgrid.continuousquery.exception.ContinuousQueryException
Build an exception that signals a problem when retrieving a value for comparison from an object.
ContinuousQueryFilter<KeyType,ValueType,AttributeType,MatchType> - Interface in com.ibm.websphere.objectgrid.continuousquery
An interface which provides an abstraction to check if an object matches the criteria defined in a filter.
ContinuousQueryGetValueException - Exception in com.ibm.websphere.objectgrid.continuousquery.exception
A ContinuousQueryGetValueException exception is thrown when there is problem retrieving value for continuous query comparison.
ContinuousQueryGetValueException(String, Object...) - Constructor for exception com.ibm.websphere.objectgrid.continuousquery.exception.ContinuousQueryGetValueException
 
ContinuousQueryGetValueException(Throwable, String, Object...) - Constructor for exception com.ibm.websphere.objectgrid.continuousquery.exception.ContinuousQueryGetValueException
 
ContinuousQueryIncompatibleDuplicateException - Exception in com.ibm.websphere.objectgrid.continuousquery.exception
A ContinuousQueryIncompatibleDuplicateException is thrown when the continuous query being defined has the same generated name as an existing query defined on the map, but the filter chains differ.
ContinuousQueryIncompatibleDuplicateException(String, String, ContinuousQueryFilter, ContinuousQueryFilter) - Constructor for exception com.ibm.websphere.objectgrid.continuousquery.exception.ContinuousQueryIncompatibleDuplicateException
 
ContinuousQueryListener<KeyType,ValueType> - Interface in com.ibm.websphere.objectgrid.continuousquery
This interface should be implemented to get a callback for a continuous query.
ContinuousQueryManager - Interface in com.ibm.websphere.objectgrid.continuousquery
The management interface used to define new continuous queries, retrieve an existing query, or destroy a query.
ContinuousQueryManagerFactory - Class in com.ibm.websphere.objectgrid.continuousquery
A factory class for obtaining the ContinuousQueryManager.
ContinuousQueryManagerFactory() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryManagerFactory
 
ContinuousQueryNotificationEvent<KeyType,ValueType> - Interface in com.ibm.websphere.objectgrid.continuousquery
An interface which defines notification metadata that is sent to continuous query listeners when the result set of a defined continous query changes.
ContinuousQueryNotificationEvent.Reason - Enum in com.ibm.websphere.objectgrid.continuousquery
Indicates the reason a notification event has occurred for this cache entry.
ContinuousQueryTopic<KeyType,ValueType> - Interface in com.ibm.websphere.objectgrid.continuousquery
A Continuous Query Topic embodies the client side view of a defined Continuous Query.
copy() - Method in interface com.ibm.websphere.objectgrid.stats.CountStatistic
Returns a new copy of this statistic
copy() - Method in interface com.ibm.websphere.objectgrid.stats.PercentageStatistic
Returns a new copy of this statistic
copy() - Method in interface com.ibm.websphere.objectgrid.stats.StatsModule
Gets a copy of this object.
copy() - Method in interface com.ibm.websphere.objectgrid.stats.TimeStatistic
Returns a new copy of this statistic.
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.
copyKey(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectTransformer
Deprecated. Creates a copy of a key object.
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.
copyValue(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectTransformer
Deprecated. Creates a copy of a value object.
COREGROUP_MEMBERSHIP_CHANGE - Static variable in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Constant representing a core group membership change notification.
CoreGroupServiceMBean - Interface in com.ibm.websphere.objectgrid.management
Deprecated. This MBean interface is deprecated in 7.1. Use the CatalogServiceManagementMBean MBean interface.
COUNT - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
CountStatistic - Interface in com.ibm.websphere.objectgrid.stats
This interface represents statistic with a standard count measurement.
createAssociation() - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create a mutable new Association instance.
createAssociation(String, String) - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create an immutable Association instance with the minimum required values set.
createAttribute() - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create a mutable Attribute instance.
createAttribute(String, AttributeType, EmbeddedType, boolean) - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create an immutable Attribute instance.
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.
createConnectionFactory() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Creates a non-managed XSConnectionFactory instance.
createConnectionFactory(ConnectionManager) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Creates a managed XSConnectionFactory instance.
createContainer(DeploymentPolicy) - Method in interface com.ibm.websphere.objectgrid.server.Server
Instantiates an ObjectGrid container capable of hosting shards for the object grids specified in the policy.
createDeploymentPolicy(URL, URL) - Static method in class com.ibm.websphere.objectgrid.deployment.DeploymentPolicyFactory
Creates the DeploymentPolicy for use in creating a container.
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.
createEmbeddedType() - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create a mutable EmbeddedType instance.
createEmbeddedType(Map<String, Attribute>) - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create an immutable EmbeddedType instance.
createInputStream(byte[]) - Method in interface com.ibm.websphere.objectgrid.io.XsDataStreamManager
Create a new XsDataInputStream using the bytes specified as the data backing.
createInteraction() - Method in class com.ibm.websphere.xs.ra.XSConnection
Creates an Interaction associated with this Connection.
createKey(byte[]) - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectKeyFactory
Create a new SerailizedKey wrapper for the key data
createKeyDataDescriptor() - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create a mutable KeyDataDescriptor instance.
createKeyDataDescriptor(Map<String, Attribute>, String) - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create an immutable KeyDataDescriptor instance.
createManagedConnection(Subject, ConnectionRequestInfo) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Creates a new physical connection to the underlying ObjectGrid
createMap(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Creates a BackingMap, but does not associate it with this ObjectGrid.
createMapDataDescriptor() - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create a mutable MapDataDescriptor instance.
createMapDataDescriptor(Map<String, Association>, String) - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create an immutable MapDataDescriptor instance.
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
Deprecated. Deprecated in version 8.6. XML validation is always enabled. Use instead.
createObjectGrid(String, URL, 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
Deprecated. Deprecated in version 8.6. XML validation is always enabled. Use ObjectGridManager.createObjectGrids(URL, boolean) instead.
createObjectGrids(URL, 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
createOutputStream() - Method in interface com.ibm.websphere.objectgrid.io.XsDataStreamManager
Create a new XsDataOutputStream.
createPlugin(PluginType, String) - Static method in class com.ibm.websphere.objectgrid.config.ObjectGridConfigFactory
Create a Plugin for a BackingMapConfiguration or an ObjectGridConfiguration
createQuery(String) - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Create a Query instance for executing an ObjectGrid query language statement.
createQueryQueue(String, Class) - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Create a QueryQueue for an entity map.
createRestValue(String, byte[]) - Method in class com.ibm.websphere.xs.rest.RestValueFactory
Create an object instance that implements the RestValue interface.
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.AbstractCQFilter
Creates a string representation of the continuous query filter, this method is used by AbstractCQFilter.toString().
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.AndFilter
 
createString(String) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.BinaryLogicalFilter
Composes a string representation of the binary logical filter using the operator.
createString(String) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.CompareFilter
Composes a string representation of the compare filter using the operator.
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.EQFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.FalseFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.GTEFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.GTFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.IsNotNullFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.IsNullFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.LTEFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.LTFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.MatchFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.NEQFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.NotFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.NotMatchFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.OrFilter
 
createString() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.TrueFilter
 
createTuple() - Method in interface com.ibm.websphere.projector.md.TupleMetadata
Create a new Tuple associated with this metadata.
createValue(byte[]) - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectValueFactory
Create a new SerializedValue wrapper for the value data.
createValueDataDescriptor() - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create a mutable ValueDataDescriptor instance.
createValueDataDescriptor(Map<String, Attribute>, String) - Method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Create an immutable ValueDataDescriptor instance.
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

DataDescriptor - Interface in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
Identifies accessible attributes that the DataSerializer.DataAttributeInflatable can retrieve.
DataDescriptorException - Exception in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
Exceptions identifying problems with data descriptor configuration.
DataDescriptorException() - Constructor for exception com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorException
Constructs a new DataDescriptorException with null as its detail message.
DataDescriptorException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorException
Constructs a new ObjectGridRuntimeException with the specified detail message and cause.
DataDescriptorException(String) - Constructor for exception com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorException
Constructs a new DataDescriptorException with the specified detail message.
DataDescriptorException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorException
Constructs a new ObjectGridRuntimeException with a specified cause.
DataDescriptorFactory - Class in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
A factory for creating DataDescriptor instances when using custom DataSerializers.
DataDescriptorFactory() - Constructor for class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
 
DataObjectContext - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
Context for for interacting with a data object.
DataObjectContextAware - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
This interface is implemented by DataObjectEntry implementations or sub-interfaces to identify that they are associated with a DataObjectContext.
DataObjectEntry - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
A common interface for all data object wrappers.
DataObjectKey - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
Interface for all key data object wrappers.
DataObjectKeyFactory - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
A factory for creating a key wrapper.
DataObjectValue - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
Interface for all data object value wrappers.
DataObjectValueFactory - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
A factory for creating a data object value.
DataSerializer - Interface in com.ibm.websphere.objectgrid.plugins.io
Includes methods to serialize and inflate a data objects.
DataSerializer.DataAttributeInflatable - Interface in com.ibm.websphere.objectgrid.plugins.io
DataSerializers implement this interface to allow inflating attributes from the serialized form of a data object.
DataSerializer.Identifiable - Interface in com.ibm.websphere.objectgrid.plugins.io
DataSerializers implement this interface to allow an alternative identity.
DataSerializer.SpecialValue - Enum in com.ibm.websphere.objectgrid.plugins.io
Specialty values used by DataSerializer.DataAttributeInflatable.inflateDataObjectAttributes(DataObjectContext, XsDataInputStream, Object).
DataSerializer.UserReadable - Interface in com.ibm.websphere.objectgrid.plugins.io
DataSerializers implement this optional interface to allow a customized human readable representation of a data object.
DATE_OF_FIRST_OCCURRENCE - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
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_ADDRESSABLEKEYNAME - Static variable in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.MapDataDescriptor
The default name used to identify the key for APIs that refer to maps.
DEFAULT_DOMAIN - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
The default name for a catalog service domain.
DEFAULT_KEY_STORE_FILE - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
The default key store file name
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
Deprecated. Deprecated in 8.6. Buckets are no longer required. Use the BackingMap.isNearCacheEnabled() flag to disable the near cache in the ObjectGrid configuration XML file.
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_PATHSEPARATOR - Static variable in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptor
The default path separator to use when not overridden with the DataDescriptor.setPathSeparator(String) method.
DEFAULT_RETRY_TIMEOUT - Static variable in interface com.ibm.websphere.objectgrid.Session
 
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.
DEFAULT_ZONE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The name of the zone that all containers that do not specify a zone are in.
DEFAULTCLIENTPROPERTYFILE - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
The default name of client property file
defineContinuousQuery(String, ContinuousQueryFilter, boolean, boolean, boolean, Collection<ContinuousQueryListener<KeyType, ValueType>>, boolean, boolean, Integer...) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryManager
Define a new continuous query.
defineContinuousQuery(String, ContinuousQueryFilter, boolean, boolean, boolean, Integer...) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryManager
Define a new continuous query.
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.
delta(Statistic) - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Gets the difference between two statistics.
DeploymentPolicy - Interface in com.ibm.websphere.objectgrid.deployment
Defines a policy for use by the ObjectGrid Placement Service to place partitions across the set of available containers.
DeploymentPolicyException - Exception in com.ibm.websphere.objectgrid
This exception is thrown to indicate a problem with the deployment policy.
DeploymentPolicyException() - Constructor for exception com.ibm.websphere.objectgrid.DeploymentPolicyException
Constructs a new DeploymentPolicyException with null as its detail message.
DeploymentPolicyException(String) - Constructor for exception com.ibm.websphere.objectgrid.DeploymentPolicyException
Constructs a new DeploymentPolicyException with the specified detail message.
DeploymentPolicyException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.DeploymentPolicyException
Constructs a new DeploymentPolicyException with a specified cause.
DeploymentPolicyException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.DeploymentPolicyException
Constructs a new DeploymentPolicyException with the specified detail message and cause.
DeploymentPolicyFactory - Class in com.ibm.websphere.objectgrid.deployment
Creates the DeploymentPolicy object representation from ObjectGrid descriptor files which can be used to create ObjectGrid server containers.
DeploymentPolicyFactory() - Constructor for class com.ibm.websphere.objectgrid.deployment.DeploymentPolicyFactory
 
DEPTH_INFINITE - Static variable in interface com.ibm.websphere.projector.FetchPlan
The default maximum fetch depth.
destroy() - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
 
destroy() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Destroys this instance.
destroy() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
This is called when the application tells the ObjectGrid to stop.
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 class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Called when the ObjectGrid instance itself is being destroyed.
destroy() - Method in interface com.ibm.websphere.objectgrid.plugins.Destroyable
Invoked when the bean's state has been set and is ready to be destroyed.
destroy() - Method in interface com.ibm.websphere.objectgrid.plugins.Evictor
Called when the BackingMap associated with this evictor is destroyed.
destroy(String) - Method in interface com.ibm.websphere.objectgrid.plugins.index.DynamicIndexCallback
Invoked when the dynamic index is removed or the BackingMap is destroyed.
destroy() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
destroy() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
destroy() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
 
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.
destroy() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Destroy this MCF and release any other resources.
destroy() - Method in interface com.ibm.websphere.xs.sessionmanager.SessionIDOverride
This method will be called by the WXS Http session client when a web application is destroyed, typically when a web application is stopped.
Destroyable - Interface in com.ibm.websphere.objectgrid.plugins
Java bean plug-ins can implement this interface to allow destroying the plug-in after it's state has been set.
disableClientReplication() - Method in interface com.ibm.websphere.objectgrid.ClientReplicableMap
Deprecated. Disables the replication for this client.
DISABLED_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for the the "disabled" string
disableStatistic(int) - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Disables the specified statistics
disconnect(ClientClusterContext) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Disconnects a client process from an ObjectGrid server
DISCONNECTED_SERVER_STOP - Static variable in interface com.ibm.websphere.objectgrid.server.Server
Constant that represents that the server stopped due to the server no longer being connected to its catalog server.
dismissLink(String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementMediationServiceMBean
Dismiss a previously established link with the foreign domain specified.
DistributionMode - Class in com.ibm.websphere.objectgrid.plugins
This class is used to define the "distribution" mode when the serialize() method on the LogSequenceTransformer interface is used.
doBatchUpdate(TxID, LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
doBatchUpdate(TxID, LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
doBatchUpdate(TxID, LogSequence) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Called by ObjectGrid runtime to allow the index to be updated as the result of changes applied to a map during the commit cycle of a transaction.
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.
DUAL_ROLES_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setReplicationRole(String) method for setting replicationRole as DUAL_ROLES.
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.
DuplicateNameException - Exception in com.ibm.websphere.objectgrid
 
DuplicateNameException() - Constructor for exception com.ibm.websphere.objectgrid.DuplicateNameException
Constructs a new DuplicateNameException with null as its detail message.
DuplicateNameException(String) - Constructor for exception com.ibm.websphere.objectgrid.DuplicateNameException
Constructs a new DuplicateNameException with the specified detail message.
DuplicateNameException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.DuplicateNameException
Constructs a new DuplicateNameException with the specified detail message and cause.
DuplicateNameException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.DuplicateNameException
Constructs a new DuplicateNameException with a specified cause.
DYNAMIC_INDEX - Static variable in class com.ibm.websphere.objectgrid.security.ServerMapPermission
dynamic index permission constant
DYNAMIC_MAP - Static variable in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Dynamic map permission constant
DynamicIndexCallback - Interface in com.ibm.websphere.objectgrid.plugins.index
This interface provides a callback mechanism for dynamic indexing process.
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

EAGER - Static variable in class com.ibm.websphere.projector.md.FetchType
Fetch the data eagerly.
EmbeddedType - Interface in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
An EmbeddedType represents a nested, complex object.
EMPTY_VALUE - Static variable in interface com.ibm.websphere.objectgrid.plugins.index.MapIndex
A SpecialValue constant that indicates a particular attribute value should be excluded from an index query.
enableClientReplication(ClientReplicableMap.Mode, int[], ReplicationMapListener) - Method in interface com.ibm.websphere.objectgrid.ClientReplicableMap
Deprecated. Make the client map a replica of the server side map.
ENABLED_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for the "enabled" string
enableForPlacement(String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Re-enables container which has been disabled because of the failure of shard placement operations.
enableStatistic(int) - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Enables the specified statistics
endpointActivation(MessageEndpointFactory, ActivationSpec) - Method in class com.ibm.websphere.xs.ra.XSResourceAdapter
This method does nothing as endpoint activation is not supported
endpointDeactivation(MessageEndpointFactory, ActivationSpec) - Method in class com.ibm.websphere.xs.ra.XSResourceAdapter
This method does nothing as endpoint deactivation is not supported
Entity - Annotation Type in com.ibm.websphere.projector.annotations
Specifies that this class is an entity.
EntityAgentMixin - Interface in com.ibm.websphere.objectgrid.datagrid
This interface can be implemented by an agent.
entityClass - Variable in class com.ibm.websphere.objectgrid.jpa.JPALoader
 
entityClassName - Variable in class com.ibm.websphere.objectgrid.jpa.JPALoader
 
EntityExistsException - Exception in com.ibm.websphere.objectgrid.em
Thrown when an entity can't be persisted because it would result in a duplicate key violation.
EntityExistsException() - Constructor for exception com.ibm.websphere.objectgrid.em.EntityExistsException
 
EntityExistsException(String) - Constructor for exception com.ibm.websphere.objectgrid.em.EntityExistsException
 
EntityExistsException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.EntityExistsException
 
EntityExistsException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.EntityExistsException
 
EntityExistsException - Exception in com.ibm.websphere.projector
Thrown by the ObjectGraph or TupleStore when an entity persisted into the graph or inserted into the TupleStore is a duplicate.
EntityExistsException() - Constructor for exception com.ibm.websphere.projector.EntityExistsException
 
EntityExistsException(String) - Constructor for exception com.ibm.websphere.projector.EntityExistsException
 
EntityExistsException(Throwable) - Constructor for exception com.ibm.websphere.projector.EntityExistsException
 
EntityExistsException(String, Throwable) - Constructor for exception com.ibm.websphere.projector.EntityExistsException
 
EntityListeners - Annotation Type in com.ibm.websphere.projector.annotations
Identifies general entity listener classes to receive entity lifecycle callback notifications.
EntityManager - Interface in com.ibm.websphere.objectgrid.em
An EntityManager allows transactional introspection and manipulation of entities.
EntityMetadata - Interface in com.ibm.websphere.projector.md
The metadata for an entity.
EntityTransaction - Interface in com.ibm.websphere.objectgrid.em
An EntityTransaction is associated with an EntityManager and is used to demarcate a transaction.
EntryErrorValue - Interface in com.ibm.websphere.objectgrid.datagrid
This is returned as the value when the AgentManager is unable to run the agent on the server, the server is unable to complete the agent's transaction or the agent throws an exception.
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.
EQFilter<AttributeType,MatchType> - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This class checks if an attribute is equal to another object.
EQFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.EQFilter
Constructor for serialization only.
EQFilter(String, MatchType) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.EQFilter
 
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(Object) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.AbstractCQFilter
 
equals(Object) - Method in class com.ibm.websphere.objectgrid.em.FlushModeType
 
equals(Object) - Method in class com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository.OSGiServiceKey
 
equals(Object) - Method in class com.ibm.websphere.objectgrid.plugins.index.MapIndex.SpecialValue
 
equals(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectKey
Answers true if the his key is equivalent to another key in KeyBytes format.
equals(DataObjectContext, XsDataInputStream, XsDataInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer.Identifiable
Answers true if the two serialized data objects are equivalent.
equals(Object) - Method in class com.ibm.websphere.objectgrid.plugins.Loader.SpecialValue
 
equals(Object) - Method in class com.ibm.websphere.objectgrid.plugins.ReplicaPreloadController.Status
 
equals(Object) - Method in class com.ibm.websphere.objectgrid.security.AgentPermission
Checks two AgentPermission objects for equality.
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.MapPermission
Checks two MapPermission objects for equality.
equals(Object) - Method in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Checks two ObjectGridPermission objects for equality.
equals(Object) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.ClientCertificateCredential
Checks two ClientCertificateCredential objects for equality.
equals(Object) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleDeptPrincipal
Compares the specified Object with this SimpleDeptPrincipal for equality.
equals(Object) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleUserPrincipal
Compares the specified Object with this SimpleUserPrincipal 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(Object) - Method in class com.ibm.websphere.objectgrid.security.ServerMapPermission
Checks two ServerMapPermission objects for equality.
equals(TxID) - Method in interface com.ibm.websphere.objectgrid.TxID
Checks for equality between two TxID objects.
equals(Object) - Method in class com.ibm.websphere.projector.md.AccessType
Returns true if the input object is equivalent to this AccessType.
equals(Object) - Method in class com.ibm.websphere.projector.md.AssociationType
Returns true if the input object is equivalent to this AssociationType.
equals(Object) - Method in class com.ibm.websphere.projector.md.FetchType
Returns true if the input object is equivalent to this FetchType.
equals(Object) - Method in interface com.ibm.websphere.projector.Tuple
Indicates whether a Tuple is "equal to" this one.
equals(Object) - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
 
equals(Object) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
 
equals(Object) - Method in class com.ibm.websphere.xsa.RestValue
Deprecated.  
error(String, Throwable) - Method in interface com.ibm.websphere.objectgrid.plugins.index.DynamicIndexCallback
Invoked when the dynamic indexing process encounters an unexpected error.
establishLink(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementMediationServiceMBean
Establish a link between this domain and the foreign domain specified.
EventListener - Interface in com.ibm.websphere.objectgrid.plugins
The EventListener interface is the base interface used to indicate that an implementing class can accept certain ObjectGrid or BackingMap events.
EVICT - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the EVICT operation.
evict(Object) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
Evicts the entry at the given key.
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
 
EXCEPTION_NAME - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
ExceptionMapper - Interface in com.ibm.websphere.objectgrid.plugins
The ExceptionMapper interface allows users to plug in specific exception mapping functionality.
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

FACTORY_CLASS - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPLoginModule
Deprecated. LDAP context factory implementation class property name
FAILED_SECURITY - Static variable in exception com.ibm.websphere.objectgrid.ConnectException
This failure code indicates the a failure to authenticate.
FailedUpdateElement - Interface in com.ibm.websphere.objectgrid.writebehind
A FailedUpdateElement object represents a LogElement which failed to be updated to the loader in a write-behind update operation.
FalseFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This Filter always returns FALSE
FalseFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.FalseFilter
 
FETCH - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the FETCH operation.
FetchPlan - Interface in com.ibm.websphere.projector
A FetchPlan object allows you to customize how to fetch relations.
FetchType - Enum in com.ibm.websphere.projector.annotations
Defines strategies for fetching data from the TupleStore.
FetchType - Class in com.ibm.websphere.projector.md
Defines strategies for fetching data from the TupleStore.
FFDC_INCIDENT_DATA - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
FFDC_NOTIFICATION - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
FIELD - Static variable in class com.ibm.websphere.projector.md.AccessType
The persistent state of the entity object is accessed using fields.
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
FieldAccessEntityNotInstrumentedException - Exception in com.ibm.websphere.projector
This exception will occur when the Java instrumentation is enabled, but the field-access Entity class is not included in the instrumentation domain.
FieldAccessEntityNotInstrumentedException() - Constructor for exception com.ibm.websphere.projector.FieldAccessEntityNotInstrumentedException
 
FieldAccessEntityNotInstrumentedException(String) - Constructor for exception com.ibm.websphere.projector.FieldAccessEntityNotInstrumentedException
 
FieldAccessEntityNotInstrumentedException(Throwable) - Constructor for exception com.ibm.websphere.projector.FieldAccessEntityNotInstrumentedException
 
FieldAccessEntityNotInstrumentedException(String, Throwable) - Constructor for exception com.ibm.websphere.projector.FieldAccessEntityNotInstrumentedException
 
FieldAlias - Annotation Type in com.ibm.websphere.objectgrid.plugins.io.annotations
Specifies the field alias that you can use to correlate different class field names that have the same class field alias.
filter(FilterContent<KeyType, ValueType>) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryFilter
Checks if the supplied object passes the filter.
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.AndFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.EQFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.FalseFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.GTEFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.GTFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.IsNotNullFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.IsNullFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.LTEFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.LTFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.MatchFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.NEQFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.NotFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.NotMatchFilter
 
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.OrFilter
Will return true if any child filter returns true.
filter(FilterContent) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.TrueFilter
 
FilterContent<KeyType,ValueType> - Interface in com.ibm.websphere.objectgrid.continuousquery.filter
A wrapper for cache entry objects which is passed to each ContinuousQueryFilter associated with a continuous query.
find(Class, Object) - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Find an entity by primary key in the ObjectGrid cache.
findAll(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndex
Returns the keys for the entries that have the specified attribute value.
findAll() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndex
Returns the keys of the entire map.
findEntries(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns the keys and entries that have the specified attribute values.
findEntriesByAttribute(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns a map of the keys and entries for the specified attribute values.
FinderException - Exception in com.ibm.websphere.objectgrid.plugins.index
This exception is thrown when an index finder method encounters an error.
FinderException() - Constructor for exception com.ibm.websphere.objectgrid.plugins.index.FinderException
Constructs a new FinderException with null as its detail message.
FinderException(String) - Constructor for exception com.ibm.websphere.objectgrid.plugins.index.FinderException
Constructs a new FinderException with the specified detail message.
FinderException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.index.FinderException
Constructs a new FinderException with the specified detail message and cause.
FinderException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.index.FinderException
Constructs a new FinderException with a specified cause.
findForUpdate(Class, Object) - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Find an entity by primary key with the intent to be updated.
findGreater(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapRangeIndex
Finds all keys with entries with an attribute value greater than the specified value.
findGreaterEqual(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapRangeIndex
Find all keys with entries with an attribute value greater than or equal to the specified value.
findKeys(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns the keys for the entries that have the specified attribute values.
findKeysByAttribute(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns a map of the keys of the entries for the specified attribute values.
findLess(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapRangeIndex
Finds all keys with entries with an attribute value less than the specified value.
findLessEqual(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapRangeIndex
Finds all keys with entries with an attribute value less than or equal to the specified value.
findMax() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapRangeIndex
Returns the keys for the entries that have the maximum attribute value.
findMin() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapRangeIndex
Returns the keys for the entries that have the minimum attribute value.
findPartitions(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns the partitions contain the entries that have the specified attribute values.
findPartitionsByAttribute(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns a map of partitions contain the entries for specified attribute values.
findRange(Object, Object) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapRangeIndex
Returns all keys for the entries with an attribute value inclusively within the specified range such that lowAttributeValue <= attribute value < highAttributeValue.
findRange(Object, Object, boolean, boolean) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapRangeIndex
Returns all keys for the entries with an attribute value.
findSize(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns the number of entries that have the specified attribute values.
findSizesByAttribute(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns a map of the number of entries for specified attribute values.
findValues(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns the entries that have the specified attribute values.
findValuesByAttribute(AttributeType...) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapGlobalIndex
Returns a map of the entries for the specified attribute 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.em.EntityManager
Synchronize the EntityManager to the ObjectGrid cache.
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.
FlushModeType - Class in com.ibm.websphere.objectgrid.em
Used to specify when the flush behavior of an EntityManager query when running within a transaction.
forceJavaCore() - Method in exception com.ibm.websphere.objectgrid.LockTimeoutException
 
forget(String) - Method in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Heuristically forget the specified transaction at this partition.
fromByteArray(byte[]) - Static method in class com.ibm.websphere.objectgrid.SessionHandleTransformer
Converts the byte array representation of the handle back into instance form.
fromString(String) - Static method in class com.ibm.websphere.objectgrid.SessionHandleTransformer
Converts a stringified session handle back into a SessionHandle instance.
FULL_PRELOAD_NEEDED - Static variable in class com.ibm.websphere.objectgrid.plugins.ReplicaPreloadController.Status
This constant means an application bug has occurred and the controller cannot determine whether preload has completed or can be recovered.

G

generateToken(Object) - Method in interface com.ibm.websphere.objectgrid.security.plugins.SecureTokenManager
Generates the token for the specified object.
GENERIC - Static variable in exception com.ibm.websphere.objectgrid.ZoneConfigurationException
A generic error code.
get(KeyType) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryCache
Returns the value for the given key.
get(Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Retrieves the object from the cache at the given key.
get(TxID, List, boolean) - Method in class com.ibm.websphere.objectgrid.jpa.JPAEntityLoader
Returns the list of values corresponding to the set of keys passed in by retrieving the data using JPA.
get(TxID, List, boolean) - Method in class com.ibm.websphere.objectgrid.jpa.JPALoader
Returns the list of values corresponding to the set of keys passed in by retrieving the data using JPA.
get(Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Retrieves the object from the cache at the given key.
get(TxID, List, boolean) - Method in interface com.ibm.websphere.objectgrid.plugins.Loader
Returns the list of values corresponding to the set of keys passed in.
get(Object) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
Retrieves the object from the cache at the given key.
getAccessedSessions(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the access to sessions statistic.
getAccessedSessionsCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets acessed sessions count
getAccessToNonExistentSession(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the access to nonexistent sessions statistic.
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.
getAccessType() - Method in class com.ibm.websphere.projector.md.AccessType
Retreive the value of this AccessType.
getAccessType() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
The method in which the persistent state of the entity is accessed by the runtime.
getActions() - Method in class com.ibm.websphere.objectgrid.security.AgentPermission
Returns the actions as a String.
getActions() - Method in class com.ibm.websphere.objectgrid.security.MapPermission
Returns the actions as a String.
getActions(int) - Static method in class com.ibm.websphere.objectgrid.security.MapPermission
Returns the actions as a String for the specified mask.
getActions() - Method in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Returns the actions as a String.
getActions(int) - Static method in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Returns the actions as a String for the specified mask.
getActions() - Method in class com.ibm.websphere.objectgrid.security.ServerMapPermission
Returns the actions as a String.
getActions(int) - Static method in class com.ibm.websphere.objectgrid.security.ServerMapPermission
Returns the actions as a String for the specified mask.
getActionsInInt() - Method in class com.ibm.websphere.objectgrid.security.MapPermission
Returns an int mask value which represents the permission's actions.
getActionsInInt() - Method in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Returns an int mask value which represents the permission's actions.
getActionsInInt() - Method in class com.ibm.websphere.objectgrid.security.ServerMapPermission
Returns an int mask value which represents the permission's actions.
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.
getActiveSessions(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the active sessions statistic.
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.
getAddressableKeyName() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
return the value for the addressableKeyName property.
getAddressableKeyName() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Retrieve the addressable attribute name for the KeyDataSerializer for this MapSerializer
getAddressableKeyName() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.MapDataDescriptor
Retrieves the addressable attribute name to use for accessing KeyDataSerializer data when using partial key lookups such as a query.
getAffinityBreaks(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the affinity breaks statistic.
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.
getAgentInflationTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
Gets the agent inflation time statistic.
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.
getAgentSerializationTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
Gets the agent serialization time statistic.
getAlias() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the SSL alias name for this SSL configuration.
getAlias() - Method in interface com.ibm.websphere.projector.md.TupleAttribute
The alias of the attribute.
getAll(List) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Gets a list of entries from the map.
getAll(List) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Gets a list of entries from the map.
getAll(List) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Returns a list of objects associated with the given keys
getAllChanges() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns an iterator for processing all of the changes for a LogSequence.
getAllCurrentlyUsedRankings() - Method in interface com.ibm.websphere.objectgrid.management.ServerOSGiMBean
Get currently used rankings for all the OSGi services.
getAllCurrentlyUsedRankings() - Method in interface com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository
Get currently used service rankings for all the OSGi services.
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) - 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.
getAllListeners() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryTopic
Returns a shallow copy of the current set of listeners registered for this query topic.
getAllRankings() - Method in interface com.ibm.websphere.objectgrid.management.ServerOSGiMBean
Get all available rankings for all the OSGi services
getAllRankings(String) - Method in interface com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository
Get all available service rankings for the OSGi service.
getAllRankings() - Method in interface com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository
Get all available service rankings for all the OSGi services
getAllTypeTransactionTime() - Method in interface com.ibm.websphere.objectgrid.stats.OGStatsModule
Retrieves the transaction response time statistic for all committed transactions.
getAssociation(int) - Method in interface com.ibm.websphere.projector.md.TupleMetadata
Retrieve the association metadata at the given position.
getAssociation(int, int) - Method in interface com.ibm.websphere.projector.Tuple
Retrieve the association Tuple key from the specified position and index.
getAssociationPosition(String) - Method in interface com.ibm.websphere.projector.md.TupleMetadata
Retrieve the position of the named association.
getAssociations() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Retrieve the associations for this MapSerializer.
getAssociations() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.MapDataDescriptor
Returns the associations between this map and another map.
getAssociations(int) - Method in interface com.ibm.websphere.projector.Tuple
Retrieve all association Tuple keys from the specified position.
getAssociationSize(int) - Method in interface com.ibm.websphere.projector.Tuple
Retrieve the number of association keys for an association.
getAssociationType() - Method in class com.ibm.websphere.projector.md.AssociationType
Retreive the value of this AssociationType.
getAssociationType() - Method in interface com.ibm.websphere.projector.md.TupleAssociation
The cardinality for this end of an association.
getAT() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredential
Gets the authetication token for this credential.
getAttribute(FilterContent, String) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.AbstractCQFilter
Retrieves an attribute from the content that is to be filtered based on the specified attribute path.
getAttribute(Object) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Extracts the attribute from a specified object.
getAttribute(Object) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
Extracts the attribute value from a specified object.
getAttribute(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Extracts the attribute from a specified value Object.
getAttribute(int) - Method in interface com.ibm.websphere.projector.md.TupleMetadata
Retrieve the attribute metadata at the given position.
getAttribute(int) - Method in interface com.ibm.websphere.projector.Tuple
Retreive an attribute value from the specified position.
getAttributeContexts(String...) - Method in interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer.DataAttributeInflatable
Retrieve a context from the specified attribute paths.
getAttributeName() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Retrieves the attribute name or comma-delimited list of attribute names that was set with the HashIndex.setAttributeName(String) method.
getAttributeName() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
Retrieves the attribute name or comma-delimited list of attribute names that was set with the InverseRangeIndex.setAttributeName(String) method.
getAttributeName() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Gets the name of the indexed attribute.
getAttributeName() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Association
Retrieves the name of the attribute.
getAttributeName() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Attribute
Retrieves the name of the attribute.
getAttributeName() - Method in exception com.ibm.websphere.projector.MetadataException
The name of the attribute that this exception refers to or null if the exception doesn't refer to an attribute.
getAttributeNames() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Retrieves the names of each attribute included in the index that was set with the HashIndex.setAttributeName(String) method.
getAttributePosition(String) - Method in interface com.ibm.websphere.projector.md.TupleMetadata
Retrieve the position of the named attribute.
getAttributes() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptor
Retrieve all Attributes defined for this DataDescriptor.
getAttributes() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.EmbeddedType
Retrieve all Attributes defined for this DataDescriptor.
getAttributeType() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Attribute
Retrieves the type of the attribute.
getAuthenticationRetryCount() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the authentication retry count for this client security configuration.
getAvailabilityState() - Method in exception com.ibm.websphere.objectgrid.AvailabilityException
 
getAvailableProcessors() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns the number of available processors for the JVM hosting this server.
getBackingMap() - Method in interface com.ibm.websphere.objectgrid.plugins.BackingMapLifecycleListener.LifecycleEvent
Retrieve the BackingMap instance that the event applies to.
getBackingMap() - Method in interface com.ibm.websphere.objectgrid.plugins.BackingMapPlugin
Retrieve the BackingMap instance associated with this plug-in.
getBackingMap() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
getBackingMap() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
getBackingMap() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexInfo
Returns the BackingMap the index is associated with.
getBackingMap() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
 
getBackingMap() - Method in interface com.ibm.websphere.objectgrid.plugins.io.SerializerAccessor
Retrieve the BackingMap associated with this SerializerAccessor.
getBackingMapConfigurations() - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Get the List of BackingMapConfiguration objects that are attached to this ObjectGridConfiguration object
getBase() - Method in interface com.ibm.websphere.objectgrid.stats.PercentageStatistic
Gets the base value of this statistic where getPercentage = getValue / getBase * 100
getBatchUpdateCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's batchupdate count attribute loaded up by the retrieveStatsModule() method.
getBatchUpdateCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.HashIndexStatsModule
Gets the batch update count statistic.
getBatchUpdateTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.MapStatsModule
Gets the map's loader batch update time.
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.
getByteOrder() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Gets the byte order for writing multi-byte data.
getByteOrder() - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Gets the byte order for writing multi-byte data.
getCache() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryTopic
Return a continuous query cache object with methods to access the keys and values stored in the cache.
getCacheDiscards(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the discarded sessions statistic.
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.
getCacheStatistics() - Method in class com.ibm.websphere.objectgrid.hibernate.cache.ObjectGridHibernateCacheProvider
Note: This method is accessed reflection and used for testing and debugging.
getCascadeInfo() - Method in interface com.ibm.websphere.projector.md.TupleAssociation
Identifies the persistent operations that should be cascaded to the target entity.
getCatalogClusterEndpoints() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Retrieves the list of catalog service endpoints.
getCatalogDomainManager() - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Retrieve the CatalogDomainManager for this ObjectGridManager.
getCatalogProperties() - Static method in class com.ibm.websphere.objectgrid.server.ServerFactory
Returns the properties object instance used in configuring the catalog service aspects of the server.
getCatalogServiceBootstrap() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the catalog service corbaloc string.
getCatalogServiceDomain() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Get the eXtreme Scale specific property: CatalogDomain
getCatalogServiceDomain() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: CatalogDomain
getCatalogServiceEndPoints() - Method in class com.ibm.websphere.objectgrid.httpsession.HttpSessionConfigurationUtility
Returns a comma-separated, String representation of host:port tuples.
getCatalogServiceEndpoints() - Method in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
The catalog service endpoints of the catalog service.
getCatalogServiceEndpoints() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Get the eXtreme Scale specific property: CatalogServiceEndpoints
getCatalogServiceEndpoints() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: CatalogServiceEndpoints
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.
getCerts() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.ClientCertificateCredential
Gets the client certificate chain array.
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.
getClassForEntity() - Method in interface com.ibm.websphere.objectgrid.datagrid.EntityAgentMixin
This method returns the class to be used instead of the key object when the agent action methods are called.
getClassName() - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Get the String representation of the class name of this Plugin
getClientCatalogServerEndpoints() - Method in interface com.ibm.websphere.objectgrid.CatalogDomainInfo
Retrieve the catalog server endpoints used to connect a client to the remote catalog service domain.
getClientCertificateAuthentication() - Method in interface com.ibm.websphere.objectgrid.security.config.ClientSecurityConfiguration
Gets the client certificate authentication type for this client security configuration.
getClientLoader() - Static method in class com.ibm.websphere.objectgrid.jpa.ClientLoaderFactory
Get an instance of ClientLoader which can be used to load the distributed ObjectGrid maps from an ObjectGrid client.
getClientLoaderSession(Session) - Static method in class com.ibm.websphere.objectgrid.jpa.ClientLoaderFactory
A Session object directly retrieved from ObjectGrid can not be used to drive transactions to a shard in AvailabilityState.PRELOAD state.
getClientProperties(String) - Method in interface com.ibm.websphere.objectgrid.ClientClusterContext
Retrieve the ClientProperties object for this ClientClusterContext for the specified ObjectGrid name.
getClientPropertiesResource() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Get the eXtreme Scale specific property: ClientPropertiesResource
getClientPropertiesResource() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: ClientPropertiesResource
getClientPropertiesURL() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Get the eXtreme Scale specific property: ClientPropertiesURL
getClientPropertiesURL() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: ClientPropertiesURL
getClientSecurityConfiguration() - Method in interface com.ibm.websphere.objectgrid.CatalogDomainInfo
Retrieve the ClientSecurityConfiguration for the domain.
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 domain to which the client is connected
getClusterSecurityURL() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Retrieves the cluster security file location.
getCode() - Method in class com.ibm.websphere.objectgrid.plugins.LogElement.Type
Gets the type code for this object.
getCollision() - Method in interface com.ibm.websphere.objectgrid.revision.CollisionData
Retrieves the revision element wrapping the value that has collided with the entry in the cache.
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.
getCompressionMode() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Gets the compression mode.
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.
getConnection() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Retrieve an XSConnection for the ObjectGrid configured on the ConnectionFactory.
getConnection(ConnectionSpec) - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Retrieve an XSConnection for the ObjectGrid using the specified XSConnectionSpec properties.
getConnection(String) - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Retrieve an XSConnection for the specified ObjectGrid name.
getConnectionName() - Method in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
The name of the connection as specified on the J2C ConnectionFactory, or "DEFAULT" if not specified.
getConnectionName() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Get the eXtreme Scale specific property: ConnectionName
getConnectionName() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: ConnectionName
getConnectionStatus() - Method in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
The status of the connection.
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.MapMBean
Gets the name of the container containing the replication group member for the map associated with this MBean.
getContainerName() - Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
Gets the name of the container name containing the replication group member for the ObjectGrid associated with this MBean.
getContainerName() - Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
Retrieves the name of the container that is hosting this shard.
getContainerReplicationState() - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Provides the numbers of outstanding in-bound and out-bound revisions which need to be replicated cross containers within one domain.
getContainers() - Method in interface com.ibm.websphere.objectgrid.server.Server
Retrieves a Collection of active Container Objects belonging to this Server
getContentType() - Method in interface com.ibm.websphere.xs.rest.RestValue
Return content type of the contained value
getContentType() - Method in class com.ibm.websphere.xsa.RestValue
Deprecated. Return content type of the contained value
getContext() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectContextAware
Retrieves the current DataObjectContext associated with this object, or null if not associated with a context.
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.
getCount() - Method in interface com.ibm.websphere.objectgrid.stats.CountStatistic
Gets the count since the last reset.
getCount() - Method in interface com.ibm.websphere.objectgrid.stats.TimeStatistic
Gets the count since the last reset.
getCreatedSessions(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the created sessions statistic.
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.
getCredentialGenerator() - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Returns the CredentialGenerator object for this client security for the connection.
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.
getCurrentlyUsedRankings(String) - Method in interface com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository
Get all currently used service rankings for the specified OSGi service.
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.
getDataFromLastPeriod() - Method in interface com.ibm.websphere.objectgrid.stats.ActiveLongStatistic
Gets the data from the last period
getDataStreamManager() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectContext
Return the data stream manager associated with this DataObjectContext
getDBUpdateMode() - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
 
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.
getDefaultContext() - Method in interface com.ibm.websphere.objectgrid.plugins.io.SerializerAccessor
Retrieve the default DataObjectContext associated with this SerializerAccessor
getDefaultDomainInfo() - Method in interface com.ibm.websphere.objectgrid.CatalogDomainManager
Retrieve the default, configured CatalogDomainInfo.
getDefinedContinuousQueries() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryManager
Returns a list view of the currently defined Continuous Query Topics.
getDescription() - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Gets the description of this statistic.
getDisabledForPlacement() - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Retrieves TabularData of containers which have been disabled because of the failure of shard placement operations.
getDiskOverflowCapBytes() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Returns the maximum number of bytes that can be used by this JVM when overflowing bytes to disk.
getDiskOverflowMinDiskSpaceBytes() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Returns the minimum number of bytes that must remain free on disk when overflowing bytes to disk.
getDiskStoragePath() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Returns the root directory used for disk overflow.
getDomainEndPoints(String) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Retrieves the end points for the specified domain
getDomainId() - Method in interface com.ibm.websphere.objectgrid.CatalogDomainInfo
Retrieve the identifier of the domain as specified by the catalog service domain.
getDomainInfo(String) - Method in interface com.ibm.websphere.objectgrid.CatalogDomainManager
Retrieve the specified CatalogDomainInfo for the specified domainId.
getDomainInfos() - Method in interface com.ibm.websphere.objectgrid.CatalogDomainManager
Retrieve all configured CatalogDomainInfo objects.
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.
getDomainName() - Method in interface com.ibm.websphere.objectgrid.revision.RevisionElement
The name of the domain that this revision was modified in.
getDomainName() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Retrieves the name of the domain that this catalog service defines.
getDomainName() - Method in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
The domain name of the catalog service domain as reported by the catalog service.
getDomainReplicationState() - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Provides the numbers of outstanding in-bound and out-bound revisions which need to be replicated cross domains.
getEmbeddedType() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Attribute
Retrieves the embedded attribute type.
getEncodingScheme() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Gets canonical name of the current string encoding scheme.
getEncodingScheme() - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Gets canonical name of the current string encoding scheme.
getEntityClassName() - Method in class com.ibm.websphere.objectgrid.jpa.JPALoader
Retrieve the JPA entity class name that should be loaded.
getEntityClassName() - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
 
getEntityClassName() - Method in exception com.ibm.websphere.projector.MetadataException
The name of the entity metadata class that this exception refers to.
getEntityManager(TxID) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
Get the JPA entity manager associated with this ObjectGrid transaction.
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.
getEntityName() - Method in exception com.ibm.websphere.projector.MetadataException
The name of the entity that this exception refers to.
getEnvironmentInfo() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Retrieve the environment information for the server (host name, WebSphere eXtreme Scale version, and additional information).
getErrorCode() - Method in exception com.ibm.websphere.objectgrid.ZoneConfigurationException
Returns the error code that was set by one of the constructors that accepts an error code, or GENERIC if one of the other constructors was called.
getErrorExceptionString() - Method in interface com.ibm.websphere.objectgrid.datagrid.EntryErrorValue
The toString of the exception thrown by the agent.
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.
getException() - Method in interface com.ibm.websphere.objectgrid.datagrid.EntryErrorValue
The exception thrown by the agent.
getExceptionClassName() - Method in interface com.ibm.websphere.objectgrid.datagrid.EntryErrorValue
This is the class name for the thrown exception
getExisting() - Method in interface com.ibm.websphere.objectgrid.revision.CollisionData
Retrieves the revision element wrapping the value that is currently in the cache.
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.
getFailureCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
Gets the failure count statistic.
getFetchPlan() - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Get the current mutable FetchPlan.
getFetchType() - Method in class com.ibm.websphere.projector.md.FetchType
Retreive the value of this FetchType.
getFetchType() - Method in interface com.ibm.websphere.projector.md.TupleAssociation
Identifies how to fetch the associated entity from the persistent store.
getFieldName() - Method in interface com.ibm.websphere.projector.md.TupleAssociation.OrderByInfo.OrderByElement
The name of the field to order.
getFindCollisionCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's collision count attribute loaded up by the retrieveStatsModule() method.
getFindCollisionCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.HashIndexStatsModule
Gets the collision count statistic for the find operation.
getFindCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's find count attribute loaded up by the retrieveStatsModule() method.
getFindCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.HashIndexStatsModule
Gets the find operation's invocation count statistic.
getFindDurationTime() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's find duration time attribute loaded up by the retrieveStatsModule() method.
getFindDurationTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.HashIndexStatsModule
Gets the duration time statistic for the find operation.
getFindFailureCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's failure count attribute loaded up by the retrieveStatsModule() method.
getFindFailureCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.HashIndexStatsModule
Gets the failure count statistic for the find operation.
getFindResultCount() - Method in interface com.ibm.websphere.objectgrid.management.HashIndexMBean
Gets the index's result count attribute loaded up by the retrieveStatsModule() method.
getFindResultCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.HashIndexStatsModule
Gets the result set's count statistic for the find operation.
getFlushMode() - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Get the flush mode that applies to all objects contained in the EntityManager's context.
getForeignDomains() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Get the current foreign domains.
getFormattedMessageHistory(long, long) - Method in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
Retrieves the most recent history list subset of notifications in a generalised "canonical" form, starting with the specified first index and ending with the last index specified.
getFormattedMessageHistory() - Method in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
Retrieves the most recent history list subset (last 1000) containing notifications in a generalised "canonical" form.
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) - 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.
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.
getGridName() - Method in exception com.ibm.websphere.objectgrid.plugins.OptimisticCollisionException
Gets the name of the ObjectGrid instance the optimistic collision occurred in.
getHAManagerPort() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieve the High Availability Manager (HA Manager) port.
getHeartBeatFrequencyLevel() - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Retrieves the heartbeat frequency level.
getHeartBeatFrequencyLevel() - Method in interface com.ibm.websphere.objectgrid.management.CoreGroupServiceMBean
Deprecated. This MBean interface is deprecated in 7.1.
getHeartBeatFrequencyLevel() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Retrieves the heartbeat frequency level.
getHitRate(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.MapStatsModule
Gets the map hit rate statistic.
getHostName() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns the host name for this process.
getHPELFileSwitchHour() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the HPEL File Switch Hour
getHPELMaxRepositorySize() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the HPEL Maximum Repository Size
getHPELMaxRetentionTime() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the HPEL Maximum Retention Time
getHPELOutOfSpaceAction() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the HPEL Out Of Space Action
getHPELOutputFormat() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the HPEL Output Format
getHPELRepositoryPath() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the HPEL Repository Path
getId() - Method in class com.ibm.websphere.objectgrid.AvailabilityState
Returns the internal identifier for this state.
getId() - Method in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
Get the raw value of this ConfigPropertyType.
getId() - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Gets the statistic identifier.
getId() - Method in class com.ibm.websphere.objectgrid.TTLType
Get the raw value of this TTLType.
getId() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
Get the internally generated identifier for this entity.
getID(SessionIDOverride.SessionIDContext) - Method in interface com.ibm.websphere.xs.sessionmanager.SessionIDOverride
Returns a session identifier based on the SessionIDContext.
getIdClassMetadata() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
Return the EntityMetadata that represents the composite key class metadata for this EntityMetadata.
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.
getIndexProxy(MapIndexInfo) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
getIndexProxy(MapIndexInfo, boolean) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Gets an index proxy object for performing index lookup operations, optionally requesting upgradeable (U) locks when accessing maps during validation.
getIndexProxy(MapIndexInfo) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
getIndexProxy(MapIndexInfo) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Gets an index proxy object for performing index lookup operations.
getIndoubtList(String) - Method in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Retrieve a list of all transactions that are in the indoubt state at this partition.
getInitialized() - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Returns whether this instance of the Placement Service finished initialization.
getInputStream() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.SerializedEntry
Return a data input stream for the serialized form of the entry.
getInstance() - Static method in class com.ibm.websphere.objectgrid.httpsession.HttpSessionConfigurationUtility
Returns the singleton instance of a HttpSessionConfigurationUtility.
getInstance() - Static method in class com.ibm.websphere.objectgrid.osgi.OSGiManagerFactory
Retrieve the singleton OSGiManagerFactory.
getInstance() - Static method in class com.ibm.websphere.objectgrid.server.ServerFactory
Retrieves the Server singleton for the process, where the first call to this method will initialize the singleton.
getInternal(Object) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Returns an object for a given key
getInternal(QueryKey) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Returns a query result for a given query key
getInvalidatedByTimeout(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the sessions invalidated by timeout statistic.
getInvalidatedByTimeoutCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets invalidated by timeout count
getInvalidatedSessions(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the invalidated sessions statistic.
getInvalidatedSessionsCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets invalidated sessions count
getInvalidationModelString(int) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
 
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.
getInvocationCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
Gets the invocation count statistic.
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.
getJMXConnectorPort() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the JMX connector port that the JMX service is to bind to.
getJMXServicePort() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the port to be used by the JMX connection.
getJpaPropertyFactory() - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
 
getJvmStatsFileName() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets JVM Stats file name
getJvmStatsWriteRate() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the write rate of the CSV statistics files for the JVM in seconds.
getKey() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryNotificationEvent
Retrieve the key of the cache entry that triggered this notification
getKey() - Method in interface com.ibm.websphere.objectgrid.continuousquery.filter.FilterContent
Retrieves the key of the object to be filtered.
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.
getKey() - Method in exception com.ibm.websphere.objectgrid.plugins.OptimisticCollisionException
Gets the key(s) that caused this exception to occur.
getKey() - Method in interface com.ibm.websphere.objectgrid.revision.CollisionData
Retrieves the key to the cache entry that has the collision.
getKeyDataDescriptor() - Method in interface com.ibm.websphere.objectgrid.plugins.io.KeyDataSerializer
Retrieve the metadata for the objects that this DataSerializer understands.
getKeyFactory() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectContext
Returns a KeyFactory used to create Key objects.
getKeyMetadata() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
The TupleMetadata for the entity's key.
getKeyOutputFormat() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Retrieves the data format for all data access APIs that return cache keys.
getKeyOutputFormat() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Retrieves the data format for all data access APIs that return cache keys.
getKeyOutputFormat() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Retrieves the data format for all data access APIs that return cache keys for the current session.
getKeyProperties() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Retrieve the String property from the KeyDataSerializer.
getKeySerializerPlugin() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
 
getKeySerializerPlugin() - Method in interface com.ibm.websphere.objectgrid.plugins.io.MapSerializerPlugin
The KeySerializer to use for all key entries in the map.
getKeySerializerPluginClass() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Retrieves the name of the KeySerializerPlugin class that was set with the BasicMapSerializerPlugin.setKeySerializerPluginClass(String) method.
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.
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.
getLastSampleTime() - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Gets the time the most recent measurement was taken.
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.
getLinkedDomainsWithGrids() - Method in interface com.ibm.websphere.objectgrid.management.PlacementMediationServiceMBean
Retrieve the foreign domains that have an active link with the local domain and the map sets eligible for linking.
getListenerHost() - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Retrieves the host to be used by the ORB.
getListenerHost() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
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.
getListenerPort() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the inbound port used by the dominant transport.
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.
getLocalObjectGrid() - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Return any local object grid instance used for the connection.
getLocalPlatformTransactionManager() - Static method in class com.ibm.websphere.objectgrid.spring.ObjectGridSpringFactory
This returns an ObjectGrid PlatformLocalTransactionManager.
getLocalTransaction() - Method in class com.ibm.websphere.xs.ra.XSConnection
Returns an LocalTransaction instance that enables a component to demarcate local transactions on the Connection.
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.
getLogNotificationFilter() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Retrieves current regular expression filter being applied while screening log record messages before being broadcasted as JMX notifications by the grid server as a JMX Notification of type:
getLogNotificationFilter() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the regular expression filter to be applied to log records messages that are forwarded as JMX notifications by the ObjectGrid server through the LoggerListenerJMXNotifier
getLogSequences() - Method in interface com.ibm.websphere.objectgrid.plugins.TransactionCallback.BeforeCommit.TransactionContext
The LogSequences that reflect the pending changes to the map.
getLogWriter() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the log writer for this XSManagedConnectionFactory instance.
getManager(ObjectGrid) - Static method in class com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryManagerFactory
Factory that returns the single instance of a ContinuousQueryManager for the given object grid.
getMap(String) - Method in interface com.ibm.websphere.objectgrid.adapter.WebSpherePMAdapter
Retrieves an ObjectMap for transactional access to a ObjectGrid map.
getMap(String) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get a BackinMapConfiguration that has been added to this MapSet.
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() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexInfo
Returns the ObjectMap the index is associated with.
getMap() - Method in interface com.ibm.websphere.objectgrid.revision.CollisionData
Retrieves the map that changes for this revision transaction will be committed under.
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.
getMapDataDescriptor() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
 
getMapDataDescriptor() - Method in interface com.ibm.websphere.objectgrid.plugins.io.MapSerializerPlugin
The MapDataDescriptor that describes the map.
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.
getMapName() - Method in exception com.ibm.websphere.objectgrid.plugins.OptimisticCollisionException
Gets the map name the optimistic collision occurred in.
getMappedByAssociationName() - Method in interface com.ibm.websphere.projector.md.TupleAssociation
The attribute name of the owner of a bi-directional association.
getMaps() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get a Collection of BackingMapConfiguration objects that have been added to this MapSet
getMapSerializerPlugin() - Method in interface com.ibm.websphere.objectgrid.plugins.io.SerializerAccessor
Retrieve the MapSerializerPlugin instance.
getMapSet(String) - Method in interface com.ibm.websphere.objectgrid.deployment.ObjectGridDeployment
Get a MapSet that has been added to this ObjectGridDeployment
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.
getMapSetName() - Method in class com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository.OSGiServiceKey
Return the name of the MapSet
getMapSets() - Method in interface com.ibm.websphere.objectgrid.deployment.ObjectGridDeployment
Get a Collection of MapSets that have been added to this ObjectGridDeployment
getMapStatsFileName() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the file name of the CSV statistics file for the Map.
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.
getMapStatsWriteRate() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the write rate of the CSV statistics files for the Map in seconds.
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.
getMax() - Method in interface com.ibm.websphere.objectgrid.stats.CountStatistic
Gets the maximum count value
getMaxAsyncReplicas() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the maximum number of asynchronous replicas for each partition in the MapSet.
getMaxDataPerPeriod() - Method in interface com.ibm.websphere.objectgrid.stats.ActiveLongStatistic
Gets the maximum value of the data for all periods
getMaxFetchDepth() - Method in interface com.ibm.websphere.projector.FetchPlan
Get the maximum fetch depth of eager relationships to retrieve.
getMaximumJVMStatsFiles() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum number of CSV statistics files that are generated for the JVM Stats.
getMaximumJVMStatsFileSize() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the maximum file size, in megabytes, of the CSV statistics files for the JVM.
getMaximumMapStatsFiles() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum number of CSV statistics files that are generated for the Map Stats.
getMaximumMapStatsFileSize() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the maximum file size, in megabytes, of the CSV statistics files for the Map.
getMaximumOGStatsFiles() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum number of CSV statistics files that are generated for the ObjectGrid Stats.
getMaximumOGStatsFileSize() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the maximum file size, in megabytes, of the CSV statistics files for the ObjectGrid.
getMaximumSize() - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Retrieves the maximum number of threads in the pool.
getMaximumThreadPoolSize() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieve the maximum number of pooled threads.
getMaximumXIONetworkThreads() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the maximum number of threads to allocate in the eXtremeIO transport network thread pool.
getMaximumXIOWaitingMessages() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the maximum number of messages waiting to be processed.
getMaximumXIOWorkerThreads() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of threads to allocate in the eXtremeIO transport request processing thread pool.
getMaximumXMSize() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the maximum amount of eXtremeMemory (in megabytes) to allocate when eXtremeMemory is enabled.
getMaxMemory() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Returns the maximum memory in bytes for the JVM hosting this server.
getMaxNumberOfReplicas() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Returns the maximum number of replicas for the EMBEDDED or EMBEDDED_PARTITION ObjectGrid type
getMaxNumberOfReplicas() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Returns the maximum number of replicas for the EMBEDDED or EMBEDDED_PARTITION ObjectGrid type
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.
getMaxSyncReplicas() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the maximum number of synchronous replicas for each partition in the MapSet.
getMaxTime() - Method in interface com.ibm.websphere.objectgrid.stats.TimeStatistic
Gets the maximum time value since the beginning of the measurement.
getMaxUsedMemory() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Returns setting of whether memory based eviction is enabled
getMaxUsedMemory() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Returns setting of whether memory based eviction is enabled
getMeanTime() - Method in interface com.ibm.websphere.objectgrid.stats.TimeStatistic
Gets the mean or average of the time values.
getMemoryCount() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets memory count
getMemoryCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the sessions in memory count statistic.
getMemoryThresholdPercentage() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the memory threshold usage percentage, -1 indicates that it was not set.
getMessage() - Method in exception com.ibm.websphere.objectgrid.LockTimeoutException
Returns the detail message string of this exception.
getMetadata() - Method in interface com.ibm.websphere.projector.Tuple
This returns the metadata for this tuple.
getMetaData() - Method in class com.ibm.websphere.xs.ra.XSConnection
Gets the information on the underlying eXtreme Scale instance represented through an active connection.
getMetaData() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Retrieve the metadata information regarding the eXtreme Scale resource adapter
getMetadataClass() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
Retrieve the entity class that is associated with this metadata.
getMetadataClassName() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
Retrieve the entity class name that is associated with this metadata.
getMin() - Method in interface com.ibm.websphere.objectgrid.stats.CountStatistic
Gets the minimum count value.
getMinDataPerPeriod() - Method in interface com.ibm.websphere.objectgrid.stats.ActiveLongStatistic
Gets the minimum value of the data for all periods.
getMinimumSize() - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Retrieves the minimum number of threads in the pool.
getMinimumThreadPoolSize() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieve the minimum number of pooled threads.
getMinimumXIONetworkThreads() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the minimum number of threads to allocate in the eXtremeIO transport network thread pool.
getMinimumXIOWorkerThreads() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the minimum number of threads to allocate in the eXtremeIO transport request processing thread pool.
getMinSyncReplicas() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the minimum number of synchronous replicas for each partition in the MapSet.
getMinTime() - Method in interface com.ibm.websphere.objectgrid.stats.TimeStatistic
Gets the minimum time value since the beginning of the measurement.
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.continuousquery.ContinuousQueryTopic
Returns the generated unique name for this continuous query.
getName() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the name of this MapSet
getName() - Method in interface com.ibm.websphere.objectgrid.deployment.ZoneRule
Get the name of this ZoneRule
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.
getName() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
getName() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
getName() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Gets the name of the index.
getName() - Method in class com.ibm.websphere.objectgrid.security.AnonymousPrincipal
Returns the name of this principal.
getName() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleDeptPrincipal
Gets the user name for this SimpleDeptPrincipal.
getName() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleUserPrincipal
Gets the user name for this SimpleUserPrincipal.
getName() - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
Returns the name of the cache.
getName() - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Gets the name of this statistic.
getName() - Method in interface com.ibm.websphere.objectgrid.stats.StatsFact
Returns the name of the StatsFact instance
getName() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
Get the name for this entity.
getName() - Method in interface com.ibm.websphere.projector.md.TupleAttribute
The name of the attribute
getNativeCache() - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
This implementation returns null.
getNextEntities(int, long) - Method in interface com.ibm.websphere.objectgrid.em.QueryQueue
Get the next batch of entities.
getNextEntity(long) - Method in interface com.ibm.websphere.objectgrid.em.QueryQueue
Get the next entity.
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.
getNotificationHistory(long, long) - Method in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
Retrieves the most recent history list subset of notifications starting with the specified first index and ending with the last index specified.
getNotificationHistory() - Method in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
Retrieves the most recent (last 1000) notifications list history subset available.
getNullValuesSupported() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Gets whether this BackingMap supports null values or not.
getNumAssociations() - Method in interface com.ibm.websphere.projector.md.TupleMetadata
The number of associations this tuple has to other entities.
getNumAttributes() - Method in interface com.ibm.websphere.projector.md.TupleMetadata
The number of basic attributes in this tuple
getNumberOfBuckets() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Deprecated. Deprecated in 8.6. Buckets are no longer required. Use the BackingMap.isNearCacheEnabled() flag to disable the near cache in the ObjectGrid configuration XML file.
getNumberOfBuckets() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Deprecated. Deprecated in 8.6. Buckets are no longer required. Use the BackingMapConfiguration.isNearCacheEnabled() flag to disable the near cache in the ObjectGrid configuration XML file.
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.
getNumberOfPartitions() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the number of partitions of this MapSet.
getNumberOfPartitions() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Returns the number of partitions used in the cache
getNumberOfPartitions() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Returns the number of partitions used in the cache
getNumberOfServers() - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Retrieves the number eXtreme Scale servers that are currently registered with the catalog service.
getNumEntries(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.MapStatsModule
Gets the number of entries statistic.
getNumInitialContainers() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the initial number of containers.
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.
getObject() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectEntry
Return the Object form of the data object.
getObject() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.SerializedEntry
Return the Object form of the data object.
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.plugins.ObjectGridLifecycleListener.LifecycleEvent
Retrieve the ObjectGrid instance that the event applies to.
getObjectGrid() - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridPlugin
Retrieve the ObjectGrid instance associated with this plug-in.
getObjectGrid() - Method in interface com.ibm.websphere.objectgrid.Session
Returns the ObjectGrid that owns this session.
getObjectGridConfiguration() - Method in interface com.ibm.websphere.objectgrid.deployment.ObjectGridDeployment
Get the ObjectGridConfiguration object that will be used to configure the ObjectGrid as it deployed to the containers.
getObjectGridDeployment(String) - Method in interface com.ibm.websphere.objectgrid.deployment.DeploymentPolicy
Get an ObjectGridDeployment that has been added to this DeploymentPolicy.
getObjectGridDeployments() - Method in interface com.ibm.websphere.objectgrid.deployment.DeploymentPolicy
Get the Collection of ObjectGridDeployment objects that have been added to this DeploymentPolicy.
getObjectGridManager() - Static method in class com.ibm.websphere.objectgrid.ObjectGridManagerFactory
Returns the ObjectGridManager singleton.
getObjectGridName() - Method in interface com.ibm.websphere.objectgrid.deployment.ObjectGridDeployment
Get the name of the ObjectGrid represented by this ObjectGridDeployment.
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 class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Returns the name of the ObjectGrid that handel the cache
getObjectGridName() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Returns the name of the ObjectGrid that handel the cache
getObjectGridName() - Method in class com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository.OSGiServiceKey
Retrieve the name of the ObjectGrid.
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.
getObjectGridName() - Method in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
The name of the ObjectGrid that is connected.
getObjectGridName() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Get the eXtreme Scale specific property: ObjectGridName
getObjectGridName() - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Returns the object grid name for the connection.
getObjectGridName() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: ObjectGridName
getObjectGridNames() - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Gets the names of all ObjectGrids and their mapsets in the domain.
getObjectGridResource() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Get the eXtreme Scale specific property: ObjectGridResource
getObjectGridResource() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: ObjectGridResource
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.
getObjectGridType() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Returns the ObjectGrid type.
getObjectGridType() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Returns the ObjectGrid type.
getObjectGridURL() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Get the eXtreme Scale specific property: ObjectGridURL
getObjectGridURL() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: ObjectGridURL
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.
getOGStatsFileName() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the file name of the CSV statistics file for the ObjectGrid.
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.
getOGStatsWriteRate() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets the write rate of the CSV statistics files for the ObjectGrid in seconds.
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.
getOrderByElements() - Method in interface com.ibm.websphere.projector.md.TupleAssociation.OrderByInfo
The elements used to order the association collection.
getOrderByInfo() - Method in interface com.ibm.websphere.projector.md.TupleAssociation
Identifies how to order a multi-valued association.
getOrderByString() - Method in interface com.ibm.websphere.projector.md.TupleAssociation.OrderByInfo
The order-by string in the format:
getOSGiManager(ObjectGrid) - Method in class com.ibm.websphere.objectgrid.osgi.OSGiManagerFactory
Return the ObjectGridOSGiManager for this ObjectGrid instance.
getOSGiService() - Method in interface com.ibm.websphere.objectgrid.config.Plugin
Get the OSGi service name configured for this Plugin.
getOSGiServiceRepository() - Method in class com.ibm.websphere.objectgrid.osgi.OSGiManagerFactory
Return the OSGiServiceRepository.
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
getParsedNames() - Method in class com.ibm.websphere.objectgrid.security.AgentPermission
Returns an array which contains the ObjectGrid name and map name.
getParsedNames() - Method in class com.ibm.websphere.objectgrid.security.MapPermission
Returns an array which contains the object grid name and map name.
getParsedNames() - Method in class com.ibm.websphere.objectgrid.security.ServerMapPermission
Returns an array which contains the object grid name and map name.
getPartition() - Method in interface com.ibm.websphere.objectgrid.datagrid.EntryErrorValue
The partition of the agent that threw the exception.
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.
getPartitionCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
Gets the partition count statistic.
getPartitionHashCode(DataObjectContext, XsDataInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.KeyDataSerializer.Partitionable
Invoked from clients when it needs to use a partition other than the one normally calculated from it's identity.
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.
getPath() - Method in interface com.ibm.websphere.objectgrid.stats.StatsModule
Gets the statistic path to this module.
getPathSeparator() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptor
Returns the string to use to use for attribute navigation for embedded attributes.er.f
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).
getPercentage() - Method in interface com.ibm.websphere.objectgrid.stats.PercentageStatistic
Gets the percentage value of this statistic where getPercentage = getValue / getBase * 100
getPeriodLength() - Method in interface com.ibm.websphere.objectgrid.stats.ActiveLongStatistic
Gets the length of the time period in milliseconds.
getPersistenceProperties(ObjectGrid, int) - Method in interface com.ibm.websphere.objectgrid.jpa.JPAPropertyFactory
Provide the persistence properties to override those in the persistence.xml.
getPersistenceUnitName() - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
Retrieve the JPA Persistence Unit name
getPersistenceUnitName() - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
 
getPlacementDeferralInterval() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Gets the placement deferral interval.
getPlacementScope() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Retrieve the scope used for partition placement.
getPlacementScope() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Retrieve the scope used for partition placement.
getPlacementScopeTopology() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Retrieve the link topology used to perform intradomain replication.
getPlacementScopeTopology() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Retrieve the link topology used to perform intradomain replication.
getPlacementStrategy() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the placement strategy employed by this MapSet.
getPlan() - Method in interface com.ibm.websphere.objectgrid.em.Query
Return a string representation of the query plan.
getPlan() - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Return a string representation of the query plan.
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.
getPlanCreationTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.QueryStatsModule
Gets the plan creation time statistic for this query.
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.
getPreloadPartition() - Method in class com.ibm.websphere.objectgrid.jpa.JPALoader
 
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.
getPrimaryRevisions() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Provides revisions for all primary shards in the container in the form of a TabularData object, where each CompositeData (row in the TabularData) contains the following items:
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.
getProjector(EntityManager) - Static method in class com.ibm.websphere.objectgrid.em.ProjectorFactory
Retrieves the Projector associated with the specified EntityManager.
getPropagateMode() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Gets the propagate mode.
getPropagateService() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Gets the propagate service
getPropagateVersionOption() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Gets the propagate version option.
getProperties() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
getProperties() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
getProperties() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Extract properties from a MapIndexPlugin instance.
getProtocol() - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Gets the SSL protocol for this SSL configuration.
getPutMode() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Retrieve the current PutMode set for this ObjectMap instance.
getQueryExecutionCount(String) - Method in interface com.ibm.websphere.objectgrid.management.QueryManagerMBean
Gets the query's execution count attribute loaded up by the retrieveStatsModule() method.
getQueryExecutionCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.QueryStatsModule
Gets the execution count statistic for this query.
getQueryExecutionTime(String) - Method in interface com.ibm.websphere.objectgrid.management.QueryManagerMBean
Gets the query's execution time attribute loaded up by the retrieveStatsModule() method.
getQueryExecutionTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.QueryStatsModule
Gets the execution time statistic for this query.
getQueryFailureCount(String) - Method in interface com.ibm.websphere.objectgrid.management.QueryManagerMBean
Gets the query's failure count attribute loaded up by the retrieveStatsModule() method.
getQueryFailureCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.QueryStatsModule
Gets the failure count statistic for this query.
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.
getQueryResultCount(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.QueryStatsModule
Gets the result count statistic for this query.
getQuorum() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Returns whether or not this catalog service is enforcing quorum.
getQuorumCatalogServers() - Method in interface com.ibm.websphere.objectgrid.management.QuorumManagerMBean
Retrieve the number of catalog service processes required for quorum.
getRanking(String) - Method in interface com.ibm.websphere.objectgrid.osgi.ObjectGridOSGiManager
Get the current ranking for a specific service used by a grid
getRankings() - Method in interface com.ibm.websphere.objectgrid.osgi.ObjectGridOSGiManager
Get the current service rankings for all services used by an ObjectGrid.
getReadOnly() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Retrieves the map type.
getRealObject(Object) - Static method in class com.ibm.websphere.objectgrid.osgi.ProxyHelper
Get the real object from the proxy object.
getReason() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryNotificationEvent
Retrieve the reason for this notification event
getRecordFactory() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Retrieve the RecordFactory instance
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.
getReduceTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
Gets the reduce time statistic.
getReference() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Gets the Reference instance
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.
getReplicaMode() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Returns the replica mode
getReplicaMode() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Returns the replica mode
getReplicaReadEnabled() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Returns setting of whether reading from the replica is enabled
getReplicaReadEnabled() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Returns whether reading from the replica is enabled
getReplicationGroup() - Method in exception com.ibm.websphere.objectgrid.ObjectGridRPCException
Deprecated. Returns the replication group identifier for this exception.
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
Deprecated. Returns the current replication mode
getRequest() - Method in interface com.ibm.websphere.xs.sessionmanager.SessionIDOverride.SessionIDContext
This method will be called by the SessionIDOverride.getID(SessionIDContext) implementation to retrieve the HttpServletRequest object associated with the request.
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.
getResourceAdapter() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Retrieve the associated eXtreme Scale resource adapter instance.
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.
getResultInflationTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
Gets the result inflation time statistic.
getResultIterator() - Method in interface com.ibm.websphere.objectgrid.em.Query
Execute a SELECT query and return the query results using an Iterator where each result is either an Object (for a single valued query) or Object[] (for a multiple valued query).
getResultIterator(Class) - Method in interface com.ibm.websphere.objectgrid.em.Query
Execute a SELECT query and return the query results using an entity Iterator where the entity type is determined by the resultType parameter.
getResultIterator() - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Execute a SELECT query and return the query results in an Iterator where each result is either an Object (for a single valued query) or Object[] (for a multiple valued query).
getResultMap() - Method in interface com.ibm.websphere.objectgrid.em.Query
Execute a SELECT query and return the query results in an ObjectMap with the results in query-specified order.
getResultMap() - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Execute a SELECT query and return the query results in an ObjectMap with the results in query-specified order.
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.
getResultSerializationTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
Gets the result serialization time statistic.
getResultSetInfo() - Method in class com.ibm.websphere.xs.ra.XSConnection
Gets the information on the ResultSet functionality supported by a connected eXtreme Scale instance.
getResultType() - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Return the current ResultType for the ObjectQuery.
getRevisions() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Provides revisions for all shards in the server in the form of a TabularData object, where each CompositeData (row in the TabularData) contains the following items:
getRollbackOnly() - Method in interface com.ibm.websphere.objectgrid.em.EntityTransaction
Determine whether the current transaction has been marked for rollback.
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.
getSerializerAccessor() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectContext
Retrieve the SerializerAccessor associated with this DataObjectContext
getServerName() - Method in interface com.ibm.websphere.objectgrid.datagrid.EntryErrorValue
The server where this exception occurred
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.
getServerName() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the name used in identifying this server.
getServerProperties() - Static method in class com.ibm.websphere.objectgrid.server.ServerFactory
Returns the properties object instance used in configuring the server.
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.
getServerSecurityFileName() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Retrieves the server security file name.
getService() - Method in class com.ibm.websphere.objectgrid.plugins.osgi.BluePrintServiceFactory
 
getService() - Method in interface com.ibm.websphere.objectgrid.plugins.osgi.PluginServiceFactory
 
getServiceName() - Method in exception com.ibm.websphere.objectgrid.osgi.ServiceUpdateException
 
getServiceRanking() - Method in exception com.ibm.websphere.objectgrid.osgi.ServiceUpdateException
 
getServletContext() - Method in interface com.ibm.websphere.xs.sessionmanager.SessionIDOverride.InitializationContext
This method will be called by the SessionIDOverride.init(InitializationContext) implementation to retrieve the ServletContext object associated with the web application.
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.revision.CollisionData
Retrieves the session that this revision transaction is operating under.
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.
getSession() - Method in class com.ibm.websphere.xs.ra.XSConnection
Retrieve the ObjectGrid Session associated with this connection.
getSessionHandle() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryNotificationEvent
Retrieve a SessionHandle object which can be used to retrieve the cache entry that triggered this notification.
getSessionHandle() - Method in interface com.ibm.websphere.objectgrid.Session
Retrieves a handle for this session.
getSessionHandles(KeyType) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryCache
Returns SessionHandle objects that can be used to retrieve all query matches associated with this key.
getSessionID() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets the ID of the session instance associated with this MBean.
getSessionID() - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Get the session ID.
getSessionStatsModule() - Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
Gets a string representation of the SessionStatsModule attributes loaded up by the retrieveStatsModule() method.
getShardMappings() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get a List of ShardMappings that have been added to this MapSet.
getShardType() - Method in interface com.ibm.websphere.objectgrid.deployment.ShardMapping
Get the type of shard that this mapping represents.
getSingleResult() - Method in interface com.ibm.websphere.objectgrid.em.Query
Execute a SELECT query that returns a single result.
getSingleResult() - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Execute a SELECT query that returns a single result.
getSingleton() - Static method in class com.ibm.websphere.objectgrid.security.AnonymousPrincipal
Gets an AnonymousPrincipal instance
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.
getSpecStringValue() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Gets the string representation of the statistics specification
getSpecValue() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Gets the integer representation of the statistics specification
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.
getStartTime() - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Gets the time the first measurement was taken.
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.
getState() - Method in interface com.ibm.websphere.objectgrid.plugins.BackingMapLifecycleListener.LifecycleEvent
Get the lifecycle state occurring for this event.
getState() - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridLifecycleListener.LifecycleEvent
Retrieve the lifecycle state occurring for this event.
getStateManager() - Static method in class com.ibm.websphere.objectgrid.StateManagerFactory
Returns the StateManager singleton.
getStatsAccessor() - Static method in class com.ibm.websphere.objectgrid.stats.StatsAccessorFactory
Gets a StatsAccessor instance.
getStatsFact(String[], int) - Method in interface com.ibm.websphere.objectgrid.stats.StatsAccessor
Retrieves the StatsFact object based on the path.
getStatsFact(String, int) - Method in interface com.ibm.websphere.objectgrid.stats.StatsAccessor
Retrieves the StatsFact object based on the path.
getStatsModule() - Method in interface com.ibm.websphere.objectgrid.stats.StatsFact
Gets the StatsModule object associated with this StatsFact instance.
getStatsSpec() - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Retrieve the current statistics specification for the server.
getStatsSpec() - Method in interface com.ibm.websphere.objectgrid.stats.StatsAccessor
Retrieves the StatsSpec defined for the process.
getStatsSpec() - Method in interface com.ibm.websphere.objectgrid.stats.StatsModule
Gets the StatsSpec object associated with this stats module.
getStatsSpecification() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the statistics specification that this process should start with.
getStatus() - Method in interface com.ibm.websphere.objectgrid.management.ContainerMBean
Retrieve the status information for the shards in this container.
getSubject() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSSubjectSourceImpl
Converts a passed-in Subject to a new Subject object.
getSubject() - Method in interface com.ibm.websphere.objectgrid.security.plugins.SubjectSource
Gets a Subject representing the ObjectGrid client.
getSumOfSquares() - Method in interface com.ibm.websphere.objectgrid.stats.TimeStatistic
Gets the sum of squares of the time values.
getSupersetEntityMetadata() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
Return the EntityMetadata for the superset of this EntityMetadata.
getSyslogFacility() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the Syslogd Facility
getSyslogHostName() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the Syslogd Server host full name or IP address
getSyslogHostPort() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the Syslogd Server Port Number
getSyslogThreshold() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the Syslogd Threshold.
getTargetClass() - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Retrieve the name of the class representing the target of a relationship.
getTargetEntityMetadata() - Method in interface com.ibm.websphere.projector.md.TupleAssociation
The EntityMetadata for the target of this association
getTargetEntityName() - Method in interface com.ibm.websphere.projector.md.TupleAssociation
The name of the target entity
getTargetMapName() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Association
Retrieves name of the associated map.
getThrowable() - Method in interface com.ibm.websphere.objectgrid.writebehind.FailedUpdateElement
Retrieve the Throwable object which indicates why the write-behind update failed.
getTimeBasedDBUpdateConfig() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Get the time-based database update configuration object.
getTimestampField() - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
 
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.
getTopic() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
 
getTopicConnectionFactory() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
 
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.
getTotalDurationTime(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
Gets the total duration time statistic.
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.
getTotalTime() - Method in interface com.ibm.websphere.objectgrid.stats.TimeStatistic
Gets the total time since the beginning of the measurement.
getTraceFileName() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves a reference to the file name the server will use for trace.
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.
getTraceSpecification() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the initial trace specification the server should use.
getTransaction() - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Return the resource-level transaction object.
getTransactionCallback() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Retrieves the TransactionCallback object.
getTransactionChanges(boolean) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexInfo
Returns the set of all changes made by the current transaction to the ObjectMap that is returned by the getMap() method.
getTransactionChanges(boolean, OutputFormat, OutputFormat) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexInfo
Returns the set of all changes made by the current transaction to the ObjectMap that is returned by the getMap() method.
getTransactionChanges(List) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexInfo
Returns the set of changes as they apply to a particular set of keys in the current transaction for the ObjectMap that is returned by the getMap() method.
getTransactionChanges(List, OutputFormat, OutputFormat) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexInfo
Returns the set of changes as they apply to a particular set of keys in the current transaction for the ObjectMap that is returned by the getMap() method.
getTransactionIsolation() - Method in interface com.ibm.websphere.objectgrid.Session
Retrieves the current transaction isolation level for this session.
getTransactionLogSequence() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexInfo
Returns the set of all changes made by the current transaction to the ObjectMap that is returned by the getMap() method.
getTransactionLogSequence(OutputFormat, OutputFormat) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexInfo
Returns the set of all changes made by the current transaction to the ObjectMap that is returned by the getMap() method.
getTransactionTime(String, boolean) - Method in interface com.ibm.websphere.objectgrid.stats.OGStatsModule
Retrieves the transaction response time statistic for committed transactions for a specific transaction type.
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.
getTransport() - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Returns the transport used by the catalog service domain.
getTransport() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Returns the transport for the catalog service domain
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.
getTupleFromEntity(Object, EntityMetadata, boolean) - Method in interface com.ibm.websphere.projector.Projector
Convert the specified entity object to a key or value Tuple using the specified EntityMetadata.
getTuplePosition() - Method in interface com.ibm.websphere.projector.md.TupleAttribute
Get the position of this attribute in the tuple.
getTxCallback() - Method in class com.ibm.websphere.objectgrid.jpa.JPALoader
Retrieve the JPA transaction callback instance.
getTxCommitProtocol() - Method in interface com.ibm.websphere.objectgrid.Session
Retrieve the current commit protocol for this Session.
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.management.TransactionMBean
Retrieve the type of the shard this TransactionMBean is instantiate on.
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.WSSubjectSourceImpl
Gets the subject type
getType() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenCredentialGenerator
Gets the subject type.
getType() - Method in interface com.ibm.websphere.projector.md.TupleAttribute
The primitive type for the attribute
getUnavailableServiceRankings() - Method in exception com.ibm.websphere.objectgrid.osgi.ServiceNotAvailableException
 
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.
getUnit() - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Gets the unit of measurement for this statistic.
getUsedBytes(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.MapStatsModule
Gets the number of bytes in use by the map.
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.
getValue() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryNotificationEvent
Retrieve the value of the cache entry that triggered this notification
getValue() - Method in interface com.ibm.websphere.objectgrid.continuousquery.filter.FilterContent
Retrieves the value of the object to be filtered.
getValue() - Method in interface com.ibm.websphere.objectgrid.revision.RevisionElement
The value for this specific revision of the entry.
getValue() - Method in interface com.ibm.websphere.objectgrid.stats.PercentageStatistic
Gets the numeric value of this statistic where getPercentage = getValue / getBase * 100
getValue() - Method in interface com.ibm.websphere.xs.rest.RestValue
Return contained value
getValue() - Method in class com.ibm.websphere.xsa.RestValue
Deprecated. Return contained value
getValueClass() - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Retrieve the type of object that is stored in the BackingMap.
getValueDataDescriptor() - Method in interface com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer
Retrieve the metadata for the objects that this DataSerializer understands.
getValueFactory() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectContext
Returns a ValueFactory used to create Value objects.
getValueMetadata() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
The TupleMetadata for the entity's value.
getValueOutputFormat() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Retrieves the data format for all data access APIs that return cache values.
getValueOutputFormat() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Retrieves the data format for all data access APIs that return cache values.
getValueOutputFormat() - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Retrieves the data format for all data access APIs that return cache values for the current session.
getValueProperties() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Retrieve the String property from the ValueDataSerializer.
getValueSerializerPlugin() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
 
getValueSerializerPlugin() - Method in interface com.ibm.websphere.objectgrid.plugins.io.MapSerializerPlugin
The ValueSerializer to use for all value entries in the map.
getVersion(DataObjectContext, XsDataInputStream, XsDataOutputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer.Versionable
Retrieve the serialized form of the attribute that identifies the version.
getVersionAttributePosition() - Method in interface com.ibm.websphere.projector.md.TupleMetadata
Retrieve the position of the version attribute.
getVersionedObjectForValue(Object) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.NoVersioningOptimisticCallback
Deprecated.  
getVersionedObjectForValue(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.OptimisticCallback
Deprecated. Returns the value (must be a copy) or it may return an attribute of the value that can be used for versioning purposes.
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.
getWorkingDirectory() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the working directory for the ObjectGrid server runtime.
getWriteBehind() - Method in interface com.ibm.websphere.objectgrid.BackingMap
Get the write-behind parameter.
getXAResources(ActivationSpec[]) - Method in class com.ibm.websphere.xs.ra.XSResourceAdapter
This method returns null as the XA protocol is not supported
getXIOChannelProps() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Returns a copy of the map of overriding properties for all channels.
getXIOTimeout() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Returns the current timeout for server requests using the XIO transport.
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
getZoneName() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieve the zone name.
getZoneRule() - Method in interface com.ibm.websphere.objectgrid.deployment.ShardMapping
Get the ZoneRule associated with this ShardMapping.
getZones() - Method in interface com.ibm.websphere.objectgrid.deployment.ZoneRule
Get the zones that are part of this ZoneRule.
GlobalIndexException - Exception in com.ibm.websphere.objectgrid.plugins.index
Used when global index operation run into error.
GlobalIndexException() - Constructor for exception com.ibm.websphere.objectgrid.plugins.index.GlobalIndexException
Constructs a new GlobalIndexException with null as its detail message.
GlobalIndexException(String) - Constructor for exception com.ibm.websphere.objectgrid.plugins.index.GlobalIndexException
Constructs a new GlobalIndexException with the specified detail message.
GlobalIndexException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.index.GlobalIndexException
Constructs a new GlobalIndexException with a specified cause.
GTEFilter<AttributeType,MatchType> - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This checks if an attribute is greater than or equals to a scalar.
GTEFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.GTEFilter
Constructor for serialization only.
GTEFilter(String, MatchType) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.GTEFilter
 
GTFilter<AttributeType,MatchType> - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This checks if an attribute is greater than a scalar.
GTFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.GTFilter
Constructor for serialization only.
GTFilter(String, MatchType) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.GTFilter
 

H

hasBinaryEquality() - Method in interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer.Identifiable
Answers true when the serialized form of the data object can be used directly to calculate equality and the hashCode.
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.continuousquery.filter.AbstractCQFilter
 
hashCode() - Method in class com.ibm.websphere.objectgrid.em.FlushModeType
 
hashCode() - Method in class com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository.OSGiServiceKey
 
hashCode() - Method in class com.ibm.websphere.objectgrid.plugins.index.MapIndex.SpecialValue
 
hashCode() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.DataObjectKey
Return the hashCode() for the key's identity.
hashCode(DataObjectContext, XsDataInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer.Identifiable
For the serialized data object, retrieve the hash code for that object.
hashCode() - Method in class com.ibm.websphere.objectgrid.security.AgentPermission
Returns the hash code value for this AgentPermission object.
hashCode() - Method in class com.ibm.websphere.objectgrid.security.MapPermission
Returns the hash code value for this MapPermission object.
hashCode() - Method in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Returns the hash code value for this ObjectGridPermission object.
hashCode() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.ClientCertificateCredential
Returns the hashcode of the ClientCertificateCredential object.
hashCode() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleDeptPrincipal
Returns a hash code for this SimpleDeptPrincipal.
hashCode() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleUserPrincipal
Returns a hash code for this SimpleUserPrincipal.
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 class com.ibm.websphere.objectgrid.security.ServerMapPermission
Returns the hash code value for this ServerMapPermission object.
hashCode() - Method in interface com.ibm.websphere.objectgrid.TxID
Returns the hashcode of the Tx identifier.
hashCode() - Method in class com.ibm.websphere.projector.md.AccessType
Retrieves the hash code of this AccessType object.
hashCode() - Method in class com.ibm.websphere.projector.md.AssociationType
Retrieves the hash code of this AssociationType object.
hashCode() - Method in class com.ibm.websphere.projector.md.FetchType
Retrieves the hash code of this FetchType object.
hashCode() - Method in interface com.ibm.websphere.projector.Tuple
Returns the hash code value for this Tuple.
hashCode() - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
 
hashCode() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
 
hashCode() - Method in class com.ibm.websphere.xsa.RestValue
Deprecated.  
HashIndex - Class in com.ibm.websphere.objectgrid.plugins.index
HashIndex is a built-in index implementation of a MapIndexPlugin and can be used for typical indexing operations.
HashIndex() - Constructor for class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Creates a new HashIndex object.
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.
HashIndexStatsModule - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a statistic module for a HashIndex.
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_AGGRESSIVE - Static variable in interface com.ibm.websphere.objectgrid.management.CoreGroupServiceMBean
Deprecated. This MBean interface is deprecated in 7.1. Use the CatalogServiceManagementMBean MBean interface.
HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Constant representing a heartbeat 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_RELAXED - Static variable in interface com.ibm.websphere.objectgrid.management.CoreGroupServiceMBean
Deprecated. This MBean interface is deprecated in 7.1. Use the CatalogServiceManagementMBean MBean interface.
HEARTBEAT_FREQUENCY_LEVEL_RELAXED - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Constant representing a heartbeat 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.
HEARTBEAT_FREQUENCY_LEVEL_TYPICAL - Static variable in interface com.ibm.websphere.objectgrid.management.CoreGroupServiceMBean
Deprecated. This MBean interface is deprecated in 7.1. Use the CatalogServiceManagementMBean MBean interface.
HEARTBEAT_FREQUENCY_LEVEL_TYPICAL - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Constant representing a heartbeat level at a typical rate.
HEUR_COMMIT - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Indicates that this transaction was heuristically committed at this partition.
HEUR_ROLLBACK - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Indicates that this transaction was heuristically rolled back at this partition.
HINT_USEINDEX - Static variable in interface com.ibm.websphere.objectgrid.em.Query
Hint to the query engine to use the specified index.
HINT_USEINDEX - Static variable in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Hint to the query engine to use the specified index.
HttpSessionConfigurationUtility - Class in com.ibm.websphere.objectgrid.httpsession
The HTTPSessioncConfigurationUtility is a singleton utility class that allows configuring or overriding the ObjectGrid HTTP Session plugin options at the server scope, affecting all web applications for the server.

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.
ibmGetPartition() - Method in interface com.ibm.websphere.objectgrid.plugins.PartitionableKey
Used to obtain an object from the key that should be used for partitioning.
ibmGetRealValue() - Method in interface com.ibm.websphere.objectgrid.plugins.ValueProxyInfo
Returns the real value object this proxy represents.
Id - Annotation Type in com.ibm.websphere.projector.annotations
Specifies the primary key property or field of an entity.
IdClass - Annotation Type in com.ibm.websphere.projector.annotations
The IdClass annotation can be used to specify a composite primary key class that is mapped to multiple fields or properties of an entity.
implies(Permission) - Method in class com.ibm.websphere.objectgrid.security.AgentPermission
Checks if the specified permission is "implied" by this object.
implies(Permission) - Method in class com.ibm.websphere.objectgrid.security.MapPermission
Checks if the specified permission is "implied" by this object.
implies(Permission) - Method in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Checks if the specified permission is "implied" by this object.
implies(Permission) - Method in class com.ibm.websphere.objectgrid.security.ServerMapPermission
Checks if the specified permission is "implied" by this object.
includesValues() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryCache
Returns true if this cache includes the values associated with the keys that have matched the query.
IncompatibleDeploymentPolicyException - Exception in com.ibm.websphere.objectgrid
This exception will occur if information in the DeploymentPolicy XML file is not compatible with the ObjectGrid XML file.
IncompatibleDeploymentPolicyException() - Constructor for exception com.ibm.websphere.objectgrid.IncompatibleDeploymentPolicyException
Constructs a new IncompatibleDeploymentPolicyException with null as its detail message.
IncompatibleDeploymentPolicyException(String) - Constructor for exception com.ibm.websphere.objectgrid.IncompatibleDeploymentPolicyException
Constructs a new IncompatibleDeploymentPolicyException with the specified detail message.
IncompatibleDeploymentPolicyException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.IncompatibleDeploymentPolicyException
Constructs a new IncompatibleDeploymentPolicyException with a specified cause.
IncompatibleDeploymentPolicyException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.IncompatibleDeploymentPolicyException
Constructs a new IncompatibleDeploymentPolicyException with the specified detail message and cause.
Index - Annotation Type in com.ibm.websphere.objectgrid.em.annotations
Identifies an entity attribute as indexed.
INDEX_ALL - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for all of the index statistics
INDEX_ALL_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for all of the index statistics
IndexAlreadyDefinedException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when an attempt is made to define two indexes with the same name.
IndexAlreadyDefinedException() - Constructor for exception com.ibm.websphere.objectgrid.IndexAlreadyDefinedException
Constructs a new IndexAlreadyDefinedException with null as its detail message.
IndexAlreadyDefinedException(String) - Constructor for exception com.ibm.websphere.objectgrid.IndexAlreadyDefinedException
Constructs a new IndexAlreadyDefinedException with the specified detail message.
IndexAlreadyDefinedException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.IndexAlreadyDefinedException
Constructs a new IndexAlreadyDefinedException with the specified detail message and cause.
IndexAlreadyDefinedException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.IndexAlreadyDefinedException
Constructs a new IndexAlreadyDefinedException with a specified cause.
IndexNotReadyException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when an attempt is made to get dynamic index that is not in ready state.
IndexNotReadyException() - Constructor for exception com.ibm.websphere.objectgrid.IndexNotReadyException
Constructs a new IndexNotReadyException with null as its detail message.
IndexNotReadyException(String) - Constructor for exception com.ibm.websphere.objectgrid.IndexNotReadyException
Constructs a new IndexNotReadyException with the specified detail message.
IndexNotReadyException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.IndexNotReadyException
Constructs a new IndexNotReadyException with the specified detail message and cause.
IndexNotReadyException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.IndexNotReadyException
Constructs a new IndexNotReadyException with a specified cause.
IndexUndefinedException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when an undefined index is looked up on a Map.
IndexUndefinedException() - Constructor for exception com.ibm.websphere.objectgrid.IndexUndefinedException
Constructs a new IndexUndefinedException with null as its detail message.
IndexUndefinedException(String) - Constructor for exception com.ibm.websphere.objectgrid.IndexUndefinedException
Constructs a new IndexUndefinedException with the specified detail message.
IndexUndefinedException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.IndexUndefinedException
Constructs a new IndexUndefinedException with the specified detail message and cause.
IndexUndefinedException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.IndexUndefinedException
Constructs a new IndexUndefinedException with a specified cause.
inflate(ObjectInputStream, ObjectGrid) - Static method in class com.ibm.websphere.objectgrid.plugins.LogSequenceTransformer
Provides an alternative to the standard serialization method of readObject.
inflateDataObject(DataObjectContext, XsDataInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer
Inflate a data object from the specified data input stream.
inflateDataObjectAttributes(DataObjectContext, XsDataInputStream, Object) - Method in interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer.DataAttributeInflatable
From the specified data input stream, inflate the specified attributes.
inflateDataObjectVersion(DataObjectContext, XsDataInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer.Versionable
From the specified Version object, inflate the version attribute
inflateKey(ObjectInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectTransformer
Deprecated. Reads a key object from the specified stream.
inflateValue(ObjectInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectTransformer
Deprecated. Reads a value object from the specified stream.
inflateVersionedValue(ObjectInputStream) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.NoVersioningOptimisticCallback
Deprecated.  
inflateVersionedValue(ObjectInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.OptimisticCallback
Deprecated. Reads a versioned value object from the specified stream.
init(SessionIDOverride.InitializationContext) - Method in interface com.ibm.websphere.xs.sessionmanager.SessionIDOverride
This method will be called by the WXS Http session client when a web application is first initialized, typically the first request to a web application.
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.
Initializable - Interface in com.ibm.websphere.objectgrid.plugins
Java bean plug-ins can implement this interface to allow initializing the plug-in after it's state has been set.
initialize(ObjectGrid, BackingMap) - Method in class com.ibm.websphere.objectgrid.jpa.JPAEntityLoader
 
initialize(ObjectGrid) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
reserve a slot for the JPA entity manager during the ObjectGrid initialization.
initialize(Session) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
 
initialize() - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Begins the bootstrapping of the ObjectGrid and Session instances.
initialize(DataCacheManager) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Initialize this data cache
initialize(DataCacheManager) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Sets the configuration for initializing Query Cache
initialize(Session) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
This is called when the ObjectGrid is initialized.
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(Session) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Users do not call this method directly, an ObjectGrid instance's initalize() methods will call this method at the appropriate time.
initialize(ObjectGrid) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
Deprecated.  
initialize(BackingMap, EvictionEventCallback) - Method in interface com.ibm.websphere.objectgrid.plugins.Evictor
Called by a BackingMap instance during the evictor initialization time.
initialize() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
initialize() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
initialize() - Method in interface com.ibm.websphere.objectgrid.plugins.Initializable
Invoked when the bean's state has been set and is ready to be initialized.
initialize() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Perform initialization of the map serializer, including but not limited to the following steps.
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.
initialize(ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.revision.CollisionArbiter
Called when the ObjectGrid which this arbiter is attached to is initialized.
initialize(Subject, CallbackHandler, Map, Map) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
Initializes the login module.
initialize(Subject, CallbackHandler, Map, Map) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPLoginModule
Deprecated. Initializes this LoginModule.
initialize(Subject, CallbackHandler, Map<String, ?>, Map<String, ?>) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleLDAPLoginModule
 
insert(Object, Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Performs an explicit insert of a given entry.
insert(Object, Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Performs an explicit insert of a given entry.
INSERT - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the INSERT operation.
INSERT - Static variable in class com.ibm.websphere.objectgrid.security.MapPermission
Insert permission constant
INSERT_UPDATE - Static variable in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig.DBUpdateMode
INSERT_UPDATE type indicates to update the existing entries in the ObjectGrid map with the latest values from database.
instance() - Static method in class com.ibm.websphere.objectgrid.jpa.dbupdate.TimeBasedDBUpdater
 
instance() - Static method in class com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptorFactory
Retrieve an instance of the DataDescriptorFactory
instance() - Static method in class com.ibm.websphere.xs.rest.RestValueFactory
Return the singleton instance of RestValueFactory
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) - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Invalidate the entity instance from the ObjectGrid cache, including the transactional, client and server caches.
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.
INVALIDATE - Static variable in class com.ibm.websphere.objectgrid.plugins.DistributionMode
The INVALIDATE distribution mode is used to communicate invalidates to the receivers of the LogSequence.
INVALIDATE - Static variable in class com.ibm.websphere.objectgrid.security.MapPermission
Invalidate permission constant
INVALIDATE_CONDITIONAL - Static variable in class com.ibm.websphere.objectgrid.plugins.DistributionMode
The INVALIDATE_CONDITIONAL is very much like the INVALIDATE distribution mode except that it also takes into account the versioned value data associated with each entry.
INVALIDATE_CONDITIONAL_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setInvalidationStrategy(String) or setReplicationStrategy(String) method for setting invalidationStrategy or replicationStrategy as INVALIDATE_CONDITIONAL.
INVALIDATE_ONLY - Static variable in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig.DBUpdateMode
INVALIDATE_ONLY type indicates to invalidate the entries in the ObjectGrid map if the corresponding records in the database have changed.
INVALIDATE_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setInvalidationStrategy(String) or setReplicationStrategy(String) method for setting invalidationStrategy or replicationStrategy as INVALIDATE.
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.
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.
InvalidSubjectException - Exception in com.ibm.websphere.objectgrid.security.plugins
This exception indicates the Subject passed to an ObjectGrid server is not a valid subject.
InvalidSubjectException() - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.InvalidSubjectException
Constructs a new InvalidSubjectException with null as its detail message.
InvalidSubjectException(String) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.InvalidSubjectException
Constructs a new InvalidSubjectException with the specified detail message.
InvalidSubjectException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.InvalidSubjectException
Constructs a new InvalidSubjectException with the specified detail message and cause.
InvalidSubjectException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.security.plugins.InvalidSubjectException
Constructs a new InvalidSubjectException with a specified cause.
InverseRangeIndex - Class in com.ibm.websphere.objectgrid.plugins.index
InverseRangeIndex is a built-in index implementation of MapIndexPlugin for storing range data and could be used for looking up single item with in a range.
InverseRangeIndex() - Constructor for class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
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.
isActive() - Method in interface com.ibm.websphere.objectgrid.em.EntityTransaction
Indicate whether a transaction is in progress.
isAnyAgentStatEnabled() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Checks whether any agent statistic is enabled
isAnyIndexStatEnabled() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Checks whether any index statistic is enabled
isAnyMapStatEnabled() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Checks whether any map statistic is enabled
isAnyOGStatEnabled() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Checks whether any ObjectGrid statistic is enabled
isAnyQueryStatEnabled() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Checks whether any query statistic is enabled
isAnyReplicationStatEnabled() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Checks whether any replication statistic is enabled
isAnyServerStatEnabled() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Checks whether any server statistic is enabled
isAnySessionStatEnabled() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Checks whether any session statistic is enabled
isAscending() - Method in interface com.ibm.websphere.projector.md.TupleAssociation.OrderByInfo.OrderByElement
If true, order the collection in ascending order based on the field name.
isAutoReplaceLostShards() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the replace lost shards setting.
isBeginNoWriteThrough() - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Returns flag indicating whether the Session transaction should be started using using the Session.beginNoWriteThrough() method.
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.
isCascadeInvalidate() - Method in interface com.ibm.websphere.projector.md.TupleAssociation.CascadeInfo
If true, cascade invalidate operations to the target entity.
isCascadeMerge() - Method in interface com.ibm.websphere.projector.md.TupleAssociation.CascadeInfo
If true, cascade merge operations to the target entity.
isCascadePersist() - Method in interface com.ibm.websphere.projector.md.TupleAssociation.CascadeInfo
If true, cascade persist operations to the target entity.
isCascadeRefresh() - Method in interface com.ibm.websphere.projector.md.TupleAssociation.CascadeInfo
If true, cascade refresh operations to the target entity.
isCascadeRemove() - Method in interface com.ibm.websphere.projector.md.TupleAssociation.CascadeInfo
If true, cascade remove operations to the target entity.
isCatalogServer() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Returns whether this process is defined as a catalog service or not.
isChannelFrameworkEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Returns if the ChannelFramework setting was enabled for the TransportMode on the IBM ORB properties
isClosed() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Affirms if this stream has been closed.
isClosed() - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Affirms if this stream has been closed.
isCollection() - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Attribute
Returns true if the attribute has zero or more values.
isCommitting() - Method in interface com.ibm.websphere.objectgrid.Session
Returns whether the current session transaction is performing a session commit() operation.
isCompressed() - Method in class com.ibm.websphere.xsa.RestValue
Deprecated. Indicate if the contained value is compressed
isConditional() - Method in class com.ibm.websphere.objectgrid.plugins.DistributionMode
Checks whether the mode is conditional mode or not.
isDestroyed() - Method in interface com.ibm.websphere.objectgrid.plugins.Destroyable
Answers true if the bean is in the destroyed state, false otherwise.
isDestroyed() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
isDestroyed() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
isDestroyed() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
 
isDevelopmentMode() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the development mode setting.
isDirty() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns whether this LogSequence has any LogElements that would "dirty" a Map.
isDiskOverflowEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Returns true if and only if the disk-overflow feature is enabled, false otherwise.
isEmpty() - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.
isEnabled() - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Gets whether this statistic is being monitored.
isEnableXM() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Answers true if eXtremeMemory is enabled.
isExclusivePlacement() - Method in interface com.ibm.websphere.objectgrid.deployment.ZoneRule
If exclusive placement is enabled, then each ShardMapping that uses this ZoneRule will have its shard placed into a different one of the zones defined for this ZoneRule.
isExternalTransactionActive(Session) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
Check whether there is an active external transaction.
isExternalTransactionActive(Session) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
Deprecated. 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.
isFieldAccessAttribute() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
return the value of FieldAccessAttribute property
isFieldAccessAttribute() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
return the value of FieldAccessAttribute property
isFlushing() - Method in interface com.ibm.websphere.objectgrid.Session
Returns whether the current session transaction is performing a session flush() operation.
isGlobalIndexEnabled() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
return the value of globalIndexEnabled property
isHPELBufferingEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL file switch feature is to be enable or not: true for enabled false for disabled.
isHPELEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL feature is to be enable or not: true for enabled false for disabled.
isHPELFileSwitchEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL file switch feature is to be enable or not: true for enabled false for disabled.
isHPELIncludeTrace() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL include trace feature is to be enable or not: true for enabled false for disabled.
isHPELPurgeBySizeEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL feature purge by size feature enable or not: true for enabled false for disabled.
isHPELPurgeByTimeEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL feature purge by size is to be enable or not: true for enabled false for disabled.
isInBackingMap() - Method in interface com.ibm.websphere.objectgrid.plugins.CacheEntry
Indicates whether this entry is in the BackingMap
isInitialized() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
isInitialized() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
isInitialized() - Method in interface com.ibm.websphere.objectgrid.plugins.Initializable
Answers true if the bean is in the initialized state, false otherwise.
isInitialized() - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
 
isInvalidate() - Method in class com.ibm.websphere.objectgrid.plugins.DistributionMode
Checks whether the mode is a invalidate mode or not.
isJvmStatsLoggingEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets whether of not log data for the JVM will to be written to a CSV file.
isKeyFilter() - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.AbstractCQFilter
 
isKeysOnly() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryNotificationEvent
If true, this notification only includes the key of the matching cache entry.
isKeysOnlyCache() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryTopic
Return true if the cache for this continuous query contains only keys.
isLocalGrid() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Get the eXtreme Scale specific property: LocalGrid
isLocalGrid() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: LocalGrid
isManagementConcentrator() - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Returns whether or not this catalog service is initialising the MBean notifications concentrator.
isMapStatsLoggingEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets whether of not log data for the Map will to be written to a CSV file.
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.
isMBeanEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves whether or not the MBeans are going to be registered.
isMultiPartitionSupportEnabled() - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Retrieve boolean flag indicating whether this Session transaction can perform write operations to multiple partitions.
isNearCacheEnabled() - Method in interface com.ibm.websphere.objectgrid.BackingMap
If true, the client near cache is enabled for supported configurations.
isNearCacheEnabled() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
If true, the client local cache is enabled for supported configurations.
isNearCacheInvalidationEnabled() - Method in interface com.ibm.websphere.objectgrid.BackingMap
If true, clients with local caches are automatically invalidated when the data grid map is updated.
isNearCacheInvalidationEnabled() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
If true, clients with local caches are automatically invalidated when the data grid map is updated.
isNearCacheLastAccessTTLSyncEnabled() - Method in interface com.ibm.websphere.objectgrid.BackingMap
If true, clients automatically send time-to-live access information to the remote data grid when accessed and the TTLType.LAST_ACCESS_TIME TTL evictor type is configured.
isNearCacheLastAccessTTLSyncEnabled() - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
If true, clients automatically send time-to-live access information to the remote data grid when accessed and the TTLType.LAST_ACCESS_TIME TTL evictor type is configured.
IsNotNullFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This filter checks if the attribute to be compared is not null.
IsNotNullFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.IsNotNullFilter
Constructor for serialization only.
IsNotNullFilter(String) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.IsNotNullFilter
Construct a filter for checking a value from an arbitrary object is not null.
IsNullFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This filter checks if an attribute is null.
IsNullFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.IsNullFilter
Constructor for serialization only.
IsNullFilter(String) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.IsNullFilter
Construct a filter for checking a value from an arbitrary object is null.
isOGStatsLoggingEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Gets whether of not log data for the ObjectGrid will to be written to a CSV file.
isPending() - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Answers true if this change has NOT been applied to the loader.
isPOJOKeyIndex() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
return the value of POJOKeyIndex property
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.
isPrimary() - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Provides indication if the catalog is primary.
isPropFileFound() - Static method in class com.ibm.websphere.objectgrid.server.ServerFactory
Answers true if the ServerFactory was initialized with a server properties file.
isPush() - Method in class com.ibm.websphere.objectgrid.plugins.DistributionMode
Checks whether the mode is a push mode or not.
isRangeIndex() - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
isRangeIndex() - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
isRangeIndex() - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Indicates if this index is the type of MapRangeIndex interface.
isRawFormat() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryTopic
Return true if this query will return keys/values in SerializedEntry format.
isReadable() - Method in interface com.ibm.websphere.objectgrid.plugins.BackingMapLifecycleListener.LifecycleEvent
Answers true when the BackingMap instance is currently readable.
isReadable() - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridLifecycleListener.LifecycleEvent
Answers true when the ObjectGrid instance is currently readable.
isReplicaReadEnabled() - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Get the replica read enabled setting.
isReplicationDisabled() - Method in class com.ibm.websphere.objectgrid.httpsession.HttpSessionConfigurationUtility
Returns whether replication is currently disabled or not.
isRollback() - Method in interface com.ibm.websphere.objectgrid.plugins.LogSequence
Returns whether or not this LogSequence was generated to rollback a transaction.
isSchemaRoot() - Method in interface com.ibm.websphere.projector.md.EntityMetadata
Return true if this EntityMetadata represents the root of the entity schema.
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.
isServer() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Answers whether or not this process is configured to be an ObjectGrid server process.
isServerStarted() - Static method in class com.ibm.websphere.objectgrid.server.ServerFactory
Checks whether the server was started or not
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.
isStatisticEnabled(int) - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Determines whether the specified statistics are enabled
isSyslogEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the Syslogd feature is to be enable or not: true for enabled false for disabled.
isSystemStreamToFileEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the stream to file setting.
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.
isVersion() - Method in interface com.ibm.websphere.projector.md.TupleAttribute
If true, this attribute is used for versioning.
isWASManagedContainerShutdownEnabled() - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Answers true if WebSphere Application Server automatically stops the eXtreme Scale container when the hosting application server is stopped and the container was started using the eXtreme Scale Server.createContainer(com.ibm.websphere.objectgrid.deployment.DeploymentPolicy) API.
isWritable() - Method in interface com.ibm.websphere.objectgrid.plugins.BackingMapLifecycleListener.LifecycleEvent
Answers true when the BackingMap instance is currently writable.
isWritable() - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridLifecycleListener.LifecycleEvent
Answers true when the ObjectGrid instance is currently writable.
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.
JMSObjectGridEventListener - Class in com.ibm.websphere.objectgrid.plugins.builtins
This class is a JMS-based implementation of ObjectGridEventListener.
JMSObjectGridEventListener() - Constructor for class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
This constructs the object and initializes any variables.
JPAEntityLoader - Class in com.ibm.websphere.objectgrid.jpa
This is the entity loader that uses Java Persistence API (JPA) to load and store data in the "database".
JPAEntityLoader() - Constructor for class com.ibm.websphere.objectgrid.jpa.JPAEntityLoader
 
JPALoader - Class in com.ibm.websphere.objectgrid.jpa
This is the loader that uses Java Persistence API (JPA) to load and store data in the "database".
JPALoader() - Constructor for class com.ibm.websphere.objectgrid.jpa.JPALoader
Default constructor
JPAPropertyFactory - Interface in com.ibm.websphere.objectgrid.jpa
This interface is used to allow users plug in their own persistence property map to the JPATxCallback object.
JPATxCallback - Class in com.ibm.websphere.objectgrid.jpa
This transaction callback implementation is used for ObjectGrid built-in Java Persistence API (JPA) loaders.
JPATxCallback() - Constructor for class com.ibm.websphere.objectgrid.jpa.JPATxCallback
The default constructor

K

KEEP - Static variable in class com.ibm.websphere.objectgrid.revision.CollisionArbiter.Resolution
Indicates that the collision should keep the entry that currently exists in the cache and ignore the colliding entry.
KEY_NOT_FOUND - Static variable in interface com.ibm.websphere.objectgrid.plugins.EvictorData
A special value indicating that the key was not found.
KEY_NOT_FOUND - Static variable in interface com.ibm.websphere.objectgrid.plugins.Loader
A special value type indicating that the key cannot be found
KEY_STORE_FILE_PROPERTY_NAME - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
Key store file property name
KeyDataDescriptor - Interface in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
KeySerializerPlugin plug-ins create a KeyDataDescriptor using the DataDescriptorFactory to identify any attributes that it wants to expose to the eXtreme Scale runtime.
KeyDataSerializer - Interface in com.ibm.websphere.objectgrid.plugins.io
DataSerializers implement this interface to serialize and inflate key data objects and attributes.
KeyDataSerializer.Partitionable - Interface in com.ibm.websphere.objectgrid.plugins.io
KeyDataSerializers can implement this optional interface to use alternative partitioning scheme.
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.
KeySerializerPlugin - Interface in com.ibm.websphere.objectgrid.plugins.io
DataSerializer BackingMap plug-ins implement this interface to serialize and inflate key data objects and attributes.
keySet() - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.
keySet() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
 
keySnapshot() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryCache
Returns a Set view of a snapshot of the keys contained in the cache.
keyStore - Variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
 
KEYSTORE_TYPE - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
Key store type.
KeyStoreLoginAuthenticator - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class is an implementation of the Authenticator interface when a user name and password are used as a credential.
KeyStoreLoginAuthenticator() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginAuthenticator
Creates a new KeyStoreLoginAuthenticator.
KeyStoreLoginModule - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
The KeyStoreLoginModule is a keystore authentication login module based on JAAS authentication.
KeyStoreLoginModule() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
Creates a new KeyStoreLoginModule.

L

LABEL - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
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.
LAZY - Static variable in class com.ibm.websphere.projector.md.FetchType
Fetch the data lazily.
LDAPAuthenticator - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class is an implementation of the Authenticator interface when a user name and password are used as a credential, and the authentication is against an LDAP server.
LDAPAuthenticator() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPAuthenticator
Creates a new LDAPAuthenticator
LDAPAuthenticatorHelper - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
Deprecated. This plug-in is deprecated in version 8.6.
LDAPAuthenticatorHelper(String, String) - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPAuthenticatorHelper
Deprecated. Creates a new LDAPAuthenticatorHelper
LDAPLoginModule - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
Deprecated. This plug-in is deprecated in version 8.6. Use the SimpleLDAPLoginModule LoginModule.
LDAPLoginModule() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPLoginModule
Deprecated.  
LEVEL_NAME - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
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.
LifecycleFailedException - Exception in com.ibm.websphere.objectgrid.plugins
Thrown when there is a fatal problem invoking a BackingMapLifecycleListener or ObjectGridLifecycleListener.
LifecycleFailedException() - Constructor for exception com.ibm.websphere.objectgrid.plugins.LifecycleFailedException
Constructs a new LifecycleFailedException with null as its detail message.
LifecycleFailedException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.LifecycleFailedException
Constructs a new LifecycleFailedException with the specified detail message and cause.
LifecycleFailedException(String) - Constructor for exception com.ibm.websphere.objectgrid.plugins.LifecycleFailedException
Constructs a new LifecycleFailedException with the specified detail message.
LifecycleFailedException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.plugins.LifecycleFailedException
Constructs a new LifecycleFailedException with a specified cause.
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
Deprecated. 
load(ObjectGrid, String, String, Map, Class, String, Map, boolean, ClientLoadCallback) - Method in interface com.ibm.websphere.objectgrid.jpa.ClientLoader
Load data into ObjectGrid maps.
load(InputStream) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Loads the properties from input into this property object.
load(InputStream) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Loads the properties from input into this property object.
Loader - Interface in com.ibm.websphere.objectgrid.plugins
Data in a map sometimes are backed up by a "database".
Loader.SpecialValue - Class in com.ibm.websphere.objectgrid.plugins
Special value class used for representing the key not being found in the Loader.
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.
LoaderNotAvailableException - Exception in com.ibm.websphere.objectgrid.writebehind
This exception indicates a Loader is not available.
LoaderNotAvailableException() - Constructor for exception com.ibm.websphere.objectgrid.writebehind.LoaderNotAvailableException
Constructs a new LoaderNotAvailableException with null as its detail message.
LoaderNotAvailableException(String) - Constructor for exception com.ibm.websphere.objectgrid.writebehind.LoaderNotAvailableException
Constructs a new LoaderNotAvailableException with the specified detail message.
LoaderNotAvailableException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.writebehind.LoaderNotAvailableException
Constructs a new LoaderNotAvailableException with the specified detail message and cause.
LoaderNotAvailableException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.writebehind.LoaderNotAvailableException
Constructs a new LoaderNotAvailableException 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.
lock(Object, LockMode) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Obtains a lock for the given key.
LOCK - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the LOCK operation.
lockAll(List, LockMode) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Obtains locks for the given keys.
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.
LockMode - Enum in com.ibm.websphere.objectgrid
Specifies which lock mode to use to lock a key.
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.
LOG_MESSAGE_NOTIFICATION - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
The constant identifying the notification type for log messages.
LOG_RECORD_DATA - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
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.
LOGGER_NAME - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
login() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
Authenticates a user based on the keystore file.
login() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPLoginModule
Deprecated. Authenticates the user by a user name and password.
login() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleLDAPLoginModule
 
logMessage(String, String) - Method in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Provides support for logging user messages from processes outside the catalog and/or container servers.
logout() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.KeyStoreLoginModule
Logs the user out.
logout() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPLoginModule
Deprecated. Logs out the user.
logout() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleLDAPLoginModule
 
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.
LogSequenceTransformer - Class in com.ibm.websphere.objectgrid.plugins
This class is used to serialize and de-serialize LogSequences.
LogSequenceTransformer() - Constructor for class com.ibm.websphere.objectgrid.plugins.LogSequenceTransformer
 
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.
LTEFilter<AttributeType,MatchType> - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This checks if an attribute is less than or equals to a scalar.
LTEFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.LTEFilter
Constructor for serialization only.
LTEFilter(String, MatchType) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.LTEFilter
 
LTFilter<AttributeType,MatchType> - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This checks if an attribute is less than a scalar.
LTFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.LTFilter
Constructor for serialization only.
LTFilter(String, MatchType) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.LTFilter
 

M

MANAGEMENT_MBEAN_NAME - Static variable in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
A constant identifying the Management Concentrator MBean name used during MBeanServer registration.
ManagementConcentratorMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to access JMX notification history broadcasted by the grid catalog and/or server processes in a dynamic environment.
ManyToMany - Annotation Type in com.ibm.websphere.projector.annotations
Specifies a many-valued association with many-to-many multiplicity.
ManyToMany - Static variable in class com.ibm.websphere.projector.md.AssociationType
Specifies a many-valued association with many-to-many multiplicity.
ManyToOne - Annotation Type in com.ibm.websphere.projector.annotations
Specifies a single-valued association to another entity that has many-to-one multiplicity.
ManyToOne - Static variable in class com.ibm.websphere.projector.md.AssociationType
Specifies a single-valued association to another entity that has many-to-one multiplicity.
map(Throwable) - Method in interface com.ibm.websphere.objectgrid.plugins.ExceptionMapper
This method maps an Throwable to a more friendly or consumable Throwable if possible.
MAP_ALL - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for all of the map statistics
MAP_ALL_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for the all of the map statistics
MAP_BATCH_UPDATE_TIME - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for the map loader batch update time statistics
MAP_BATCH_UPDATE_TIME_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for the map loader batch update statistic
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_HIT_RATE - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for the map hit count statistic
MAP_HIT_RATE_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for the map hit rate statistic
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_NUM_ENTRIES - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for the map number of entries statistic
MAP_NUM_ENTRIES_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for the map number of entries statistic
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.
MAP_USED_BYTES - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for the map number of bytes used statistic
MAP_USED_BYTES_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for the map used bytes statistic
MapDataDescriptor - Interface in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
MapSerializerPlugin plug-ins create a MapDataDescriptor using the DataDescriptorFactory to expose any relationships that it wants to expose to the eXtreme Scale runtime.
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.
MapGlobalIndex<KeyType,ValueType,AttributeType> - Interface in com.ibm.websphere.objectgrid.plugins.index
This interface is an abstract index that can be created on a Map.
MapGridAgent - Interface in com.ibm.websphere.objectgrid.datagrid
A MapGridAgent is used to process operations against map entries in a remote (server-side) ObjectGrid.
MapIndex - Interface in com.ibm.websphere.objectgrid.plugins.index
This interface is an abstract index that can be created on a Map.
MapIndex.SpecialValue - Class in com.ibm.websphere.objectgrid.plugins.index
This class represents directives for finding types of values in an index.
MapIndexInfo - Interface in com.ibm.websphere.objectgrid.plugins.index
This interface is used to provide an index with detailed change information for a specific Map in a transaction.
MapIndexPlugin - Interface in com.ibm.websphere.objectgrid.plugins.index
An index implementation must implement this interface to get modifications to the Map so it can maintain the index as transactions are committed.
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.
mapName - Variable in class com.ibm.websphere.objectgrid.jpa.JPALoader
 
MapPermission - Class in com.ibm.websphere.objectgrid.security
This class represents permissions to the ObjectMap.
MapPermission(String, String) - Constructor for class com.ibm.websphere.objectgrid.security.MapPermission
Constructs a new MapPermission for the named map with the specified actions.
MapPermission(String, String, String) - Constructor for class com.ibm.websphere.objectgrid.security.MapPermission
Constructs a new MapPermission for the named map with the specified actions.
MapPermission(String, int) - Constructor for class com.ibm.websphere.objectgrid.security.MapPermission
Constructs a new MapPermission for the named map with the specified actions.
MapPermission(String, String, int) - Constructor for class com.ibm.websphere.objectgrid.security.MapPermission
Constructs a new MapPermission for the named map with the specified actions.
MapRangeIndex - Interface in com.ibm.websphere.objectgrid.plugins.index
This interface is an index that allows comparison type searches for a range of keys.
MapSerializerPlugin - Interface in com.ibm.websphere.objectgrid.plugins.io
Identifies how data is formatted in a map and how it is serialized.
MapSet - Interface in com.ibm.websphere.objectgrid.deployment
Represents a set of BackingMaps within an ObjectGrid.
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.
MapStatsModule - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a statistic module for map.
markRollbackOnly(Throwable) - Method in interface com.ibm.websphere.objectgrid.Session
Marks the current transaction as being rollback only.
MatchFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This class checks if an attribute matches a regular expression pattern.
MatchFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.MatchFilter
Constructor for serialization only.
MatchFilter(String, String) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.MatchFilter
Construct a new regular expression based filter
matchManagedConnections(Set, Subject, ConnectionRequestInfo) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Returns a matched connection from the candidate set of connections.
MBEAN_TYPE - Static variable in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
The MBean type
merge(Object) - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Merge the entity instance with the ObjectGrid.
mergeDataObjects(DataObjectContext, XsDataInputStream, XsDataInputStream, XsDataOutputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer.Mergeable
This method is invoked when updating a cache value.
MESSAGE_HUB_NOTIFICATION - Static variable in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
A constant identifying the canonical formatted notification type for the Management Concentrator.
MetadataException - Exception in com.ibm.websphere.projector
Base exception for all entity metadata errors.
MetadataException() - Constructor for exception com.ibm.websphere.projector.MetadataException
 
MetadataException(String) - Constructor for exception com.ibm.websphere.projector.MetadataException
 
MetadataException(Throwable) - Constructor for exception com.ibm.websphere.projector.MetadataException
 
MetadataException(String, Throwable) - Constructor for exception com.ibm.websphere.projector.MetadataException
 
MetadataException(String, String, String, String) - Constructor for exception com.ibm.websphere.projector.MetadataException
 
MetadataException(String, String, String, String, Throwable) - Constructor for exception com.ibm.websphere.projector.MetadataException
 
MixedTransportException - Exception in com.ibm.websphere.objectgrid
Used when servers are mixing transport.
MixedTransportException() - Constructor for exception com.ibm.websphere.objectgrid.MixedTransportException
Constructs a new MixedTransportException with null as its detail message.
MixedTransportException(String) - Constructor for exception com.ibm.websphere.objectgrid.MixedTransportException
Constructs a new MixedTransportException with the specified detail message.
modifyServerTraceSpec(String) - Method in interface com.ibm.websphere.objectgrid.management.ServerMBean
Deprecated. This is deprecated in version 7.1. See DynamicServerMBean.setTraceSpec(String)
MODULE_TYPE_AGENT - Static variable in interface com.ibm.websphere.objectgrid.stats.StatsModule
Agent statistic module type
MODULE_TYPE_HASHINDEX - Static variable in interface com.ibm.websphere.objectgrid.stats.StatsModule
HashIndex statistic module type
MODULE_TYPE_MAP - Static variable in interface com.ibm.websphere.objectgrid.stats.StatsModule
Map statistic module type
MODULE_TYPE_OBJECT_GRID - Static variable in interface com.ibm.websphere.objectgrid.stats.StatsModule
ObjectGrid statistic module type
MODULE_TYPE_QUERY - Static variable in interface com.ibm.websphere.objectgrid.stats.StatsModule
Query statistic module type
MODULE_TYPE_SESSION - Static variable in interface com.ibm.websphere.objectgrid.stats.StatsModule
Session statistic module type
MODULE_TYPE_UNDEFINED - Static variable in interface com.ibm.websphere.objectgrid.stats.StatsModule
Undefined module type

N

NEQFilter<AttributeType,MatchType> - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This checks if an attribute does not equal a scalar.
NEQFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.NEQFilter
Constructor for serialization only.
NEQFilter(String, MatchType) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.NEQFilter
 
nestedCB - Variable in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
 
NEVER_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for value Never indicating an option is not supported.
NEW_SECURE_TOKEN_MANAGER_STRING - Static variable in class com.ibm.websphere.objectgrid.security.SecurityConstants
String representation for "autoSecret" type of the secure token manager.
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.
noCache() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryTopic
Return true if the no caching option is enabled for this Continuous Query.
NONE - Static variable in interface com.ibm.websphere.objectgrid.ClientReplicableMap
Deprecated. 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.stats.StatsSpec
An integer constant for no statistics
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.
NONE_INVALIDATION_MODEL_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setInvalidationModel(String) method for setting invalidationModel as NONE_INVALIDATION_MODEL that implies disabling client invalidation mechanism.
NONE_ROLE_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setReplicationRole(String) method for setting replicationRole as NONE_ROLE.
NonUniqueResultException - Exception in com.ibm.websphere.objectgrid.em
Thrown when Query.getSingleResult() is invoked and there is more than one result from the query.
NonUniqueResultException() - Constructor for exception com.ibm.websphere.objectgrid.em.NonUniqueResultException
 
NonUniqueResultException(String) - Constructor for exception com.ibm.websphere.objectgrid.em.NonUniqueResultException
 
NonUniqueResultException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.NonUniqueResultException
 
NonUniqueResultException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.NonUniqueResultException
 
NonUniqueResultException - Exception in com.ibm.websphere.objectgrid.query
Thrown when ObjectQuery.getSingleResult() is invoked and there is more than one result from the query.
NonUniqueResultException() - Constructor for exception com.ibm.websphere.objectgrid.query.NonUniqueResultException
Constructs a new NonUniqueResultException with null as its detail message.
NonUniqueResultException(String) - Constructor for exception com.ibm.websphere.objectgrid.query.NonUniqueResultException
Constructs a new NonUniqueResultException with the specified detail message.
NonUniqueResultException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.query.NonUniqueResultException
Constructs a new NonUniqueResultException with a specified cause.
NonUniqueResultException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.query.NonUniqueResultException
Constructs a new NonUniqueResultException with the specified detail message and cause.
NoResultException - Exception in com.ibm.websphere.objectgrid.em
Thrown when Query.getSingleResult() is invoked and there is no result to return.
NoResultException() - Constructor for exception com.ibm.websphere.objectgrid.em.NoResultException
 
NoResultException(String) - Constructor for exception com.ibm.websphere.objectgrid.em.NoResultException
 
NoResultException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.NoResultException
 
NoResultException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.NoResultException
 
NoResultException - Exception in com.ibm.websphere.objectgrid.query
Thrown when ObjectQuery.getSingleResult() is invoked and there is no result to return.
NoResultException() - Constructor for exception com.ibm.websphere.objectgrid.query.NoResultException
Constructs a new NoResultException with null as its detail message.
NoResultException(String) - Constructor for exception com.ibm.websphere.objectgrid.query.NoResultException
Constructs a new NoResultException with the specified detail message.
NoResultException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.query.NoResultException
Constructs a new NoResultException with a specified cause.
NoResultException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.query.NoResultException
Constructs a new NoResultException with the specified detail message and cause.
NORMAL_SERVER_STOP - Static variable in interface com.ibm.websphere.objectgrid.server.Server
Constant that represents that the server stopped normally.
NotFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This class negates the result of a ContinuousQueryFilter.
NotFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.NotFilter
 
NotFilter(ContinuousQueryFilter) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.NotFilter
Construct a new filter which will invert the result of its child filter
NOTIFICATION_DATA - Static variable in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
A constant identifying the composite data name for the Management Concentrator notification.
NotMatchFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This filter passes if the attribute does not match a provided regular expression pattern.
NotMatchFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.NotMatchFilter
Constructor for serialization only.
NotMatchFilter(String, String) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.NotMatchFilter
Constructs a filter which passes if the attribute does not match the pattern provided
NoVersioningOptimisticCallback - Class in com.ibm.websphere.objectgrid.plugins.builtins
Deprecated. This plug-in is deprecated in version 7.1.1. Use the DataSerializer.DataAttributeInflatable plug-in with the ValueDataSerializer.Versionable mix-in interface.
NoVersioningOptimisticCallback() - Constructor for class com.ibm.websphere.objectgrid.plugins.builtins.NoVersioningOptimisticCallback
Deprecated.  
NULL_OPTIMISTIC_VERSION - Static variable in interface com.ibm.websphere.objectgrid.plugins.OptimisticCallback
Deprecated. Special value returned by getVersionObjectForValue if the default OptimisticCallback is used by a BackingMap since the BackingMap.setOptimisticCallback(OptimisticCallback) method was never called.
NUMBER_PERMISSION - Static variable in class com.ibm.websphere.objectgrid.security.MapPermission
The total number of possible Permissions
NUMBER_PERMISSION - Static variable in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
The total number of possible Permissions
NUMBER_PERMISSION - Static variable in class com.ibm.websphere.objectgrid.security.ServerMapPermission
The total number of possible Permissions

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
ObjectGridAuthorization - Interface in com.ibm.websphere.objectgrid.security.plugins
This plugin can be used to authorize ObjectGrid, ObjectMap and JavaMap accesses to the Principals represented by a Subject object.
ObjectGridCache - Class in com.ibm.websphere.objectgrid.spring
This class is a WebSphere eXtreme Scale implementation of the Spring Framework's Cache interface.
ObjectGridCache() - Constructor for class com.ibm.websphere.objectgrid.spring.ObjectGridCache
 
ObjectGridCatalogServiceDomainBean - Class in com.ibm.websphere.objectgrid.spring
This class is a Spring bean representing a Catalog Service Domain for use with the WebSphere eXtreme Scale implementation of Spring's cache abstraction.
ObjectGridCatalogServiceDomainBean() - Constructor for class com.ibm.websphere.objectgrid.spring.ObjectGridCatalogServiceDomainBean
 
ObjectGridClientBean - Class in com.ibm.websphere.objectgrid.spring
This class is a Spring bean representing an ObjectGrid client instance for use with the WebSphere eXtreme Scale implementation of Spring's cache abstraction.
ObjectGridClientBean() - Constructor for class com.ibm.websphere.objectgrid.spring.ObjectGridClientBean
 
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.
ObjectGridDataCache - Class in com.ibm.websphere.objectgrid.openjpa
A DataCache implementation is a DataCache plugin to integrate Open JPA with ObjectGrid for leveraging the cluster server advantages provided by ObjectGrid.
ObjectGridDataCache() - Constructor for class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
 
ObjectGridDeployment - Interface in com.ibm.websphere.objectgrid.deployment
A component of the DeploymentPolicy that defines how an ObjectGrid should be placed across the set of available containers.
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.
ObjectGridHibernateCacheProvider - Class in com.ibm.websphere.objectgrid.hibernate.cache
The ObjectGridHibernateCacheProvider is the implementation of Hibernate CacheProvider.
ObjectGridHibernateCacheProvider() - Constructor for class com.ibm.websphere.objectgrid.hibernate.cache.ObjectGridHibernateCacheProvider
 
ObjectGridJ2CConnectionMBean - Interface in com.ibm.websphere.xs.ra
Allows administration clients control the lifecycle of the eXtreme Scale resource adapter's connection.
ObjectGridLifecycleListener - Interface in com.ibm.websphere.objectgrid.plugins
Listener for ObjectGrid life cycle events.
ObjectGridLifecycleListener.LifecycleEvent - Interface in com.ibm.websphere.objectgrid.plugins
The LifecycleEvent describes the situation that caused a change in the lifecycle of the ObjectGrid.
ObjectGridLifecycleListener.State - Enum in com.ibm.websphere.objectgrid.plugins
The state of a ObjectGrid's life cycle.
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.
ObjectGridOSGiManager - Interface in com.ibm.websphere.objectgrid.osgi
An ObjectGridOSGiManager is responsible for querying and managing the OSGi services currently used for an ObjectGrid instance.
ObjectGridPermission - Class in com.ibm.websphere.objectgrid.security
This class represents permissions to the ObjectGrid.
ObjectGridPermission(String, String) - Constructor for class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Constructs a new ObjectPermission for the named ObjectGrid with the specified actions.
ObjectGridPermission(String, int) - Constructor for class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Constructs a new ObjectPermission for the named ObjectGrid with the specified actions.
ObjectGridPlugin - Interface in com.ibm.websphere.objectgrid.plugins
ObjectGrid plug-ins implement this interface to be invoked when the plug-in should be initialized and destroyed.
ObjectGridQueryCache - Class in com.ibm.websphere.objectgrid.openjpa
A QueryCache implementation is a QueryCache plugin to integrate OpenJPA with ObjectGrid for leveraging the cluster server advantages provided by ObjectGrid.
ObjectGridQueryCache() - Constructor for class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
 
ObjectGridRPCException - Exception in com.ibm.websphere.objectgrid
Deprecated. The static deployment topology is deprecated in version 7.0. Use the dynamic deployment topology.
ObjectGridRPCException() - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridRPCException
Deprecated. Constructs a new ObjectGridRPCException with null as its detail message.
ObjectGridRPCException(String) - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridRPCException
Deprecated. Constructs a new ObjectGridRPCException with the specified detail message.
ObjectGridRPCException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridRPCException
Deprecated. Constructs a new ObjectGridRPCException with the specified detail message and cause.
ObjectGridRPCException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ObjectGridRPCException
Deprecated. Constructs a new ObjectGridRPCException with a specified cause.
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
 
objectGridStateChanged(ObjectGridLifecycleListener.LifecycleEvent) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridLifecycleListener
Invoked when there is a change to the ObjectGrid's life cycle.
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.
ObjectMap.PutMode - Enum in com.ibm.websphere.objectgrid
Identifies the operation mode of the ObjectMap.put(Object, Object), ObjectMap.putAll(Map) , JavaMap.put(Object, Object) and JavaMap.putAll(Map) methods.
ObjectQuery - Interface in com.ibm.websphere.objectgrid.query
An ObjectQuery provides a mechanism for introspecting one or more ObjectMaps using standard ObjectGrid query language syntax.
ObjectQuery.ResultType - Enum in com.ibm.websphere.objectgrid.query
The result type indicates when the query engine will return the cached objects results in their native Object form or in the RAW form.
ObjectQueryException - Exception in com.ibm.websphere.objectgrid.query
Base exception class for all checked exceptions thrown by the ObjectGrid query component.
ObjectQueryException() - Constructor for exception com.ibm.websphere.objectgrid.query.ObjectQueryException
Constructs a new ObjectQueryException with null as its detail message.
ObjectQueryException(String) - Constructor for exception com.ibm.websphere.objectgrid.query.ObjectQueryException
Constructs a new ObjectQueryException with the specified detail message.
ObjectQueryException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.query.ObjectQueryException
Constructs a new ObjectQueryException with a specified cause.
ObjectQueryException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.query.ObjectQueryException
Constructs a new ObjectQueryException with the specified detail message and cause.
objectToCompare - Variable in class com.ibm.websphere.objectgrid.continuousquery.filter.CompareFilter
 
ObjectTransformer - Interface in com.ibm.websphere.objectgrid.plugins
Deprecated. This plug-in is deprecated in version 7.1.1. Use the KeySerializerPlugin or ValueSerializerPlugin plug-in
OFFLINE - Static variable in class com.ibm.websphere.objectgrid.AvailabilityState
An AvailabilityState.OFFLINE indicates that a shard is offline and unable to process requests.
OG_ALL - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for all of the ObjectGrid statistics
OG_ALL_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for all of the ObjectGrid statistics
OG_TRANSACTION_TIME - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for the ObjectGrid transaction time statistic
OG_TRANSACTION_TIME_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for the ObjectGrid transaction time statistic
ogName - Variable in class com.ibm.websphere.objectgrid.jpa.JPALoader
 
OGStatsModule - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a statistic module for an ObjectGrid.
onData(LogSequence) - Method in interface com.ibm.websphere.objectgrid.plugins.ReplicationMapListener
Deprecated. This method is invoked when a data change is replicated to the client replication map.
OneToMany - Annotation Type in com.ibm.websphere.projector.annotations
Specifies a multi-valued association to another entity that has one-to-many multiplicity.
OneToMany - Static variable in class com.ibm.websphere.projector.md.AssociationType
Specifies a muliti-valued association to another entity that has one-to-many multiplicity.
OneToOne - Annotation Type in com.ibm.websphere.projector.annotations
Specifies a single-valued association to another entity that has one-to-one multiplicity.
OneToOne - Static variable in class com.ibm.websphere.projector.md.AssociationType
Specifies a single-valued association to another entity that has one-to-one multiplicity.
onException(JMSException) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
 
ONLINE - Static variable in class com.ibm.websphere.objectgrid.AvailabilityState
An AvailabilityState.ONLINE indicates that a shard is online.
onMessage(Collection) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
This method is default to do nothing, but it allows child classes want to process LogSequence collection embedded on received JMS message by overriding this method.
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.
OptimisticCallback - Interface in com.ibm.websphere.objectgrid.plugins
Deprecated. This plug-in is deprecated in version 7.1.1. Use the ValueSerializerPlugin with the ValueDataSerializer.Versionable mix-in interface.
OptimisticCollisionException - Exception in com.ibm.websphere.objectgrid.plugins
This exception is thrown when optimistic locking strategy is used and more than one update transaction collides on the same map entry of a ObjectGrid instance.
OptimisticCollisionException(String, String, String, Object) - Constructor for exception com.ibm.websphere.objectgrid.plugins.OptimisticCollisionException
Constructs a new OptimisticCollisionException with the specified detail message and key of a map of an ObjectGrid.
OptimisticLockException - Exception in com.ibm.websphere.objectgrid.em
Thrown when there is an optimistic collision when merging, flushing or committing an entity that has an out of date version mismatch.
OptimisticLockException() - Constructor for exception com.ibm.websphere.objectgrid.em.OptimisticLockException
 
OptimisticLockException(String) - Constructor for exception com.ibm.websphere.objectgrid.em.OptimisticLockException
 
OptimisticLockException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.OptimisticLockException
 
OptimisticLockException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.OptimisticLockException
 
OptimisticLockException - Exception in com.ibm.websphere.projector
Thrown when there is an optimistic collision when merging, flushing or committing an entity that has an out of date version.
OptimisticLockException() - Constructor for exception com.ibm.websphere.projector.OptimisticLockException
 
OptimisticLockException(String) - Constructor for exception com.ibm.websphere.projector.OptimisticLockException
 
OptimisticLockException(Throwable) - Constructor for exception com.ibm.websphere.projector.OptimisticLockException
 
OptimisticLockException(String, Throwable) - Constructor for exception com.ibm.websphere.projector.OptimisticLockException
 
ORB - Static variable in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Constant representing the ORB or Object Request Broker transport
ORB_TRANSPORT - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
The Object Request Broker or ORB transport
OrderBy - Annotation Type in com.ibm.websphere.projector.annotations
Specifies the ordering of the elements of a collection valued association at the point when the association is retrieved.
OrFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This filter passes if any child filter is true.
OrFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.OrFilter
 
OrFilter(ContinuousQueryFilter...) - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.OrFilter
 
ORIGINAL_TYPE - Static variable in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
A constant identifying the composite data representing notification original type.
OSGiManagerFactory - Class in com.ibm.websphere.objectgrid.osgi
A factory to get the following objects: ObjectGridOSGiManager for managing OSGi service for a local or client ObjectGrid instance.
OSGiServiceRepository - Interface in com.ibm.websphere.objectgrid.osgi
The eXtreme Scale runtime tracks all the services that are configured as user plug-ins.
OSGiServiceRepository.OSGiServiceKey - Class in com.ibm.websphere.objectgrid.osgi
The name of the entities that each OSGi Service is scoped to.
OSGiServiceRepository.OSGiServiceKey(String, String) - Constructor for class com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository.OSGiServiceKey
 
OutputFormat - Enum in com.ibm.websphere.objectgrid
Identifies the data output format from data access APIs and plug-ins.
OVERRIDE - Static variable in class com.ibm.websphere.objectgrid.revision.CollisionArbiter.Resolution
Indicates that the collision should override the existing entry with the colliding entry.
overrideQuorum() - Method in interface com.ibm.websphere.objectgrid.management.QuorumManagerMBean
This operation forces surviving catalog service grid processes to reestablish a quorum.

P

PARTIAL_PRELOAD_NEEDED - Static variable in class com.ibm.websphere.objectgrid.plugins.ReplicaPreloadController.Status
This constant means the controller has determined a preload was in progress on the primary and that preload can commence from where the primary stopped.
PartitionableKey - Interface in com.ibm.websphere.objectgrid.plugins
This interface is used to identify keys that want to use their own partitioning algorithm.
PartitionKey - Annotation Type in com.ibm.websphere.objectgrid.plugins.io.annotations
Specifies a single attribute to use to calculate the partition hash code.
PartitionKeys - Annotation Type in com.ibm.websphere.objectgrid.plugins.io.annotations
Specifies one or more attributes that identify the portion of the key to calculate the partition hash code.
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.
PATH_DELIMITER - Static variable in interface com.ibm.websphere.objectgrid.stats.StatsModule
The path delimiter to separate the paths to a statistic module
PercentageStatistic - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a percentage Statistic.
PERMISSIONS - Static variable in class com.ibm.websphere.objectgrid.security.MapPermission
An array with the string representation of each permission.
PERMISSIONS - Static variable in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
An array with the string representation of each permission.
PERMISSIONS - Static variable in class com.ibm.websphere.objectgrid.security.ServerMapPermission
An array with the string representation of each permission.
persist(Object) - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Make an entity instance managed and persistent in the ObjectGrid cache.
PersistenceException - Exception in com.ibm.websphere.objectgrid.em
Thrown by the EntityManager when a problem occurs.
PersistenceException() - Constructor for exception com.ibm.websphere.objectgrid.em.PersistenceException
Constructs a new PersistenceException with null as its detail message.
PersistenceException(String) - Constructor for exception com.ibm.websphere.objectgrid.em.PersistenceException
Constructs a new PersistenceException with the specified detail message.
PersistenceException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.PersistenceException
Constructs a new PersistenceException with the specified detail message and cause.
PersistenceException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.PersistenceException
Constructs a new PersistenceException with a specified cause.
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.
pinInternal(Object) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
This is not applicable to ObjectGrid
pinInternal(QueryKey) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
This is not applicable to ObjectGrid
PLACEMENT_DEFERRAL_INTERVAL_DEFAULT - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Constant representing the default interval for deferral of balancing and placement of work items to the containers
PLACEMENT_STRATEGY_FIXED_PARTITIONS - Static variable in interface com.ibm.websphere.objectgrid.deployment.MapSet
Represents a placement strategy where there is a fixed number of partitions that are balanced across the available set of containers.
PLACEMENT_STRATEGY_PER_CONTAINER - Static variable in interface com.ibm.websphere.objectgrid.deployment.MapSet
Represents a placement strategy where each container gets a fixed number of primary shards and the replicas are then balanced across the other containers.
PlacementException - Exception in com.ibm.websphere.objectgrid.catalog
A general exception indicating a placement related problem was detected.
PlacementException() - Constructor for exception com.ibm.websphere.objectgrid.catalog.PlacementException
Constructs a new PlacementException with null as its detail message.
PlacementException(String) - Constructor for exception com.ibm.websphere.objectgrid.catalog.PlacementException
Constructs a new PlacementException with the specified detail message.
PlacementException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.catalog.PlacementException
Constructs a new PlacementException with a specified cause.
PlacementException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.catalog.PlacementException
Constructs a new PlacementException with the specified detail message and cause.
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.
PluginOutputFormat - Annotation Type in com.ibm.websphere.objectgrid.plugins.io.annotations
Identify the data format to be used for plug-ins that accept LogSequnce, LogElement, or cache keys or values.
PluginServiceFactory<T> - Interface in com.ibm.websphere.objectgrid.plugins.osgi
All OSGi plug-in implementation should configure the service using this interface.
PluginType - Interface in com.ibm.websphere.objectgrid.config
Every Plugin has a PluginType.
POJO_ADDRESSABLEKEYNAME - Static variable in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryFilter
The name used to identify the key objects in POJO maps.
POJO_PATHSEPARATOR - Static variable in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryFilter
The path separator to use when identifying attribute paths for POJO maps.
position(int) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Positions this stream to read from the given position.
position() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Gets the current position from where the next byte will be read.
position() - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Gets the current position of this stream.
position(int) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Sets the position of this stream at the given byte index.
postFinish(Session, String, boolean) - Method in interface com.ibm.websphere.objectgrid.jpa.ClientLoadCallback
This method is called right after the client finishes loading a map.
PostInvalidate - Annotation Type in com.ibm.websphere.projector.annotations
Identifies the post-invalidate callback method which is invoked for an entity after the entity has been invalidated, which includes entities that have been invalidated due to a cascading operation.
PostLoad - Annotation Type in com.ibm.websphere.projector.annotations
Identifies the post-load callback method which is invoked for an entity after the entity has been loaded from the store which includes any entities that are loaded through an association.
PostPersist - Annotation Type in com.ibm.websphere.projector.annotations
Identifies the post-persist callback method which is invoked for an entity after the entity has been persisted to the store, which includes entities that have been persisted due to a cascading operation.
PostRemove - Annotation Type in com.ibm.websphere.projector.annotations
Identifies the post-remove callback method which is invoked for an entity after the entity has been removed, which includes entities that have been removed due to a cascading operation.
PostUpdate - Annotation Type in com.ibm.websphere.projector.annotations
Identifies the post-update callback method which is invoked for an entity after the entity has been updated to the store.
PreInvalidate - Annotation Type in com.ibm.websphere.projector.annotations
Identifies the pre-invalidate callback method which is invoked for an entity before the entity has been invalidated, which includes entities that have been invalidated due to a cascading operation.
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.
PRELOADED_ALREADY - Static variable in class com.ibm.websphere.objectgrid.plugins.ReplicaPreloadController.Status
This constant should be returned when the controller determines that preloading is not necessary.
preloadMap(Session, BackingMap) - Method in class com.ibm.websphere.objectgrid.jpa.JPALoader
This method initializes the loader and preloads the map using the ClientLoader.load(ObjectGrid, String, String, Map, Class, String, Map, boolean, ClientLoadCallback) method.
preloadMap(Session, BackingMap) - Method in interface com.ibm.websphere.objectgrid.plugins.Loader
Signals the Loader to preload the data into the map.
preloadPartition - Variable in class com.ibm.websphere.objectgrid.jpa.JPALoader
 
PREPARED - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Indicates that the transaction at this partition has successful completed the first phase of the two-phase commit protocol and is waiting to begin the second phase of the protocol.
PrePersist - Annotation Type in com.ibm.websphere.projector.annotations
Identifies the pre-persist callback method which is invoked for an entity before the entity has been persisted to the store, which includes entities that have been persisted due to a cascading operation.
PreRemove - Annotation Type in com.ibm.websphere.projector.annotations
Identifies the pre-remove callback method which is invoked for an entity before the entity has been removed, which includes entities that have been removed due to a cascading operation.
preStart(Session, String) - Method in interface com.ibm.websphere.objectgrid.jpa.ClientLoadCallback
This method is called before the client starts loading a map.
PreUpdate - Annotation Type in com.ibm.websphere.projector.annotations
Identifies the pre-update callback method which is invoked for an entity before the entity has been updated to the store.
PRIMARY - Static variable in class com.ibm.websphere.objectgrid.deployment.ShardType
Represents a primary shard.
PRIMARY - Static variable in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Constant representing a primary shard type.
PROBE_ID - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
process(Session, ObjectMap, Object) - Method in interface com.ibm.websphere.objectgrid.datagrid.MapGridAgent
This method is called once per key per partition.
processAllEntries(Session, ObjectMap) - Method in interface com.ibm.websphere.objectgrid.datagrid.MapGridAgent
This method is called once per partition.
processLogSequence(LogSequence) - Method in interface com.ibm.websphere.objectgrid.Session
Processes a LogSequence.
processWriteBehind(boolean) - Method in class com.ibm.websphere.objectgrid.hibernate.cache.ObjectGridHibernateCacheProvider
Overrides
Projector - Interface in com.ibm.websphere.projector
The Projector is used to convert entities to Tuple objects.
ProjectorException - Exception in com.ibm.websphere.projector
Base exception class for all exceptions thrown by the Projector component.
ProjectorException() - Constructor for exception com.ibm.websphere.projector.ProjectorException
Constructs a new ProjectorException with null as its detail message.
ProjectorException(String) - Constructor for exception com.ibm.websphere.projector.ProjectorException
Constructs a new ProjectorException with the specified detail message.
ProjectorException(Throwable) - Constructor for exception com.ibm.websphere.projector.ProjectorException
Constructs a new ProjectorException with a specified cause.
ProjectorException(String, Throwable) - Constructor for exception com.ibm.websphere.projector.ProjectorException
Constructs a new ProjectorException with the specified detail message and cause.
ProjectorFactory - Class in com.ibm.websphere.objectgrid.em
A factory for creating or retrieving Projector instances.
ProjectorFactory() - Constructor for class com.ibm.websphere.objectgrid.em.ProjectorFactory
 
PROP_CATALOG_CLUSTER_END_POINTS - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
The format of the string should be "serverName:hostName:clientPort:peerPort<,serverName:hostName:clientPort:peerPort>".
PROP_CATALOG_SERVER - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
A boolean to indicate whether the server should start a catalog service.
PROP_CATALOG_SERVICE_ENDPOINTS - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the end points to connect to the catalog service grid.
PROP_DISK_OVERFLOW_CAP_BYTES - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Defines maximum number of bytes that can be used by this JVM for overflowing content to disk.
PROP_DISK_OVERFLOW_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Defines whether the capability of overflowing data from main-memory to disk is enabled.
PROP_DISK_OVERFLOW_MIN_DISK_SPACE_BYTES - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Defines minimum number of bytes that must remain free on disk in the partition named by PROP_DISK_STORAGE_PATH.
PROP_DISK_STORAGE_PATH - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Defines the root directory to use when disk overflow is enabled.
PROP_DOMAIN_NAME - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Defines the domain name used to uniquely identify this catalog service grid to clients when routing to multiple domains.
PROP_ENABLE_CHANNEL_FRAMEWORK - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the TransportMode on the IBM ORB properties to ChannelFramework
PROP_ENABLE_EXTREMEMEMORY - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Enables the eXtremeMemory memory storage mode for the server.
PROP_ENABLE_MANAGEMENT_CONCENTRATOR - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Determines whether or not the initialization of the MBeanServer notifications concentrator
PROP_ENABLE_MBEANS - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Determines whether or not the ObjectGrid will register MBeans in this process.
PROP_ENABLE_QUORUM - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Determines whether or not quorum is enabled.
PROP_FOREIGN_DOMAINS - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
A bidirectional connection will be established to each of the foreign domains for the purpose of exchanging data in a multi-primary scenario.
PROP_HAMANAGERPORT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Defines the port number the High Availability Manager will use.
PROP_HEARTBEAT_FREQUENCY_LEVEL - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Sets the heartbeat frequency level.
PROP_HPEL_BUFFERING_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL feature is to enable buffering.
PROP_HPEL_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL feature is to be enable or not: true for enabled false for disabled.
PROP_HPEL_FILE_SWITCH_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL feature is to enable file switch.
PROP_HPEL_FILE_SWITCH_HOUR - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the file switch hour (int value).
PROP_HPEL_INCLUDE_TRACE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL text files are to include tracing.
PROP_HPEL_MAX_REPOSITORY_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the Maximum size of files generate in megabytes (long value).
PROP_HPEL_MAX_RETENTION_TIME - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum retention time to hold files (long value).
PROP_HPEL_OUT_OF_SPACE_ACTION - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the action to be performed when the disk space has been exceeded (String value)
PROP_HPEL_OUTPUT_FORMAT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the format of the log files to be generated (String value).
PROP_HPEL_PURGE_BY_SIZE_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL feature is to purge log files by size.
PROP_HPEL_PURGE_BY_TIME_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates if the HPEL feature is to purge log files by time.
PROP_HPEL_REPOSITORY_PATH - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the file repository path (int value).
PROP_JMX_CONNECTOR_PORT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The property that defines which SSL port the JMX service will bind to
PROP_JMX_SERVICE_PORT - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Deprecated. Deprecated in version 7.1. Use ServerProperties.PROP_JMX_SERVICE_PORT instead
PROP_JMX_SERVICE_PORT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The property that defines which port the JMX service will bind to
PROP_JVM_STATS_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables log data for the JVM to be written to a CSV file.
PROP_JVM_STATS_FILE_NAME - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the file name of the CSV statistics file for the JVM.
PROP_JVM_STATS_WRITE_RATE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the write rate of the CSV statistics files for the JVM in seconds.
PROP_LISTENER_HOST - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
Listener host property key for the client properties file.
PROP_LISTENER_HOST - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the host name that the ORB should bind to.
PROP_LISTENER_PORT - Static variable in interface com.ibm.websphere.objectgrid.client.ClientProperties
Listener port property key for the client properties file.
PROP_LISTENER_PORT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the port that the ORB should bind to.
PROP_LOG_NOTIFICATION_FILTER - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The log record filtering regular expression that the ObjectGrid server should initially use.
PROP_MAP_STATS_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables log data for the Map to be written to a CSV file.
PROP_MAP_STATS_FILE_NAME - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the file name of the CSV statistics file for the Map Stats.
PROP_MAP_STATS_WRITE_RATE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the write rate of the CSV statistics files for the Map Stats in seconds.
PROP_MAX_JVM_STATS_FILE_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum file size, in megabytes, of the CSV statistics files for the JVM.
PROP_MAX_JVM_STATS_FILES - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum number of CSV statistics files that are generated for the JVM Stats.
PROP_MAX_MAP_STATS_FILE_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum file size, in megabytes, of the CSV statistics files for the Map Stats.
PROP_MAX_MAP_STATS_FILES - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum number of CSV statistics files that are generated for the Map Stats.
PROP_MAX_OG_STATS_FILE_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum file size, in megabytes, of the CSV statistics files for the Object Grid Stats.
PROP_MAX_OG_STATS_FILES - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the maximum number of CSV statistics files that are generated for the Object Grid Stats.
PROP_MAXIMUM_EXTREMEMEMORY_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum amount of eXtremeMemory (in megabytes) to allocate when eXtremeMemory is enabled.
PROP_MAXIMUM_THREAD_POOL_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the minimum thread pool size used by the server and client runtimes in this process
PROP_MAXIMUM_XIO_NETWORK_THREAD_POOL_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of threads to allocate in the eXtremeIO transport network thread pool.
PROP_MAXIMUM_XIO_WORKER_THREAD_POOL_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of threads to allocate in the eXtremeIO transport request processing thread pool.
PROP_MEMORY_USAGE_THRESHOLD - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the memory threshold (percentage of max heap) for memory based eviciton
PROP_MINIMUM_THREAD_POOL_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the minimum thread pool size used by the server and client runtimes in this process
PROP_MINIMUM_XIO_NETWORK_THREAD_POOL_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the minimum number of threads to allocate in the eXtremeIO transport network thread pool.
PROP_MINIMUM_XIO_WORKER_THREAD_POOL_SIZE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the minimum number of threads to allocate in the eXtremeIO transport request processing thread pool.
PROP_OG_STATS_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables log data for the Map to be written to a CSV file.
PROP_OG_STATS_FILE_NAME - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the file name of the CSV statistics file for the Object Grid Stats.
PROP_OG_STATS_WRITE_RATE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the write rate of the CSV statistics files for the Object Grid Stats in seconds.
PROP_PLACEMENT_DEFERRAL_INTERVAL - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Determines the placement deferral interval.
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_SERVER_NAME - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Defines the name the server should use to identify itself.
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.
PROP_STATS_SPEC - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The statistics specification that the ObjectGrid should use for metric gathering.
PROP_SUFFIX_DOMAIN_ENDPOINTS - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Use this string as a suffix when reading and writing domain end points properties.
PROP_SYSLOG_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates whether to enable the transmission (over UDP) of log messages to a remote syslogd server.
PROP_SYSLOG_FACILITY - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the syslog facility with which to send out syslog messages
PROP_SYSLOG_HOST_NAME - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the receiving syslogd server fully-qualified domain name or IP address.
PROP_SYSLOG_HOST_PORT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the syslogd server port number on which to receive syslog messages.
PROP_SYSLOG_THRESHOLD - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Indicates the log level threshold of messages to trasmit to the configured syslogd server Possible values: {warning, error}
PROP_SYSTEM_STREAM_TO_FILE_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Defines whether SystemOut and SystemErr should be sent to file or not.
PROP_TRACE_FILE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The name of the file that trace output should be sent to.
PROP_TRACE_SPEC - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The trace specification that the ObjectGrid server should use initially.
PROP_TRANSPORT - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Determines the transport on the catalog service domain for server to server communication
PROP_WAS_MANAGED_CONTAINER_SHUTDOWN_ENABLED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Used by users of the embedded server API in WebSphere Application Server, when they want to stop the eXtreme Scale containers manually using the ContainerMBean.terminate() API.
PROP_WORKING_DIRECTORY - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The property that defines which directory the ObjectGrid server should use for all default settings.
PROP_XIO_TIMEOUT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the timeout for server requests using the XIO transport.
PROP_XIO_WAITING_MESSAGE_QUEUE_LIMIT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Deprecated. 8.6.0
PROP_XIOCHANNEL_PREFIX - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The property prefix to use for all eXtremeIO transport channel properties.
PROP_XIOCHANNELNAME_CONTAINER_TCP_NON_SECURE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Deprecated. 8.6
PROP_XIOCHANNELNAME_CONTAINER_TCP_SECURE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Deprecated. 8.6
PROP_XIOCHANNELNAME_TCP - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The eXtremeIO transport channel name for TCP/IP communication.
PROP_XIOCHANNELPROP_PORT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
The eXtremeIO channel property to identify the port.
PROP_ZONE_NAME - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Defines the name of the zone this server belongs to.
PROPERTY - Static variable in class com.ibm.websphere.projector.md.AccessType
The persistent state of the entity object is accessed using methods.
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.
PROVIDER_URL - Static variable in class com.ibm.websphere.objectgrid.security.plugins.builtins.LDAPLoginModule
Deprecated. LDAP server provider URL property name
ProxyHelper - Class in com.ibm.websphere.objectgrid.osgi
A helper class for the OSGi service proxy.
ProxyHelper() - Constructor for class com.ibm.websphere.objectgrid.osgi.ProxyHelper
 
PUBLISHER_ROLE_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setReplicationRole(String) method for setting replicationRole as PUBLISHER_ROLE.
PUSH - Static variable in class com.ibm.websphere.objectgrid.plugins.DistributionMode
The PUSH distribution mode is used to communicate changes to the receivers of the LogSequence.
PUSH_CONDITIONAL - Static variable in class com.ibm.websphere.objectgrid.plugins.DistributionMode
The PUSH_CONDITIONAL is very much like the PUSH distribution mode except that it also takes into account the versioned value data associated with each entry.
PUSH_CONDITIONAL_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setInvalidationStrategy(String) or setReplicationStrategy(String) method for setting invalidationStrategy or replicationStrategy as PUSH_CONDITIONAL.
PUSH_INCLUDED_CONDITIONAL_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setInvalidationStrategy(String) or setReplicationStrategy(String) method for setting invalidationStrategy or replicationStrategy as PUSH_INCLUDED_CONDITIONAL.
PUSH_INCLUDED_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setInvalidationStrategy(String) or setReplicationStrategy(String) method for setting invalidationStrategy or replicationStrategy as PUSH_INCLUDED.
PUSH_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setInvalidationStrategy(String) or setReplicationStrategy(String) method for setting invalidationStrategy or replicationStrategy as PUSH.
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) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
Creates an entry in the cache.
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.
putAllInternal(Collection) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Caches a collection of cache objects
putInternal(Object, DataCachePCData) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Caches an object by a given key
putInternal(QueryKey, QueryResult) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Caches a query result set with a given query key
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

Query - Interface in com.ibm.websphere.objectgrid.em
Interface used to control entity query execution.
QUERY - Static variable in class com.ibm.websphere.objectgrid.security.ObjectGridPermission
Query permission constant
QUERY_ALL - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for all of the ObjectQuery and entity query statistics
QUERY_ALL_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for all of the ObjectQuery and entity query statistics
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 with 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.
QueryQueue - Interface in com.ibm.websphere.objectgrid.em
A query queue allows users to get entities qualified by a query in an iterative manner.
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.
QueryStatsModule - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a statistic module for a Query.
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.
QUORUM_CHANGED_NOTIFICATION - Static variable in interface com.ibm.websphere.objectgrid.management.QuorumManagerMBean
 
QUORUM_LOST_NOTIFICATION - Static variable in interface com.ibm.websphere.objectgrid.management.QuorumManagerMBean
 
QuorumException - Exception in com.ibm.websphere.objectgrid.catalog
An exception indicating that the catalog service does not have quorum.
QuorumException() - Constructor for exception com.ibm.websphere.objectgrid.catalog.QuorumException
Constructs a new QuorumException with null as its detail message.
QuorumException(String) - Constructor for exception com.ibm.websphere.objectgrid.catalog.QuorumException
Constructs a new QuorumException with the specified detail message.
QuorumException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.catalog.QuorumException
Constructs a new QuorumException with a specified cause.
QuorumException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.catalog.QuorumException
Constructs a new QuorumException with the specified detail message and cause.
QuorumManagerMBean - Interface in com.ibm.websphere.objectgrid.management
Each catalog service has a QuorumManager and an associated MBean.

R

rateOfChange(CountStatistic) - Method in interface com.ibm.websphere.objectgrid.stats.CountStatistic
Calculates the rate of change between two CountStatistics.
READ - Static variable in class com.ibm.websphere.objectgrid.security.MapPermission
Read permission constant
readBoolean() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads 1-byte as a boolean value at the current position in current byte order.
readByte() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads 1-byte as a signed byte value at the current position in current byte order.
readChar() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads 2-byte as an signed integer value in the current position in current byte order.
readChars(char[]) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads c.length characters as an array of 2-byte signed integer values in the current position in current byte order.
readDouble() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a 8-byte floating point number at the current position in current byte order.
readExternal(ObjectInput) - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
 
readExternal(ObjectInput) - Method in class com.ibm.websphere.xsa.RestValue
Deprecated.  
readFloat() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a 4-byte floating point number at the current position in current byte order.
readFully(byte[], int, int) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads b.length bytes, if available.
readFully(byte[]) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads b.length bytes, if available.
readInt() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a 4-byte integer at the current position in current byte order.
readLong() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a 8-byte integer number at the current position in current byte order.
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.
readSessionHandle(DataInput) - Static method in class com.ibm.websphere.objectgrid.SessionHandleTransformer
Reads and returns a SessionHandle instance from the contents of the input stream.
readShort() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a 2-byte signed integer number at the current position in current byte order.
readString() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a string assuming that the number of bytes of the string to be read precedes the actual bytes as a 2-byte short number.
readString(String) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a string assuming that the number of bytes of the string to be read precedes the actual bytes as a 2-byte short number.
readString(String, boolean, int, boolean) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a string as a array of bytes with given parameter specifications.
readStringAsNullTerminated() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a string assuming that the string to be read is terminated by a single bye of value 0.
readStringAsNullTerminated(String) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a string assuming that the string to be read is terminated by a single bye of value 0.
readStringRaw(int) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a string as a array of bytes of given length.
readStringRaw(String, int) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a string as a array of bytes of given length.
readUnsignedByte() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads 1-byte as an unsigned byte value at the current position in current byte order.
readUnsignedShort() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a 2-byte unsigned integer number at the current position in current byte order.
readUTF8String() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a string as an array of bytes with the UTF-8 encoding The length is stored in a varint at the current position in the stream to indicate the number of UTF-8 bytes that will follow in the buffer.
readVarintAsInt() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a variable length integer number at the current position in the current byte order.
readVarintAsLong() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Reads a variable length long number at the current position in the current byte order.
ready(String) - Method in interface com.ibm.websphere.objectgrid.plugins.index.DynamicIndexCallback
Invoked when the dynamic index is ready.
recacheUpdates() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Return true because ObjectGrid is a external cache and updates to data already in the cache (either in ObjectGridDataCache.commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection) or the AbstractDataCache.update(org.apache.openjpa.datacache.DataCachePCData)) should be put back into the cache.
ReconnectException - Exception in com.ibm.websphere.objectgrid
This exception is used to indicate that the client connection needs to be re-established in order to recover from an error.
ReconnectException() - Constructor for exception com.ibm.websphere.objectgrid.ReconnectException
Constructs a new ReconnectException with null as its detail message.
ReconnectException(String) - Constructor for exception com.ibm.websphere.objectgrid.ReconnectException
Constructs a new ReconnectException with the specified detail message.
ReconnectException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ReconnectException
Constructs a new ReconnectException with a specified cause.
ReconnectException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ReconnectException
Constructs a new ReconnectException with the specified detail message and cause.
reduce(Session, ObjectMap, Collection) - Method in interface com.ibm.websphere.objectgrid.datagrid.ReduceGridAgent
The method should reduce the entries referenced by the key collection to a single value.
reduce(Session, ObjectMap) - Method in interface com.ibm.websphere.objectgrid.datagrid.ReduceGridAgent
This method is called on each partition.
ReduceGridAgent - Interface in com.ibm.websphere.objectgrid.datagrid
A ReduceGridAgent is used to process a set of entries and reduce them to a single result.
reduceResults(Collection) - Method in interface com.ibm.websphere.objectgrid.datagrid.ReduceGridAgent
This is called when further reduction is needed.
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.
registerMapSerializerPlugin(MapSerializerPlugin) - Method in interface com.ibm.websphere.objectgrid.plugins.io.SerializerAccessor
Register a new MapSerializerPlugin for the cache entry key for a local, in-memory ObjectGrid instance.
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() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
 
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.em.EntityManager
Remove the entity instance from the ObjectGrid.
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.
remove(Object) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Removes a cache object by a given key.
REMOVE - Static variable in class com.ibm.websphere.objectgrid.security.MapPermission
Remove permission constant
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.
removeAllInternal(Class, boolean) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Clear the map corresponding to the entity class
removeAllInternal(Collection) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Deletes a collection of objects from the cache.
removeAllListeners() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryTopic
Removes all registered listeners from this query topic.
removeContinuousQuery(ContinuousQueryTopic, Integer...) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryManager
Remove a defined continuous query.
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.
removeInternal(Object) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Deletes a cached object by a given key.
removeInternal(QueryKey) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Removes the result set associated with the given query key
removeListener(ContinuousQueryListener<KeyType, ValueType>) - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryTopic
Remove the listener from this continuous query's the set of listeners.
removeMap(String) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Remove a BackingMapConfiguration from this MapSet
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
Provided for compatibility with old releases, use the BackingMap.removeMapEventListener(EventListener) method.
removeMapSet(String) - Method in interface com.ibm.websphere.objectgrid.deployment.ObjectGridDeployment
Remove a MapSet from this ObjectGridDeployment.
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.
removeObjectGridDeployment(String) - Method in interface com.ibm.websphere.objectgrid.deployment.DeploymentPolicy
Remove an ObjectGridDeployment object from this DeploymentPolicy.
replaceLostShards(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Lost shards are placed onto the UNREPAIRED container when autoReplaceLostShards is disabled.
ReplicaPreloadController - Interface in com.ibm.websphere.objectgrid.plugins
A Map Loader should also implement this interface in the following circumstances.
ReplicaPreloadController.Status - Class in com.ibm.websphere.objectgrid.plugins
This class is used as an enumerator for the Map preload status.
REPLICATE - Static variable in class com.ibm.websphere.objectgrid.security.ServerMapPermission
replicating server map to client map permission constant.
REPLICATION_ALL - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for all of the replication statistics
REPLICATION_ALL_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for all of the replication statistics
REPLICATION_IDLE_LEVEL_NONE - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Constant representing a replication idle level that is turned off.
REPLICATION_IDLE_LEVEL_RELAXED - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Constant representing a replication idle level at a relaxed rate.
REPLICATION_IDLE_LEVEL_SHORT - Static variable in interface com.ibm.websphere.objectgrid.server.ServerProperties
Constant representing a replication idle level at a short sleep.
replicationExits() - Method in interface com.ibm.websphere.objectgrid.plugins.ReplicationMapListener
Deprecated. This method is invoked when replication has been disabled for this map.
ReplicationMapListener - Interface in com.ibm.websphere.objectgrid.plugins
Deprecated. The client replicated map function is deprecated in version 8.6. Use the ContinuousQueryManager function.
replicationStarts() - Method in interface com.ibm.websphere.objectgrid.plugins.ReplicationMapListener
Deprecated. 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.
reset() - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Resets the statistic to zero.
reset() - Method in interface com.ibm.websphere.objectgrid.stats.StatsModule
Resets all the statistics in this module to zero.
resetObjectGridConnection() - Method in interface com.ibm.websphere.xs.ra.ObjectGridJ2CConnectionMBean
Reset the ObjectGrid connection.
RestService - Class in com.ibm.websphere.objectgrid.rest
The WebSphere eXtreme Scale REST Service MBean implementation.
RestService() - Constructor for class com.ibm.websphere.objectgrid.rest.RestService
Constructor.
RestServiceMBean - Interface in com.ibm.websphere.objectgrid.rest
Java MBean interface for the WebSphere eXtreme Scale REST data service.
RestValue - Interface in com.ibm.websphere.xs.rest
This interface is implemented by object used in WebSphere eXtreme Scale REST Gateway.
RestValue - Class in com.ibm.websphere.xsa
Deprecated.  
RestValue() - Constructor for class com.ibm.websphere.xsa.RestValue
Deprecated. Constructor
RestValue(byte[], String) - Constructor for class com.ibm.websphere.xsa.RestValue
Deprecated. Constructor
RestValueFactory - Class in com.ibm.websphere.xs.rest
This RestValueFactory class is used to create object that implements RestValue interface.
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.
retrieveAllCurrentlyUsedRankings(String) - Method in interface com.ibm.websphere.objectgrid.management.ServerOSGiMBean
Gets all currently used rankings for the specified OSGi service.
retrieveAllRankings(String) - Method in interface com.ibm.websphere.objectgrid.management.ServerOSGiMBean
Gets all available rankings for the specified OSGi service.
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.
retrieveServerJMXAddressesWithInfo(String, String) - Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Retrieves TabularData of JMX address strings for a specific host and server name that has registered with the placement service.
retrieveServiceAvailability(Map<String, Integer>) - Method in interface com.ibm.websphere.objectgrid.management.ServerOSGiMBean
Checks if the specified OSGi service rankings are available or not.
retrieveServiceAvailability(Map<String, Integer>) - Method in interface com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository
Check if the specified service rankings are available or not.
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.
RetryableLoader - Interface in com.ibm.websphere.objectgrid.plugins
This interface represents a loader which is capable of handling a retry (redo) update from ObjectGrid runtime.
retryIndicationSlot - Variable in class com.ibm.websphere.objectgrid.jpa.JPALoader
 
REVISE - Static variable in class com.ibm.websphere.objectgrid.revision.CollisionArbiter.Resolution
Indicates that the collision has been resolved programmatically in the revision transaction.
RevisionElement - Interface in com.ibm.websphere.objectgrid.revision
Describes the unique elements of a revision entry.
rewind() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Rewinds the stream by reopening, if necessary and repositioning at the state of construction.
rewind() - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Restores this stream at the initial state at its construction.
RM - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Indicates that this partition is a participant or Resource manager (RM) in this transaction.
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() - Method in interface com.ibm.websphere.objectgrid.em.EntityTransaction
Roll back the current transaction.
rollback(TxID) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
Rollback the JPA entity manager transaction if one is enlisted in this ObjectGrid transaction.
ROLLBACK - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Indicates that the outcome of this transaction is rollback.
rollback(String) - Method in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Heuristically rollback the specified transaction at this partition.
rollback(TxID) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
Deprecated.  
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.
RollbackEvictor - Interface in com.ibm.websphere.objectgrid.plugins
This interface is optionally implemented by an Evictor plugin.
RollbackException - Exception in com.ibm.websphere.objectgrid.em
Thrown when EntityTransaction.commit() fails.
RollbackException() - Constructor for exception com.ibm.websphere.objectgrid.em.RollbackException
 
RollbackException(String) - Constructor for exception com.ibm.websphere.objectgrid.em.RollbackException
 
RollbackException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.RollbackException
 
RollbackException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.RollbackException
 
rollingBack(LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
 
rollingBack(LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
 
rollingBack(LogSequence) - Method in interface com.ibm.websphere.objectgrid.plugins.RollbackEvictor
Called after a transaction rollback to allow an evictor to track object usage in a backing map even when rollback occurs instead of commit.
run() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
This is the thread which receives messages on a topic and then applies them to the local grid.
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.WSSubjectSourceImpl
A constant representing the runAs Subject type
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.
SecureTokenManager - Interface in com.ibm.websphere.objectgrid.security.plugins
This interface is used by ObjectGrid servers to transform an object to a secure token and vice versa.
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
 
SEQUENCE_NUMBER - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
serialize(Collection, ObjectOutputStream, LogSequenceFilter, DistributionMode) - Static method in class com.ibm.websphere.objectgrid.plugins.LogSequenceTransformer
Provides an alternative to the standard serialization method of writeObject.
serializeDataObject(DataObjectContext, Object, XsDataOutputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer
Serialize the specified data object.
SerializedEntry - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
A data object wrapper that wraps a data object and its serialized form.
SerializedKey - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
This interface is used by eXtreme Scale when storing keys in serialized form.
SerializedValue - Interface in com.ibm.websphere.objectgrid.plugins.io.dataobject
This interface is used by eXtreme Scale when storing values in serialized form.
serializeKey(Object, ObjectOutputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectTransformer
Deprecated. Writes a key object to the specified stream.
SerializerAccessor - Interface in com.ibm.websphere.objectgrid.plugins.io
Each BackingMap has a SerializerAccessor associated with it, which includes references to custom DataSerializers that eXtreme Scale uses to serialize, inflate and query data.
serializeValue(Object, ObjectOutputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectTransformer
Deprecated. Writes a value object to the specified stream.
serializeVersionedValue(Object, ObjectOutputStream) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.NoVersioningOptimisticCallback
Deprecated. This method does nothing because no version checking is used.
serializeVersionedValue(Object, ObjectOutputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.OptimisticCallback
Deprecated. Writes the versioned value object to the specified stream.
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 - Interface in com.ibm.websphere.objectgrid.server
The Server is a singleton instance that represents the process scoped elements of an ObjectGrid server.
SERVER_ALL - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for all of the server statistics
SERVER_ALL_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for all of the server statistics
SERVER_COREGROUP_MEMBERSHIP_CHANGE - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
A constant identifying the notification type for all core group membership changes detected by this server.
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.
SERVER_PROCESS_TIME - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for the server client request process time statistic
SERVER_PROCESS_TIME_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for the server client request process time statistic
ServerFactory - Class in com.ibm.websphere.objectgrid.server
A singleton factory for creating and retrieving the ObjectGrid Server singleton.
ServerMapPermission - Class in com.ibm.websphere.objectgrid.security
This class represents permissions to an ObjectMap hosted in a server, that is, a server-side distributed map.
ServerMapPermission(String, String) - Constructor for class com.ibm.websphere.objectgrid.security.ServerMapPermission
Constructs a new ServerMapPermission for the named map with the specified actions.
ServerMapPermission(String, String, String) - Constructor for class com.ibm.websphere.objectgrid.security.ServerMapPermission
Constructs a new ServerMapPermission for the named map with the specified actions.
ServerMapPermission(String, int) - Constructor for class com.ibm.websphere.objectgrid.security.ServerMapPermission
Constructs a new ServerMapPermission for the named map with the specified actions.
ServerMapPermission(String, String, int) - Constructor for class com.ibm.websphere.objectgrid.security.ServerMapPermission
Constructs a new MapPermission for the named map with the specified actions.
ServerMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to access different attributes about a specific server process.
ServerOSGiMBean - Interface in com.ibm.websphere.objectgrid.management
An OSGi MBean to query and manage OSGi service rankings for an entire server instance.
ServerProperties - Interface in com.ibm.websphere.objectgrid.server
The set of properties used to define the behavior of the ObjectGrid server runtime.
ServiceNotAvailableException - Exception in com.ibm.websphere.objectgrid.osgi
A ServiceNotAvailableException indicates one or more specific service rankings are not available.
ServiceNotAvailableException(String, String, Integer) - Constructor for exception com.ibm.websphere.objectgrid.osgi.ServiceNotAvailableException
Constructs a new ServiceNotAvailableException with the specified detail message.
ServiceNotAvailableException(String, Map<String, Integer>) - Constructor for exception com.ibm.websphere.objectgrid.osgi.ServiceNotAvailableException
Constructs a new ServiceNotAvailableException with the specified detail message.
ServiceNotAvailableException(String, Throwable, String, Integer) - Constructor for exception com.ibm.websphere.objectgrid.osgi.ServiceNotAvailableException
Constructs a new ServiceNotAvailableException with the specified detail message and cause.
ServiceNotAvailableException(String, Throwable, Map<String, Integer>) - Constructor for exception com.ibm.websphere.objectgrid.osgi.ServiceNotAvailableException
Constructs a new ServiceNotAvailableException with the specified detail message and cause.
ServiceUpdateException - Exception in com.ibm.websphere.objectgrid.osgi
A ServiceUpdateException is thrown if an OSGi service fails to update to a specific service ranking.
ServiceUpdateException(String, Integer) - Constructor for exception com.ibm.websphere.objectgrid.osgi.ServiceUpdateException
Constructs a new ServiceUpdateException with null as its detail message.
ServiceUpdateException(String, Integer, String) - Constructor for exception com.ibm.websphere.objectgrid.osgi.ServiceUpdateException
Constructs a new ServiceUpdateException with the specified detail message.
ServiceUpdateException(String, Integer, String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.osgi.ServiceUpdateException
Constructs a new ServiceUpdateException with the specified detail message and cause.
ServiceUpdateException(String, Integer, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.osgi.ServiceUpdateException
Constructs a new ServiceUpdateException with a specified cause.
Session - Interface in com.ibm.websphere.objectgrid
This interface represents a session container for ObjectMaps.
Session.TxCommitProtocol - Enum in com.ibm.websphere.objectgrid
The commit protocols that can be used to commit the Session's transaction
SESSION_ALL - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
An integer constant for all of the session statistics
SESSION_ALL_STRING - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
A string constant for all of the session statistics
SessionHandle - Interface in com.ibm.websphere.objectgrid
A SessionHandle includes the partition that a Session is bound to and is useful for per-container partition placement.
SessionHandleTransformer - Class in com.ibm.websphere.objectgrid
A helper class to import and export SessionHandle instances in different formats.
SessionHandleTransformer() - Constructor for class com.ibm.websphere.objectgrid.SessionHandleTransformer
 
SessionIDOverride - Interface in com.ibm.websphere.xs.sessionmanager
This interface can be implemented by WXS Http session replication users who want to control the user session identifier.
SessionIDOverride.InitializationContext - Interface in com.ibm.websphere.xs.sessionmanager
An implementation of this interface will be passed in to all SessionIDOverride.init(InitializationContext) calls so the SessionIDOverride implementation can be initialized
SessionIDOverride.SessionIDContext - Interface in com.ibm.websphere.xs.sessionmanager
An implementation of this interface will be passed in to all SessionIDOverride.getID(SessionIDContext) calls so the SessionIDOverride implementation can determine the unique session identifier for the end user
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.
SessionStatsModule - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a statistic module for HTTP sessions in an ObjectGrid server.
setAccessByCreatorOnlyMode(int) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Set the "access by creator only" mode.
setAccessedSessions(long) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the access to sessions statistic.
setAccessToNonExistentSession(long) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the access to nonexistent sessions statistic.
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.
setActiveSessions(long) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the active sessions statistic.
setAddressableKeyName(String) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
Setter for the addressableKeyName property.
setAddressableKeyName(String) - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Set the addressableKeyName property for the MapDataDescriptor used by this MapSerializer.
setAddressableKeyName(String) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.MapDataDescriptor
Identify the addressable attribute name to use for accessing KeyDataSerialier data when using partial key lookups such as a query.
setAffinityBreaks(long) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the affinity breaks statistic.
setAlias(String) - Method in interface com.ibm.websphere.objectgrid.security.config.SSLConfiguration
Sets the SSL alias name for this SSL configuration.
setAssociations(String) - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Associations are a set of comma-delimited properties that identify relationships from object attributes in map entries in the BackingMap associated with this MapSerializer (the source map) to map entries in another map (the target map).
setAssociations(Map<String, Association>) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.MapDataDescriptor
Identifies any associations between this map and another map.
setAttribute(int, Object) - Method in interface com.ibm.websphere.projector.Tuple
Set the attribute value at the specified position.
setAttributeName(String) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Sets the comma-delimited set of attribute names to include in the index.
setAttributeName(String) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
Sets the comma-delimited values of attribute names to include in the inverse range index.
setAttributeName(String) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Sets the name of the attribute to be indexed.
setAttributeName(String) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Association
Sets the name of the attribute.
setAttributeName(String) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Attribute
Sets the name of the attribute.
setAttributeName(String) - Method in exception com.ibm.websphere.projector.MetadataException
The name of the attribute that this exception refers to or null if the exception doesn't refer to an attribute.
setAttributes(Map<String, Attribute>) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptor
Set the Map of attribute names to the Attribute definition.
setAttributes(Map<String, Attribute>) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.EmbeddedType
Set the Map of attribute names to the Attribute definition.
setAttributes(Object[]) - Method in interface com.ibm.websphere.projector.Tuple
Set the attribute values at the specified positions.
setAttributeType(AttributeType) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Attribute
The type of the attribute.
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.
setAutoReplaceLostShards(boolean) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Setting this to true instructs the placement service to automatically attempt to replace any shards that were lost as the result of container loss.
setAvailabilityState(AvailabilityState) - Method in exception com.ibm.websphere.objectgrid.AvailabilityException
 
setBackingMap(BackingMap) - Method in interface com.ibm.websphere.objectgrid.plugins.BackingMapPlugin
The BackingMap instance is at an undefined state, depending on the type of plug-in and how it was registered with the map.
setBackingMap(BackingMap) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
setBackingMap(BackingMap) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
setBackingMap(BackingMap) - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
 
setBackingMapConfigurations(List) - Method in interface com.ibm.websphere.objectgrid.config.ObjectGridConfiguration
Set the BackingMapConfiguration objects for this ObjectGridConfiguration.
setBeanId(String) - Method in class com.ibm.websphere.objectgrid.plugins.osgi.BluePrintServiceFactory
Set the Blueprint bean ID that declares the plugin class.
setBeginNoWriteThrough(boolean) - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Set the boolean flag indicating whether the Session transaction should be started using using the Session.beginNoWriteThrough() method.
setBlueprintContainer(BlueprintContainer) - Method in class com.ibm.websphere.objectgrid.plugins.osgi.BluePrintServiceFactory
Set the BlueprintContainer instance
setBootStrapListShuffled(boolean) - Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
Sets the value of the BootStrapListShuffled property.
setByteOrder(ByteOrder) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Sets the byte order of the data.
setByteOrder(ByteOrder) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Sets the byte order of the data.
setCacheDiscards(long) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the discarded sessions statistic.
setCatalogClusterEndpoints(String) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Sets the endpoint for each of the catalog service grid members.
setCatalogServer(boolean) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Defines this process as a catalog service if isCatalog is true.
setCatalogServiceBootstrap(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the catalog service grid addresses in the form [host:port,host:port,...].
setCatalogServiceDomain(ObjectGridCatalogServiceDomainBean) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridClientBean
Sets the ObjectGridCatalogServiceDomainBean used by the client.
setCatalogServiceDomain(String) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Set the eXtreme Scale specific property: CatalogDomain
setCatalogServiceEndPoints(String) - Method in class com.ibm.websphere.objectgrid.httpsession.HttpSessionConfigurationUtility
Sets the String which represents the endpoints for all available catalog services
setCatalogServiceEndpoints(String) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCatalogServiceDomainBean
Sets the catalog service endpoints used to connect to the cluster/domain.
setCatalogServiceEndpoints(String) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Set the eXtreme Scale specific property: CatalogServiceEndpoints
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.
setCerts(Certificate[]) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.ClientCertificateCredential
Sets the client certificate chain array.
setChannelFramework(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the TransportMode on the IBM ORB properties to ChannelFramework
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.
setClientOverrideXml(Resource) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCatalogServiceDomainBean
Sets the location of the client override XML.
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.
setClientPropertiesResource(String) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Get the eXtreme Scale specific property: ClientPropertiesResource
setClientPropertiesURL(String) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Set the eXtreme Scale specific property: ClientPropertiesURL
setClientSecurityConfig(Resource) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCatalogServiceDomainBean
Sets the location of the client security configuration.
setClusterSecurityURL(URL) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Sets the location of the security file specific to the catalog service.
setCollection(boolean) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Attribute
Identifies the attribute as a collection attribute values.
setCollisionArbiter(CollisionArbiter) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the CollisionArbiter that is responsible for arbitration of revision conflicts.
setCompressed(boolean) - Method in class com.ibm.websphere.xsa.RestValue
Deprecated. Set indicator to indicate if the contained value is compressed
setCompressionMode(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Sets the compression mode.
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.
setConnectionName(String) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Set the eXtreme Scale specific property: ConnectionName
setContentType(String) - Method in class com.ibm.websphere.xsa.RestValue
Deprecated. Set content type of the contained value
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.
setCreatedSessions(long) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the created sessions statistic.
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.
setCredentialGenerator(CredentialGenerator) - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Sets the CredentialGenerator object for the client security for the connection.
setCredentials(String, String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
 
setDBUpdateMode(TimeBasedDBUpdateConfig.DBUpdateMode) - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
Set the time-based database update mode.
setDevelopmentMode(boolean) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
When development mode is disabled, each shard from a single partition will be placed onto a container running on a different machine.
setDiskOverflowCapBytes(long) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of bytes that can be used by this JVM for overflowing bytes to disk.
setDiskOverflowEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the disk-overflow enablement feature.
setDiskOverflowMinDiskSpaceBytes(long) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the minimum number of bytes that must remain free on disk (in the partition named by diskStoragePath) when overflowing bytes to disk: a request to store data on disk will not be granted if the request will cause this constraint to be violated.
setDiskStoragePath(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the root directory to use for disk overflow.
setDomainEndPoints(String, String) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Set end points for catalog servers in a foreign domain.
setDomainName(String) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Assigns the name of the ObjectGrid domain that this catalog service manages.
setEmbeddedType(EmbeddedType) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Attribute
The type of the embedded attribute.
setEnableOnClientObjectGrid(boolean) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the enableOnClientObjectGrid property
setEnableOnServerObjectGrid(boolean) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the enableOnServerObjectGrid property
setEnableXM(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Enables the eXtremeMemory memory storage mode for the server.
setEncodingScheme(String) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Sets the current string encoding scheme.
setEncodingScheme(String) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Sets the current string encoding scheme.
setEntityClassName(String) - Method in class com.ibm.websphere.objectgrid.jpa.JPALoader
Set the name of the JPA entity class to load.
setEntityClassName(String) - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
Set the entity class name used to interact with the Java Persistence API (JPA) provider.
setEntityClassName(String) - Method in exception com.ibm.websphere.projector.MetadataException
The name of the entity metadata class that this exception refers to.
setEntityMetadata(EntityMetadata) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
setEntityMetadata(EntityMetadata) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
setEntityMetadata(EntityMetadata) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Called by the ObjectGrid runtime to set the EntityMetadata of the BackingMap.
setEntityName(String) - Method in exception com.ibm.websphere.projector.MetadataException
The name of the entity that this exception refers to.
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.
setExceptionMapper(ExceptionMapper) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
Set the ExceptionMapper.
setExclusivePlacement(boolean) - Method in interface com.ibm.websphere.objectgrid.deployment.ZoneRule
Enable or disable exclusive placement within this ZoneRule.
setFieldAccessAttribute(boolean) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Setter for the fieldAccessAttribute property.
setFieldAccessAttribute(boolean) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
Setter for the fieldAccessAttribute property.
setFirstResult(int) - Method in interface com.ibm.websphere.objectgrid.em.Query
Set the position of the first result to retrieve.
setFirstResult(int) - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Set the position of the first result to retrieve.
setFlushMode(FlushModeType) - Method in interface com.ibm.websphere.objectgrid.em.EntityManager
Set the flush mode that applies to all objects contained in the EntityManager's context.
setFlushMode(FlushModeType) - Method in interface com.ibm.websphere.objectgrid.em.Query
Set the flush mode type to be used when the query is executed, overriding the flush mode type set on the EntityManager.
setForeignDomains(String) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Set the foreign domains that this domain will communicate with to establish a multi-primary topology.
setForUpdate(boolean) - Method in interface com.ibm.websphere.objectgrid.em.Query
Set the update intent for the query.
setForUpdate(boolean) - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Set the update intent for the query.
setGlobalIndexEnabled(boolean) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Sets whether to enable global index and create a MapGlobalIndex.
setGroupModule(boolean) - Method in interface com.ibm.websphere.objectgrid.stats.StatsModule
Sets whether this stats module belongs to a StatsFact or StatsGroup.
setHAManagerPort(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the port number for the High Availability Manager (HA Manager).
setHeartBeatFrequencyLevel(int) - Method in interface com.ibm.websphere.objectgrid.management.CoreGroupServiceMBean
Deprecated. This MBean interface is deprecated in 7.1.
setHeartBeatFrequencyLevel(int) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Sets the heartbeat frequency level.
setHint(String, Object) - Method in interface com.ibm.websphere.objectgrid.em.Query
Set a query hint.
setHint(String, Object) - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Set a query hint.
setHPELBufferingEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables HPEL buffering.
setHPELEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables HPEL logging.
setHPELFileSwitchEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables HPEL file switch.
setHPELFileSwitchHour(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the HPEL File Switch Hour
setHPELIncludeTrace(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables HPEL include trace.
setHPELMaxRepositorySize(long) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the HPEL Maximum Repository Size
setHPELMaxRetentionTime(long) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the HPEL Maximum Retention Time
setHPELOutOfSpaceAction(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the HPEL Out Of SpaceAction
setHPELOutputFormat(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the HPEL Output Format
setHPELPurgeBySizeEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables HPEL purge by size.
setHPELPurgeByTimeEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables HPEL purge by time.
setHPELRepositoryPath(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the HPEL Repository Path
setInnerTransactionCallback(TransactionCallback) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
Set the inner transaction callback instance.
setInvalidatedByTimeout(long) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the sessions invalidated by timeout statistic.
setInvalidatedSessions(long) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the invalidated sessions statistic.
setInvalidationModel(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the invalidationModel property
setInvalidationStrategy(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the invalidationStrategy property
setInvRelationshipField(String) - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Set the inverse relationship attribute name of a bi-directional relationship.
setJms_password(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the jms_password property
setJms_topicConnectionFactoryJndiName(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the jms_topicConnectionFactoryJndiName property
setJms_topicJndiName(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the jms_topicJndiName property
setJms_topicName(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the topicName property
setJms_userid(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the jms_userid property
setJMXConnectorPort(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Assigns the JMX connector port that the JMX service is to bind to.
setJMXServicePort(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Assigns the port that the JMX service is to bind to.
setJndi_properties(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the jndiProperties property
setJPAPropertyFactory(JPAPropertyFactory) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
Set the JPAPropertyFactory instance.
setJpaPropertyFactory(JPAPropertyFactory) - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
Set the JPA property factory to override the default persistence properties.
setJvmStatsFileName(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the file name of the CSV statistics file for the JVM.
setJvmStatsLoggingEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables log data for the JVM to be written to a CSV file.
setJvmStatsWriteRate(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the write rate of the CSV statistics files for the JVM in seconds.
setKeyOutputFormat(OutputFormat) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the data format for all data access APIs that return cache keys.
setKeyOutputFormat(OutputFormat) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Sets the data format for all data access APIs that return cache keys.
setKeyOutputFormat(OutputFormat) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Sets the data format for all data access APIs that return cache keys for the current session.
setKeyProperties(String) - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Set the String property on the KeyDataSerializer.
setKeySerializerPlugin(KeySerializerPlugin) - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Used to programmatically set the KeySerializerPlugin for local ObjectGrid instances.
setKeySerializerPluginClass(String) - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Sets the name of the KeySerializerPlugin class.
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.
setListenerHost(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Assigns the host that the ORB is to bind to.
setListenerPort(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Assigns the port that the ORB is to bind to.
setLoader(Loader) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Associates a Loader with this BackingMap.
setLocalGrid(boolean) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Set the eXtreme Scale specific property: LocalGrid
setLocalObjectGrid(ObjectGrid) - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Sets a local ObjectGrid instance to be used for connections.
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.
setLogNotificationFilter(String) - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Sets the regular expression filter to be applied in screening log record messages before being broadcasted by the grid server as a JMX Notification of type:
setLogNotificationFilter(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the regular expression filter to be applied to log records messages that are forwarded as JMX notifications by the ObjectGrid server through the LoggerListenerJMXNotifier
setLogWriter(PrintWriter) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Set the log writer for this ManagedConnectionFactory instance
setManagementConcentrator(boolean) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Defines the behavior of this catalog service to enable the MBean notifications concentrator.
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.
setMapName(String) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
Sets the ObjectMap name.
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.
setMapStatsFileName(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the file name of the CSV statistics file for the Map.
setMapStatsLoggingEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables log data for the Map to be written to a CSV file.
setMapStatsWriteRate(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the write rate of the CSV statistics files for the Map in seconds.
setMapsToPublish(List) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
If this is specified then only the maps in the list will be published.
setMapsToPublish(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the mapsToPublish property
setMaxAsyncReplicas(int) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Set the maximum number of asynchronous replicas for each partition in the MapSet.
setMaxFetchDepth(int) - Method in interface com.ibm.websphere.projector.FetchPlan
Set the maximum fetch depth of eager relationships to retrieve.
setMaximumJVMStatsFiles(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of CSV statistics files that are generated for the JVM Stats.
setMaximumJVMStatsFileSize(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum file size, in megabytes, of the CSV statistics files for the JVM.
setMaximumMapStatsFiles(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of CSV statistics files that are generated for the Map Stats.
setMaximumMapStatsFileSize(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum file size, in megabytes, of the CSV statistics files for the Map.
setMaximumOGStatsFiles(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of CSV statistics files that are generated for the ObjectGrid Stats.
setMaximumOGStatsFileSize(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum file size, in megabytes, of the CSV statistics files for the ObjectGrid.
setMaximumSize(int) - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Sets the maximum thread pool size.
setMaximumThreadPoolSize(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of threads in the pool.
setMaximumXIONetworkThreads(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of threads to allocate in the eXtremeIO transport network thread pool.
setMaximumXIOWaitingMessages(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum number of messages waiting to be processed.
setMaximumXIOWorkerThreads(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Retrieves the maximum number of threads to allocate in the eXtremeIO transport request processing thread pool.
setMaximumXMSize(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the maximum amount of eXtremeMemory (in megabytes) to allocate when eXtremeMemory is enabled.
setMaxNumberOfReplicas(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Sets the maximum number of replicas for the EMBEDDED or EMBEDDED_PARTITION ObjectGrid type
setMaxNumberOfReplicas(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Sets the maximum number of replicas for the EMBEDDED or EMBEDDED_PARTITION ObjectGrid type
setMaxResults(int) - Method in interface com.ibm.websphere.objectgrid.em.Query
Set the maximum number of results to retrieve.
setMaxResults(int) - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Set the maximum number of results to retrieve.
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.
setMaxSyncReplicas(int) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Set the maximum number of synchronous replicas for each partition in the MapSet.
setMaxUsedMemory(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Sets whether memory based eviction is enabled
setMaxUsedMemory(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Sets whether memory based eviction is enabled
setMBeansEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Enables or disables ObjectGrid MBean registration for this process.
setMemoryCount(long) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the sessions in memory count statistic.
setMemoryThresholdPercentage(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the memory threshold usage percentage, (set up to 100% ).
setMinimumSize(int) - Method in interface com.ibm.websphere.objectgrid.management.ThreadPoolMBean
Sets the minimum thread pool size.
setMinimumThreadPoolSize(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the minimum number of threads in the pool.
setMinimumXIONetworkThreads(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the minimum number of threads to allocate in the eXtremeIO transport network thread pool.
setMinimumXIOWorkerThreads(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the minimum number of threads to allocate in the eXtremeIO transport request processing thread pool.
setMinSyncReplicas(int) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Set the minimum number of synchronous replicas for each partition in the MapSet.
setMultiPartitionSupportEnabled(boolean) - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Set the boolean flag indicating that the Session transaction can perform write operations to a multiple partitions.
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.deployment.MapSet
Set the name of this MapSet
setName(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the name of this ObjectGrid.
setName(String) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Sets the name of this index.
setName(String) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
Sets the name of this index.
setName(String) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
Sets the cache name.
setNearCacheEnabled(Boolean) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Enables or disables the client local cache for supported configurations.
setNearCacheInvalidationEnabled(Boolean) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Set to true to enable client near cache invalidation.
setNearCacheLastAccessTTLSyncEnabled(Boolean) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Enables or disables time-to-live access information synchronization to the remote data grid when accessed and the TTLType.LAST_ACCESS_TIME TTL evictor type is configured.
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
Deprecated. Deprecated in 8.6. Buckets are no longer required. Use the BackingMap.isNearCacheEnabled() flag to disable the near cache in the ObjectGrid configuration XML file.
setNumberOfBuckets(int) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Deprecated. Deprecated in 8.6. Buckets are no longer required. Use the BackingMapConfiguration.isNearCacheEnabled() flag to disable the near cache in the ObjectGrid configuration XML file.
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.
setNumberOfPartitions(int) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Set the number of partitions for this MapSet.
setNumberOfPartitions(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Sets the number of partitions to be used in the cache
setNumberOfPartitions(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Sets the number of partitions to be used in the cache
setNumInitialContainers(int) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Set the number of containers that must be available to host this MapSet before initial placement will occur.
setObjectGrid(ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridPlugin
The ObjectGrid instance is at an undefined state, depending on the type of plug-in and how it was registered with the map.
setObjectGridAuthorization(ObjectGridAuthorization) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the ObjectGridAuthorization for this ObjectGrid instance.
setObjectGridClient(ObjectGridClientBean) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridCache
Sets the ObjectGridClientBean to use.
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.
setObjectGridName(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Sets the name of the ObjectGrid that handles the cache
setObjectGridName(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Sets the name of the ObjectGrid that handles the cache
setObjectGridName(String) - Method in class com.ibm.websphere.objectgrid.spring.ObjectGridClientBean
Sets the name of the ObjectGrid for the client.
setObjectGridName(String) - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
Sets the object grid name to be used for the connection.
setObjectGridName(String) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Set the eXtreme Scale specific property: ObjectGrid Name
setObjectGridResource(String) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Set the eXtreme Scale specific property: ObjectGridResource
setObjectGridState(AvailabilityState, ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.StateManager
Set the AvailabilityState for an ObjectGrid.
setObjectGridType(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Sets the ObjectGrid type.
setObjectGridType(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Sets the ObjectGrid type.
setObjectGridURL(String) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Set the eXtreme Scale specific property: ObjectGridURL
setObjectTransformer(ObjectTransformer) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the ObjectTransformer object for use by this BackingMap and/or Loader.
setOGStatsFileName(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the file name of the CSV statistics file for the ObjectGrid.
setOGStatsLoggingEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables log data for the ObjectGrid to be written to a CSV file.
setOGStatsWriteRate(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the write rate of the CSV statistics files for the ObjectGrid in seconds.
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.
setParameter(String, Object) - Method in interface com.ibm.websphere.objectgrid.em.Query
Bind an argument to a named parameter.
setParameter(int, Object) - Method in interface com.ibm.websphere.objectgrid.em.Query
Bind an argument to a positional parameter.
setParameter(String, Object) - Method in interface com.ibm.websphere.objectgrid.em.QueryQueue
Bind an argument to a named parameter.
setParameter(int, Object) - Method in interface com.ibm.websphere.objectgrid.em.QueryQueue
Bind an argument to a positional parameter.
setParameter(String, Object) - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Bind an argument to a named parameter.
setParameter(int, Object) - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Bind an argument to a positional parameter.
setPartition(int) - Method in interface com.ibm.websphere.objectgrid.em.Query
Set the partition to route the query to.
setPartition(int) - Method in interface com.ibm.websphere.objectgrid.em.QueryQueue
Set the partition to route the QueryQueue to.
setPartition(int) - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Set the partition to route the query to.
setPassword(String) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
Sets the password for this credential.
setPathSeparator(String) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.DataDescriptor
The string to use to use for attribute navigation for embedded attributes.
setPeriodLength(long) - Method in interface com.ibm.websphere.objectgrid.stats.ActiveLongStatistic
Sets the length of the time period in milliseconds.
setPermissionCheckPeriod(int) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Sets the permission check period.
setPersistenceUnitName(String) - Method in class com.ibm.websphere.objectgrid.jpa.JPATxCallback
Set the JPA persistence unit name
setPersistenceUnitName(String) - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
Set the JPA persistence unit name.
setPlacementDeferralInterval(long) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Sets the placement deferral interval.
setPlacementScope(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Set the scope used for partition placement.
setPlacementScope(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Set the scope used for partition placement.
setPlacementScopeTopology(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Set the link topology used to perform intradomain replication.
setPlacementScopeTopology(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Set the link topology used to perform intradomain replication.
setPlacementStrategy(byte) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Set the placement strategy that this MapSet should employ.
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.
setPOJOKeyIndex(boolean) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Setter for the POJOKeyIndex property.
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.
setPreLoadMode(boolean) - Method in class com.ibm.websphere.objectgrid.hibernate.cache.ObjectGridHibernateCacheProvider
Overrides
setPreloadPartition(int) - Method in class com.ibm.websphere.objectgrid.jpa.JPALoader
Specify the partition at which the map preload will be launched.
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.
setPropagateMode(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Sets the propagate mode.
setPropagateService(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Sets the propagate service.
setPropagateVersionOption(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Sets the propagate version option.
setProperties(Properties) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
setProperties(Properties) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
setProperties(Properties) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Set properties of a MapIndexPlugin instance.
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.
setProperties(String) - Method in interface com.ibm.websphere.objectgrid.security.plugins.SecureTokenManager
Sets 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.
setPutMode(ObjectMap.PutMode) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Allows the default operation for the ObjectMap.put(Object, Object) and ObjectMap.putAll(Map) methods to be changed, allowing the put to use the optimized ObjectMap.upsert(Object, Object) and ObjectMap.upsertAll(LinkedHashMap) implementations.
setQueryConfig(QueryConfig) - Method in interface com.ibm.websphere.objectgrid.ObjectGrid
Set the QueryConfig object for this ObjectGrid.
setQuorum(boolean) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Defines the behavior of this catalog service to enable quorum.
setRangeIndex(boolean) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
Sets whether to create a MapRangeIndex or a MapIndex.
setReadOnly(boolean) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the map type of this BackingMap.
setReference(Reference) - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
Sets the Reference instance
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.
setReplicaMode(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Sets the replica mode
setReplicaMode(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Sets the replica mode
setReplicaReadEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.deployment.MapSet
Enable or disable reading data from replicas.
setReplicaReadEnabled(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Sets whether reading from replica is enabled
setReplicaReadEnabled(String) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Sets whether reading from replica is enabled
setReplicationDisabled(boolean) - Method in class com.ibm.websphere.objectgrid.httpsession.HttpSessionConfigurationUtility
Sets whether or not replication is disabled for this server.
setReplicationGroup(int) - Method in exception com.ibm.websphere.objectgrid.ObjectGridRPCException
Deprecated. Sets the replication group identifier for this exception.
setReplicationGroup(int) - Method in exception com.ibm.websphere.objectgrid.UnavailableServiceException
Sets the replication group identifier for this exception.
setReplicationRole(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the replicationRole property
setReplicationStrategy(String) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
Setter for the replicationStrategy property
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.
setResourceAdapter(ResourceAdapter) - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
Associate this object with an eXtreme Scale resource adapter.
setResultEntityName(String) - Method in interface com.ibm.websphere.objectgrid.em.Query
Specify the name of the query result entity.
setResultMapName(String) - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
The map to insert the results into.
setResultType(ObjectQuery.ResultType) - Method in interface com.ibm.websphere.objectgrid.query.ObjectQuery
Set the ObjectQuery.ResultType for a query using an ObjectMap that is configured with a KeySerializerPlugin or ValueSerializerPlugin.
setRetryIndicationSlot(int) - Method in class com.ibm.websphere.objectgrid.jpa.JPALoader
 
setRetryIndicationSlot(int) - Method in interface com.ibm.websphere.objectgrid.plugins.RetryableLoader
set the slot number which contains whether the batch update from ObjectGrid is a retry of previous transaction.
setRollbackOnly() - Method in interface com.ibm.websphere.objectgrid.em.EntityTransaction
Mark the current transaction so that the only possible outcome of the transaction is for the transaction to be rolled back.
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.
setServerName(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the name used to identify this process.
setServerSecurityFileName(String) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Sets the server security file name.
setSessionHandle(SessionHandle) - Method in interface com.ibm.websphere.objectgrid.Session
Apply a SessionHandle to this session.
setSessionID(String) - Method in interface com.ibm.websphere.objectgrid.stats.SessionStatsModule
Set the session ID.
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.
setSpec(String) - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Sets the statistic specification
setSpec(int) - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Sets the statistic specification
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.
setStatsSpec(StatsSpec) - Method in interface com.ibm.websphere.objectgrid.stats.StatsAccessor
Sets the StatsSpec for all the local ObjectGrid instances in this process.
setStatsSpec(String) - Method in interface com.ibm.websphere.objectgrid.stats.StatsAccessor
Sets the StatsSpec for all the local ObjectGrid instances in this process.
setStatsSpecification(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the initial statistics specification that the ObjectGrid server should start with.
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.
setSyslogEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
When set to true, enables Syslog logging.
setSyslogFacility(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the Syslogd Facility
setSyslogHostName(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the Syslogd Server host full name or IP address
setSyslogHostPort(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the Syslogd Server host port number
setSyslogThreshold(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Specifies the Syslogd Threshold
setSystemStreamsToFileEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the trace logic to write SystemOut and SystemErr to file, or not write to file.
setTargetClass(String) - Method in class com.ibm.websphere.objectgrid.config.QueryRelationship
Set the name of the class representing the target of a relationship.
setTargetMapName(String) - Method in interface com.ibm.websphere.objectgrid.plugins.io.datadescriptor.Association
The name of the associated map.
setTimeBasedDBUpdateConfig(TimeBasedDBUpdateConfig) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Set the time-based database update configuration object.
setTimestampField(String) - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
The timestamp field is a field of the entity class.
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.
setTopic(Topic) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
 
setTopicConnectionFactory(TopicConnectionFactory) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
 
setTraceEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Enables or disables ObjectGrid trace for the JVM.
setTraceEnabled(String) - Method in class com.ibm.websphere.objectgrid.rest.RestService
 
setTraceEnabled(String) - Method in interface com.ibm.websphere.objectgrid.rest.RestServiceMBean
Enables or disables trace for the REST data service.
setTraceFileName(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Sets the trace output to go to a file instead of System.out.
setTraceFileName(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Assigns the file to use for logging trace.
setTraceSpec(String) - Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
Set the trace specification for the server.
setTraceSpec(String) - Method in class com.ibm.websphere.objectgrid.rest.RestService
 
setTraceSpec(String) - Method in interface com.ibm.websphere.objectgrid.rest.RestServiceMBean
Set the trace specification for the JVM in which the REST data service is running.
setTraceSpecification(String) - Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
Set the trace specification for the current JVM.
setTraceSpecification(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Assigns the specification that the server should use on initialization.
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.
setTransport(String) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Sets the transport for the catalog service domain
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.
setTxCommitProtocol(Session.TxCommitProtocol) - Method in interface com.ibm.websphere.objectgrid.Session
Set the commit protocol to be used when committing this Session's transaction.
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.WSSubjectSourceImpl
Sets the subject type, either RUN_AS_SUBJECT or CALLER_SUBJECT
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.
setValue(byte[]) - Method in class com.ibm.websphere.xsa.RestValue
Deprecated. Set contained value
setValueClass(String) - Method in class com.ibm.websphere.objectgrid.config.QueryMapping
Set the type of object that is stored in the BackingMap.
setValueOutputFormat(OutputFormat) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Sets the data format for all data access APIs that return cache values.
setValueOutputFormat(OutputFormat) - Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
Sets the data format for all data access APIs that return cache values.
setValueOutputFormat(OutputFormat) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Sets the data format for all data access APIs that return cache values for the current session.
setValueProperties(String) - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Set the String properties on the ValueDataSerializer.
setValueSerializerPlugin(ValueSerializerPlugin) - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Retrieves the name of the ValueDataSerializer class that was set with the BasicMapSerializerPlugin.setValueSerializerPluginClass(String).
setValueSerializerPluginClass(String) - Method in class com.ibm.websphere.objectgrid.plugins.io.BasicMapSerializerPlugin
Sets the name of the ValueSerializerPlugin class.
setVersionedValue(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
Used to update the versioned object after an update of map entry occurs.
setWASManagedContainerShutdownEnabled(boolean) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Set to true if the WebSphere Application Server should automatically stop the eXtreme Scale container when the hosting application server is stopped and the container was started using the eXtreme Scale Server.createContainer(com.ibm.websphere.objectgrid.deployment.DeploymentPolicy) API.
setWorkingDirectory(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the working directory for the ObjectGrid server runtime to use.
setWriteBehind(String) - Method in interface com.ibm.websphere.objectgrid.BackingMap
Enable write-behind updates for this map.
setXIOChannelProps(Map<String, ? extends Properties>) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the channel properties for the eXtremeIO transport, replacing all current channel properties with the specified map of properties.
setXIOTimeout(int) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the current timeout for server requests using the XIO transport.
setZoneName(String) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Sets the zone that this server belongs to.
setZones(Set) - Method in interface com.ibm.websphere.objectgrid.deployment.ZoneRule
Set the zones for this Zone Rule.
SEVERITY_LEVEL - Static variable in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
A constant identifying the composite data representing notification severity level.
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 class com.ibm.websphere.objectgrid.jpa.JPATxCallback
 
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 class com.ibm.websphere.objectgrid.jpa.JPATxCallback
 
shardDeactivate(ObjectGrid) - Method in interface com.ibm.websphere.objectgrid.plugins.ObjectGridEventGroup.ShardEvents
This is called when a primary shard is demoted to a replica.
ShardMapping - Interface in com.ibm.websphere.objectgrid.deployment
A ShardMapping is used to associate a shard with a ZoneRule.
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.
ShardType - Class in com.ibm.websphere.objectgrid.deployment
Defines the type of shard for the ShardMappings.
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.
SimpleDeptPrincipal - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class implements the Principal interface and represents a simple user.
SimpleDeptPrincipal(String) - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleDeptPrincipal
Creates a SimpleDeptPrincipal with a username.
SimpleLDAPLoginModule - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
SimpleLDAPLoginModule authenticates a user name and password to the configured LDAP server.
SimpleLDAPLoginModule() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleLDAPLoginModule
 
SimpleUserPrincipal - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class implements the Principal interface and represents a simple user.
SimpleUserPrincipal(String) - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleUserPrincipal
Creates a SimpleUserPrincipal with a user name.
size() - Method in interface com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryCache
Return the number of keys in the cache.
size() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Gets the total number of bytes in this stream.
size() - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Gets the current size of this stream in number of bytes.
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
Deprecated. Snapshot replication mode.
SOURCE_CLASS_NAME - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
SOURCE_ID - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
SOURCE_METHOD_NAME - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
SOURCE_SERVER - Static variable in interface com.ibm.websphere.objectgrid.management.ManagementConcentratorMBean
A constant identifying the composite data representing the source of notification.
SPECIFICATION_DELIMIT - Static variable in class com.ibm.websphere.objectgrid.stats.StatsSpec
The delimiter for separating the statistic specification string.
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.
start(BootstrapContext) - Method in class com.ibm.websphere.xs.ra.XSResourceAdapter
This method initializes the eXtreme Scale resource adapter instance
startDBUpdate(ObjectGrid, String, String, Class, String, TimeBasedDBUpdateConfig.DBUpdateMode) - Method in class com.ibm.websphere.objectgrid.jpa.dbupdate.TimeBasedDBUpdater
Start a time-base database update thread to keep the ObjectGrid data updated from the database back end
startTransactionReceiver() - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Stops the transaction receiver background thread.
StateManager - Interface in com.ibm.websphere.objectgrid
The StateManager can be used to retrieve the availability state of an ObjectGrid.
StateManagerFactory - Class in com.ibm.websphere.objectgrid
This factory class is a helper class to get the StateManager instance.
StateManagerFactory() - Constructor for class com.ibm.websphere.objectgrid.StateManagerFactory
 
Statistic - Interface in com.ibm.websphere.objectgrid.stats
This inteface represents statistical data.
StatsAccessor - Interface in com.ibm.websphere.objectgrid.stats
This interface is used to access StatsFact objects from the statistic repository and set the statistic specification for all in-process ObjectGrid instances.
StatsAccessorFactory - Class in com.ibm.websphere.objectgrid.stats
This class is a factory for StatsAccessor objects.
StatsAccessorFactory() - Constructor for class com.ibm.websphere.objectgrid.stats.StatsAccessorFactory
 
StatsFact - Interface in com.ibm.websphere.objectgrid.stats
A StatsFact interface represents an Object which contains a StatsModule.
StatsGroup - Interface in com.ibm.websphere.objectgrid.stats
StatsGroup is a parent of a collection of StatsFact instances.
StatsModule - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a statistic module.
StatsSpec - Class in com.ibm.websphere.objectgrid.stats
This class defines the statistics specification strings and integer masks to use for enabling and disabling statistics modules.
StatsSpec() - Constructor for class com.ibm.websphere.objectgrid.stats.StatsSpec
Creates a new StatsSpec object with a NONE statistic specification
StatsSpec(String) - Constructor for class com.ibm.websphere.objectgrid.stats.StatsSpec
Creates a new StatsSpec object with a string representation of the statistic specification.
StatsSpec(int) - Constructor for class com.ibm.websphere.objectgrid.stats.StatsSpec
Creates a new StatsSpec with an integer representation of the statistic specification.
statsToString() - Method in interface com.ibm.websphere.objectgrid.stats.StatsFact
Returns a string representation of all the statistics.
statsToString() - Method in interface com.ibm.websphere.objectgrid.stats.StatsModule
Gets a string representation of this statistic module including all the statistics in it.
stop() - Method in class com.ibm.websphere.xs.ra.XSResourceAdapter
This method performs the shutdown of the eXtreme Scale resource adapter instance
stopDBUpdate(ObjectGrid, String) - Method in class com.ibm.websphere.objectgrid.jpa.dbupdate.TimeBasedDBUpdater
Stop the time-based database update thread
stopServer() - Method in interface com.ibm.websphere.objectgrid.management.ServerMBean
Stops the server associated with this MBean.
stopServer() - Static method in class com.ibm.websphere.objectgrid.server.ServerFactory
Stops the server if it was previously started
stopTransactionReceiver(boolean) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Stops the transaction receiver background thread.
store(OutputStream) - Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
Writes the properties from this object into output.
store(OutputStream) - Method in interface com.ibm.websphere.objectgrid.server.ServerProperties
Writes the properties from this object into output.
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.
SubjectSource - Interface in com.ibm.websphere.objectgrid.security.plugins
This plugin can be used to get a Subject which represents an ObjectGrid client.
SubjectValidation - Interface in com.ibm.websphere.objectgrid.security.plugins
This plugin can be used to validate that a Subject passed to the ObjectGrid is a valid Subject which has not been tampered with.
SUBSCRIBER_ROLE_STRING - Static variable in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
The constant string that can be used in setReplicationRole(String) method for setting replicationRole as SUBSCRIBER_ROLE.
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 class com.ibm.websphere.objectgrid.deployment.ShardType
Represents a synchronous replica shard.
SYNCHRONOUS_REPLICA - Static variable in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
Constant representing a synchronous replica shard type.
SYSTEM_KEY_INDEX_NAME - Static variable in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
A built-in index of the the local ObjectGrid instance that allows iterating over all of the keys in a map.

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.
THREAD_ID - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
ThreadPoolMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows user to access the thread pool properties.
THROWN_MESSAGE - Static variable in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
 
TimeBasedDBUpdateConfig - Class in com.ibm.websphere.objectgrid
This TimeBasedDBUpdateConfig represents a configuration for a time-based database updater.
TimeBasedDBUpdateConfig() - Constructor for class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
 
TimeBasedDBUpdateConfig.DBUpdateMode - Class in com.ibm.websphere.objectgrid
An type of DBUpdateMode specifies how the database changes should be pushed to the ObjectGrid maps.
TimeBasedDBUpdater - Class in com.ibm.websphere.objectgrid.jpa.dbupdate
A time-based database updater can be used to periodically get the latest inserts and updates to the ObjectGrid backend database.
TIMEOUT_INFINITE - Static variable in interface com.ibm.websphere.objectgrid.em.QueryQueue
Used as a parameter on the QueryQueue.getNextEntity(long) or QueryQueue.getNextEntity(long) method.
TIMEOUT_NONE - Static variable in interface com.ibm.websphere.objectgrid.em.QueryQueue
Used as a parameter on the QueryQueue.getNextEntity(long) or QueryQueue.getNextEntity(long) method.
Timestamp - Annotation Type in com.ibm.websphere.objectgrid.jpa.dbupdate.annotation
This annotation specifies the timestamp field of an entity class that serves for the time-based update purpose.
TimeStatistic - Interface in com.ibm.websphere.objectgrid.stats
This interface represents a standard time measurement.
TM - Static variable in interface com.ibm.websphere.objectgrid.management.TransactionMBean
Indicates that this partition has been assigned as the Transaction Manager (TM) for this transaction.
toByteArray() - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Gets the underlying bytes of this stream.
toByteArray() - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Gets a copy of the underlying bytes.
toByteArray(SessionHandle) - Static method in class com.ibm.websphere.objectgrid.SessionHandleTransformer
Converts the sessionHandle instance into a byte array.
toByteBuffer(ByteBuffer) - Method in class com.ibm.websphere.objectgrid.io.XsDataInputStream
Transfers the underlying bytes of this stream to the given byte buffer at current position.
toByteBuffer(ByteBuffer) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes the content of this stream on to the given buffer starting at its current position.
toInt() - Method in class com.ibm.websphere.objectgrid.plugins.DistributionMode
Return the int representation of mode
toString() - Method in class com.ibm.websphere.objectgrid.AvailabilityState
 
toString() - Method in class com.ibm.websphere.objectgrid.ClientReplicableMap.Mode
Deprecated.  
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.continuousquery.filter.AbstractCQFilter
 
toString() - Method in class com.ibm.websphere.objectgrid.CopyMode
Returns a string representation of the CopyMode.
toString() - Method in class com.ibm.websphere.objectgrid.deployment.ShardType
Returns a string representation of the ShardType.
toString() - Method in class com.ibm.websphere.objectgrid.em.FlushModeType
 
toString() - Method in class com.ibm.websphere.objectgrid.LockStrategy
Returns a string representation of the LockStrategy.
toString() - Method in class com.ibm.websphere.objectgrid.osgi.OSGiServiceRepository.OSGiServiceKey
 
toString() - Method in class com.ibm.websphere.objectgrid.plugins.DistributionMode
Returns a string representation of the DistributionMode.
toString() - Method in class com.ibm.websphere.objectgrid.plugins.index.MapIndex.SpecialValue
Returns a string representation of the SpecialValue.
toString() - Method in interface com.ibm.websphere.objectgrid.plugins.io.dataobject.SerializedEntry
Return a user readable representation of the entry.
toString() - Method in class com.ibm.websphere.objectgrid.plugins.Loader.SpecialValue
 
toString() - Method in class com.ibm.websphere.objectgrid.plugins.LogElement.Type
 
toString() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleDeptPrincipal
Returns a string representation of this SimpleDeptPrincipal.
toString() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.SimpleUserPrincipal
Returns a string representation of this SimpleUserPrincipal.
toString() - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredential
 
toString(SessionHandle) - Static method in class com.ibm.websphere.objectgrid.SessionHandleTransformer
Converts the sessionHandle instance into a small stringified representation.
toString() - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Gets the String representation of this statistic.
toString() - Method in class com.ibm.websphere.objectgrid.stats.StatsSpec
Gets the String representation of this StatsSpec
toString() - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig.DBUpdateMode
 
toString() - Method in class com.ibm.websphere.objectgrid.TTLType
Returns a string representation of the TTLType.
toString() - Method in class com.ibm.websphere.projector.md.AccessType
Returns a string representation of the AccessType.
toString() - Method in class com.ibm.websphere.projector.md.AssociationType
Returns a string representation of the AssociationType.
toString() - Method in class com.ibm.websphere.projector.md.FetchType
Returns a string representation of the FetchType.
toString() - Method in class com.ibm.websphere.xs.ra.XSConnection
 
toString() - Method in class com.ibm.websphere.xs.ra.XSConnectionFactory
 
toString() - Method in class com.ibm.websphere.xs.ra.XSConnectionSpec
 
toString() - Method in class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
 
toString() - Method in class com.ibm.websphere.xs.ra.XSResourceAdapter
 
toString() - Method in class com.ibm.websphere.xsa.RestValue
Deprecated.  
toStringDataObject(DataObjectContext, XsDataInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.DataSerializer.UserReadable
Return a user-readable form of the data object.
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) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Updates the last access time in the BackingMap without retrieving the value to the ObjectMap.
TOUCH - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the TOUCH operation.
TranPropListener - Class in com.ibm.websphere.objectgrid.plugins.builtins
Deprecated. This plug-in has been deprecated in version 7.1.1. See the JMSObjectGridEventListener plug-in for equivalent function.
TranPropListener() - Constructor for class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated. Creates a new TranPropListener.
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 class com.ibm.websphere.objectgrid.jpa.JPATxCallback
 
transactionBegin(String, boolean) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
 
transactionBegin(String, boolean) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated.  
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 class com.ibm.websphere.objectgrid.jpa.JPATxCallback
 
transactionEnd(String, boolean, boolean, Collection) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.JMSObjectGridEventListener
This is called whenever a transaction commits for the grid.
transactionEnd(String, boolean, boolean, Collection) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
Deprecated.  
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.
TransactionMBean - Interface in com.ibm.websphere.objectgrid.management
This MBean interface allows a client process to retrieve and heuristically resolve all indoubt transactions from a partition running in a dynamic environment.
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.
TransactionRequiredException - Exception in com.ibm.websphere.objectgrid.em
Thrown when a transaction is required but not active.
TransactionRequiredException() - Constructor for exception com.ibm.websphere.objectgrid.em.TransactionRequiredException
 
TransactionRequiredException(String) - Constructor for exception com.ibm.websphere.objectgrid.em.TransactionRequiredException
 
TransactionRequiredException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.TransactionRequiredException
 
TransactionRequiredException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.em.TransactionRequiredException
 
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, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.TransactionTimeoutException
 
TransactionTimeoutException(String, String) - Constructor for exception com.ibm.websphere.objectgrid.TransactionTimeoutException
Constructs a new TransactionTimeoutException with the specified detail message.
Transient - Annotation Type in com.ibm.websphere.projector.annotations
The Transient annotation is used to annotate a property or field of an entity class.
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.
TrueFilter - Class in com.ibm.websphere.objectgrid.continuousquery.filter
This filter always passes.
TrueFilter() - Constructor for class com.ibm.websphere.objectgrid.continuousquery.filter.TrueFilter
 
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.
Tuple - Interface in com.ibm.websphere.projector
A Tuple is a data structure that holds primitive attributes and associations (relationships) to other tuples.
TupleAssociation - Interface in com.ibm.websphere.projector.md
The metadata for an association between two entities.
TupleAssociation.CascadeInfo - Interface in com.ibm.websphere.projector.md
Cascade information for entity association persistence.
TupleAssociation.OrderByInfo - Interface in com.ibm.websphere.projector.md
Ordering information for multi-valued associations.
TupleAssociation.OrderByInfo.OrderByElement - Interface in com.ibm.websphere.projector.md
Ordering details for an attribute in the target entity.
TupleAttribute - Interface in com.ibm.websphere.projector.md
The metadata for a single basic attribute.
TupleMetadata - Interface in com.ibm.websphere.projector.md
This describes the metadata for a Tuple.
txCallback - Variable in class com.ibm.websphere.objectgrid.jpa.JPALoader
 
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.
UNDEFINED - Static variable in class com.ibm.websphere.projector.md.AccessType
The method in which the persistent state of an entity is accessed is not defined.
UNDEFINED - Static variable in class com.ibm.websphere.projector.md.FetchType
The method in which the data is fetched is undefined.
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_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.
undoBatchUpdate(TxID, LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
 
undoBatchUpdate(TxID, LogSequence) - Method in class com.ibm.websphere.objectgrid.plugins.index.InverseRangeIndex
 
undoBatchUpdate(TxID, LogSequence) - Method in interface com.ibm.websphere.objectgrid.plugins.index.MapIndexPlugin
Called by the ObjectGrid runtime to undo any changes made to the index as a result of a prior call to the doBatchUpdate(TxID, LogSequence) method.
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.
unpinAll(Class, boolean) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
This is not applicable to ObjectGrid
unpinInternal(Object) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
This is not applicable to ObjectGrid
unpinInternal(QueryKey) - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
This is not applicable to ObjectGrid
unregisterMapSerializerPlugin() - Method in interface com.ibm.websphere.objectgrid.plugins.io.SerializerAccessor
Remove the MapSerializerPlugin instance.
update(Object, Object) - Method in interface com.ibm.websphere.objectgrid.JavaMap
Performs an explicit update of a given entry.
update(Object, Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Performs an explicit update of a given entry.
UPDATE - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the UPDATE operation.
update(Statistic) - Method in interface com.ibm.websphere.objectgrid.stats.Statistic
Updates this statistic with the given value.
update() - Method in interface com.ibm.websphere.objectgrid.stats.StatsModule
Updates the statistics in this stats module.
UPDATE_ONLY - Static variable in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig.DBUpdateMode
UPDATE_ONLY type indicates to update the existing entries in the ObjectGrid map with the latest values from database.
updateVersion(DataObjectContext, XsDataInputStream, XsDataOutputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer.Versionable
Invoked when the version of the cache entry needs to be updated to the next version.
updateVersionedObjectForValue(Object) - Method in class com.ibm.websphere.objectgrid.plugins.builtins.NoVersioningOptimisticCallback
Deprecated. This method does nothing because no version checking is used.
updateVersionedObjectForValue(Object) - Method in interface com.ibm.websphere.objectgrid.plugins.OptimisticCallback
Deprecated. Called whenever a transaction has updated a value and a new versioned object is needed.
upsert(Object, Object) - Method in interface com.ibm.websphere.objectgrid.ObjectMap
Puts the Object value into the cache at location represented by key.
UPSERT - Static variable in interface com.ibm.websphere.objectgrid.plugins.LogElement
The Type that represents the UPSERT operation.
upsertAll(LinkedHashMap) - 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.
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.
useRanking(String, Integer) - Method in interface com.ibm.websphere.objectgrid.osgi.ObjectGridOSGiManager
To use the service for a specific ranking.
useRanking(Map<String, Integer>) - Method in interface com.ibm.websphere.objectgrid.osgi.ObjectGridOSGiManager
To use a set of services with specific rankings.
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

validateAttributePath(String) - Method in class com.ibm.websphere.objectgrid.continuousquery.filter.AbstractCQFilter
Ensure that attribute path used to retrieve an attribute from a cache entry is valid.
validateSubject(Subject) - Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.WSSubjectValidationImpl
Validates that the subject has not been tampered with.
validateSubject(Subject) - Method in interface com.ibm.websphere.objectgrid.security.plugins.SubjectValidation
Validates the Subject has not been tampered with.
value - Variable in class com.ibm.websphere.xsa.RestValue
Deprecated. Contained value
ValueDataDescriptor - Interface in com.ibm.websphere.objectgrid.plugins.io.datadescriptor
ValueSerializerPlugin plug-ins create a ValueDataDescriptor using the DataDescriptorFactory to identify any attributes that it wants to expose to the eXtreme Scale runtime.
ValueDataSerializer - Interface in com.ibm.websphere.objectgrid.plugins.io
DataSerializers implement this interface to serialize and inflate value data objects and attributes.
ValueDataSerializer.Mergeable - Interface in com.ibm.websphere.objectgrid.plugins.io
ValueDataSerializers implement the optional Mergeable interface when it is possible that the clients or replicas in the grid may have multiple versions of the serializer.
ValueDataSerializer.Mergeable.MergeType - Enum in com.ibm.websphere.objectgrid.plugins.io
Used by the ValueDataSerializer.Mergeable.mergeDataObjects(DataObjectContext, XsDataInputStream, XsDataInputStream, XsDataOutputStream) method to indicate the form of the data object's merged result.
ValueDataSerializer.Versionable - Interface in com.ibm.websphere.objectgrid.plugins.io
ValueDataSerializers can implement the optional Versionable interface to allow high performance versioning when using in conjunction with the optimistic locking strategy.
ValueDataSerializer.Versionable.VersionType - Enum in com.ibm.websphere.objectgrid.plugins.io
The VersionType enumeration indicates the type of version information that the Versionable data serializer exports from the ValueDataSerializer.Versionable.getVersion(DataObjectContext, XsDataInputStream, XsDataOutputStream) method.
valueOf(byte) - Static method in class com.ibm.websphere.objectgrid.config.ConfigPropertyType
Given the raw value of a ConfigPropertyType, this method returns a ConfigPropertyType object, or null if the raw value does not match an existing type.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryNotificationEvent.Reason
Returns the enum constant of this type with the specified name.
valueOf(byte) - Static method in class com.ibm.websphere.objectgrid.deployment.ShardType
Given the raw value of a ShardType, this method returns a ShardType object, or null if the raw value does not match an existing type.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.LockMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.ObjectMap.PutMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.OutputFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.plugins.BackingMapLifecycleListener.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.plugins.io.datadescriptor.AttributeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.plugins.io.DataSerializer.SpecialValue
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer.Mergeable.MergeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer.Versionable.VersionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.plugins.ObjectGridLifecycleListener.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.query.ObjectQuery.ResultType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.objectgrid.Session.TxCommitProtocol
Returns the enum constant of this type with the specified name.
valueOf(byte) - Static method in class com.ibm.websphere.objectgrid.TTLType
Given the raw value of a TTLType, this method returns a TTLType object, or null if the raw value does not match an existing type.
valueOf(String) - Static method in enum com.ibm.websphere.projector.annotations.AccessType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.projector.annotations.CascadeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.websphere.projector.annotations.FetchType
Returns the enum constant of this type with the specified name.
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() - Static method in enum com.ibm.websphere.objectgrid.continuousquery.ContinuousQueryNotificationEvent.Reason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in interface com.ibm.websphere.objectgrid.JavaMap
This method of the java.util.Map interface is not supported.
values() - Static method in enum com.ibm.websphere.objectgrid.LockMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.ObjectMap.PutMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.OutputFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.plugins.BackingMapLifecycleListener.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.plugins.io.datadescriptor.AttributeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.plugins.io.DataSerializer.SpecialValue
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer.Mergeable.MergeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer.Versionable.VersionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.plugins.ObjectGridLifecycleListener.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.query.ObjectQuery.ResultType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.objectgrid.Session.TxCommitProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.projector.annotations.AccessType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.projector.annotations.CascadeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.websphere.projector.annotations.FetchType
Returns an array containing the constants of this enum type, in the order they are declared.
ValueSerializerPlugin - Interface in com.ibm.websphere.objectgrid.plugins.io
DataSerializer BackingMap plug-ins implement this interface to serialize and inflate value data objects and attributes.
verifyToken(byte[]) - Method in interface com.ibm.websphere.objectgrid.security.plugins.SecureTokenManager
Verifies the token and reconstruct the object.
version - Variable in class com.ibm.websphere.objectgrid.continuousquery.filter.AbstractCQFilter
Version of the filter implementation, which can be used internally for backward compatibility.
Version - Annotation Type in com.ibm.websphere.projector.annotations
Identifies a field or method as a version attribute.
versionEquals(DataObjectContext, XsDataInputStream, XsDataInputStream) - Method in interface com.ibm.websphere.objectgrid.plugins.io.ValueDataSerializer.Versionable
Answers true if the two serialized data objects equate to the same version.

W

waitFor() - Method in interface com.ibm.websphere.objectgrid.server.Server
Blocks until this server has been shutdown.
wasTransactionRolledBack() - Method in exception com.ibm.websphere.objectgrid.TransactionException
Returns true if the transaction was rolled back.
WebSpherePMAdapter - Interface in com.ibm.websphere.objectgrid.adapter
This interface is used by J2EE applications, in particular CMP 2.x applications.
WebSphereTransactionCallback - Class in com.ibm.websphere.objectgrid.plugins.builtins
Deprecated. This plug-in is deprecated in version 8.5. Use the eXtreme Scale Resource Adapter (wxsra.rar).
WebSphereTransactionCallback() - Constructor for class com.ibm.websphere.objectgrid.plugins.builtins.WebSphereTransactionCallback
Deprecated. The default constructor.
whenOccurred() - Method in exception com.ibm.websphere.objectgrid.TransactionTimeoutException
Gives the time when this TransactionTimeoutException was created.
WRITE - Static variable in class com.ibm.websphere.objectgrid.security.MapPermission
Write permission constant
WRITE_BEHIND_FAILED_UPDATES_MAP_PREFIX - Static variable in class com.ibm.websphere.objectgrid.writebehind.WriteBehindLoaderConstants
A write-behind update is pushed to the backend periodically within a different transaction from the one the update is made to ObjectGrid.
WriteBehindLoaderConstants - Class in com.ibm.websphere.objectgrid.writebehind
This class contains constants used for write behind loaders.
WriteBehindLoaderConstants() - Constructor for class com.ibm.websphere.objectgrid.writebehind.WriteBehindLoaderConstants
 
writeBoolean(boolean) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a single byte for the given boolean value.
writeByte(byte) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a single byte for the signed value of the given byte.
writeChar(char) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a 2-byte value for the given character in the current byte order.
writeChars(char[]) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes an array of 2-byte values for the given character in the current byte order.
writeDouble(double) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a 8-byte value for the given floating point number in the current byte order.
writeExternal(ObjectOutput) - Method in class com.ibm.websphere.objectgrid.TimeBasedDBUpdateConfig
 
writeExternal(ObjectOutput) - Method in class com.ibm.websphere.xsa.RestValue
Deprecated.  
writeFloat(float) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a 4-byte value for the given floating point number in the current byte order.
writeInt(int) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a 4-byte value for the given integral number in the current byte order.
writeLock() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Acquires write lock
writeLock() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
writeLock is for synchroning the update on the cache.
writeLong(long) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a 8-byte value for the given integral number in the current byte order.
writeSessionHandle(DataOutput, SessionHandle) - Static method in class com.ibm.websphere.objectgrid.SessionHandleTransformer
Writes the SessionHandle contents into the output stream.
writeShort(short) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a 2-byte value for the given integral number in the current byte order.
writeString(String) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes the given string as array of bytes encoded in current encoding scheme.
writeString(String, String) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes the given string as array of bytes encoded by given encoding scheme.
writeString(String, String, boolean, boolean) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes the given string as array of bytes encoded by the given encoding scheme.
writeStringAsNullTerminated(String) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes the given string as array of bytes encoded by current encoding scheme.
writeStringAsNullTerminated(String, String) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes the given string as array of bytes encoded by the given encoding scheme.
writeStringRaw(String) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes the given string as array of bytes encoded by the current encoding scheme.
writeStringRaw(String, String) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes the given string as array of bytes encoded by the given encoding scheme.
writeUnlock() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridDataCache
Releases writeLock, paired with writeLock() for update synchronization
writeUnlock() - Method in class com.ibm.websphere.objectgrid.openjpa.ObjectGridQueryCache
Releases writeLock, paired with writeLock() for update synchronization
writeUnsignedByte(int) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a single byte as the unsigned byte value (i.e.
writeUnsignedShort(int) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes 2-byte as the unsigned short value (i.e.
writeUTF8String(String) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes the given string as an array of bytes encoded as UTF-8.
writeVarint(int) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a variable length integer value for the given integral number.
writeVarint(long) - Method in class com.ibm.websphere.objectgrid.io.XsDataOutputStream
Writes a variable length integer value for the given integral number.
WSSubjectSourceImpl - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class is a implementation of the SubjectSource plugin interface for use when an ObjectGrid is accessed in a WebSphere Application Server.
WSSubjectSourceImpl() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.WSSubjectSourceImpl
Creates a new WSSubjectSourceImpl with the RunAs Subject type
WSSubjectSourceImpl(int) - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.WSSubjectSourceImpl
Creates a new WSSubjectSourceImpl with the specified Subject type
WSSubjectValidationImpl - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class is an implementation of the SubjectValidation interface in a WebSphere Application Server environment.
WSSubjectValidationImpl() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.WSSubjectValidationImpl
Creates a new WSSubjectValidationImpl
WSTokenAuthenticator - Class in com.ibm.websphere.objectgrid.security.plugins.builtins
This class represents a Authenticator when both ObjectGrid clients and ObjectGrid servers are launched in the WebSphere application server JVMs, and these application servers are in the same security domain.
WSTokenAuthenticator() - Constructor for class com.ibm.websphere.objectgrid.security.plugins.builtins.WSTokenAuthenticator
 
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.

X

XIO - Static variable in interface com.ibm.websphere.objectgrid.management.CatalogServiceManagementMBean
Constant representing the eXtremeIO transport
XIO_TRANSPORT - Static variable in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
The eXtremeIO or XIO transport
XSConnection - Class in com.ibm.websphere.xs.ra
An XSConnection represents an application level connection handle to an eXtreme Scale ObjectGrid.
XSConnection() - Constructor for class com.ibm.websphere.xs.ra.XSConnection
 
XSConnectionFactory - Class in com.ibm.websphere.xs.ra
The XSConnectionFactory creates connections to eXtreme Scale ObjectGrids.
XSConnectionFactory() - Constructor for class com.ibm.websphere.xs.ra.XSConnectionFactory
 
XSConnectionSpec - Class in com.ibm.websphere.xs.ra
The ConnectionSpec for retrieving XSConnections from an XSConnectionFactory
XSConnectionSpec() - Constructor for class com.ibm.websphere.xs.ra.XSConnectionSpec
Creates a default XSCOnnectionSpec instance.
XsDataInputStream - Class in com.ibm.websphere.objectgrid.io
A random access, byte-oriented, portable stream for reading primitive types and string.
XsDataInputStream() - Constructor for class com.ibm.websphere.objectgrid.io.XsDataInputStream
 
XsDataOutputStream - Class in com.ibm.websphere.objectgrid.io
An abstract extension of standard i/o stream for writing primitive types and string in random accessible, byte-oriented, cross-language manner specifically for internal usage of WebSphere eXtreme Scale plug-ins.
XsDataOutputStream() - Constructor for class com.ibm.websphere.objectgrid.io.XsDataOutputStream
 
XsDataStreamManager - Interface in com.ibm.websphere.objectgrid.io
The XsDataStreamManager is used to manage and create instances of XsDataInputStream and XsDataOutputStream objects.
XSManagedConnectionFactory - Class in com.ibm.websphere.xs.ra
The XSManagedConnectionFactory create managed connections to the eXtreme Scale ObjectGrids.
XSManagedConnectionFactory() - Constructor for class com.ibm.websphere.xs.ra.XSManagedConnectionFactory
 
XSResourceAdapter - Class in com.ibm.websphere.xs.ra
The eXtreme Scale resource adapter
XSResourceAdapter() - Constructor for class com.ibm.websphere.xs.ra.XSResourceAdapter
 

Z

ZoneConfigurationException - Exception in com.ibm.websphere.objectgrid
This exception is thrown when a container is started in an incompatible zone or when a problem has been detected with the zone configuration within the deployment policy.
ZoneConfigurationException() - Constructor for exception com.ibm.websphere.objectgrid.ZoneConfigurationException
Constructs a new ZoneConfigurationException with null as its detail message.
ZoneConfigurationException(String) - Constructor for exception com.ibm.websphere.objectgrid.ZoneConfigurationException
Constructs a new ZoneConfigurationException with the specified detail message.
ZoneConfigurationException(String, int) - Constructor for exception com.ibm.websphere.objectgrid.ZoneConfigurationException
Constructs a new ZoneConfigurationException with the specified detail message and error code.
ZoneConfigurationException(Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ZoneConfigurationException
Constructs a new ZoneConfigurationException with a specified cause.
ZoneConfigurationException(String, Throwable) - Constructor for exception com.ibm.websphere.objectgrid.ZoneConfigurationException
Constructs a new ZoneConfigurationException with the specified detail message and cause.
ZoneConfigurationException(String, Throwable, int) - Constructor for exception com.ibm.websphere.objectgrid.ZoneConfigurationException
Constructs a new ZoneConfigurationException with the specified detail message, cause, and error code.
ZoneRule - Interface in com.ibm.websphere.objectgrid.deployment
Defines placement rules with respect to zones.

A B C D E F G H I J K L M N O P Q R S T U V W X Z
IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

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