|
IBM WebSphere eXtreme ScaleTM, Release 6.1.0.5 ObjectGrid API Specification |
||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||
CountStatistic object which also provides
the count changes in the last period.TimeStatistic object which also provides
the number of time data being added in the last period.ObjectGridEventListener.
MapEventListener to this BackingMap.
MapIndexPlugin to this Map.
Plugin to this BackingMapConfiguration.
Plugin to this ObjectGridConfiguration.
StreamMetadata and add it to the StreamMetadata
list of this StreamQuerySet.
StreamQuerySet to this manager.
ViewMetadata and add it to the ViewMetadata
list of this StreamQuerySet.
MapGridAgent or ReduceGridAgent
instances to the ObjectGrid.BackingMap.
ClientCertificateCredential.
UserPasswordCredential.
UserPasswordCredential.
Subject object.
null as its detail
message.
null as its detail
message.
Loader or ObjectGrid server.
java.lang.Boolean on a plugin.
boolean on a plugin.
java.lang.Byte on a plugin.
byte on a plugin.
null as its detail
message.
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.
MapGridAgent.processAllEntries(com.ibm.websphere.objectgrid.Session, ObjectMap)
method on all ObjectGrid server partitions and returns each result key and value in a map.
null as its detail
message.
null as its detail
message.
Authenticator interface
when client certificate authentication is used.char on a plugin.
java.lang.Character on a plugin.
Principals represented by the specified
Subject has the specified MapPermission.
Principals represented by the specified
Subject has the specified Permission.
Type that represents the CLEAR operation.
ObjectGridManager.connect methods.ClientSecurityConfiguration
and SSLConfiguration objects.null as its detail
message.
null as its detail
message.
null as its detail
message.
null as its detail
message.
CLEAR.
DELETE.
EVICT.
FETCH.
TOUCH.
UNDO_BEFORE_IMAGE_KEYWORDS.
UNDO_NOT_NEEDED.
UPDATE.
Plugin.HostPortConnectionAttributes's.
null as its detail
message.
true if this map contains a mapping for the specified
key.
true if this map contains a mapping for the specified key.
java.util.Map interface is not supported.
ObjectMap.get is called for the
first time by a transaction for a given key.
setCopyMode method of the BackingMap interface is used.BackingMap.
BackingMap.
ObjectGrid.
List of a local, in-memory ObjectGrid instances
based upon the ObjectGrid configurations in the specified ObjectGrid descriptor XML file.
List of a local, in-memory ObjectGrid instances
based upon the ObjectGrid configurations in the specified ObjectGrid descriptor XML file.
StreamMetadata.
StreamQuerySet with all attributes set to null.
ViewMetadata.
setLockTimeout(int)
is not invoked.
setNumberOfBuckets(int)
is not invoked.
setNumberOfHeaps(int) method is not called.
setNumberOfLockBuckets(int)
is not invoked.
setNumberOfLRUQueues(int) method is not called.
setSleepTime(int) method is not called.
setSleepTime(int) method is not called.
Type that represents the DELETE operation.
null as its detail
message.
BackingMap associated with this evictor is
destroyed.
ObjectGrid associated with this listener is
destroyed.
ObjectGrid associated with this listener is
destroyed.
serialize() method on the LogSequenceTransformer interface is
used.null as its detail
message.
java.lang.Double on a plugin.
double on a plugin.
null as its detail
message.
null as its detail
message.
java.util.Map interface is not supported.
SimpleDeptPrincipal
for equality.
SimpleUserPrincipal
for equality.
Type that represents the EVICT operation.
Evictor chooses not to implement the
EvictorData interface, this method can be used to evict a
map entry.
EvictionEventCallback is passed into the
Evictor at initialization time.Evictor to use
when evicting map entries.
PluginType.EVICTOR can be used to attach an Evictor to a BackingMap.
BackingMap are evicted when the map is
full.Evictor interface.BackingMap.null as its detail
message.
Type that represents the FETCH operation.
null as its detail
message.
java.lang.Float on a plugin.
float on a plugin.
JavaMap
instance to the Loader without committing the changes.
ObjectMap instance to the Loader without
committing the changes.
Loader or ObjectGrid server.
retrieveStatsModule() method.
retrieveStatsModule() method.
getAll(List) method except that if pessimistic lock strategy
is used for this map, an upgradable lock mode is obtained for these map entries.
getAll(List) method except that if pessimistic lock strategy is used for this map, an
upgradable lock mode is obtained for these map entries.
BackingMap the index is associated with.
retrieveStatsModule() method.
CacheEntry for this key.
String representation of host:port tuples.
null if the
cause is nonexistent or unknown.
null if the
cause is nonexistent or unknown.
Session object directly retrieved from ObjectGrid can
not be used to drive transactions to a shard in
AvailabilityState.PRELOAD state.
Properties
object.
ConfigPropertyType of this object.
BackingMap.
CopyMode being used by this BackingMap.
retrieveStatsModule() or
refreshStatsModule() method.
UserPasswordCredential object using this
object's user name and password.
WSTokenCredential object using this
object's using the security information from the Subject
associated with the current thread.
Credential which represents the client.
CredentialGenerator object for this client
security configuration.
CredentialGenerator implementation class name set
in the client security property file.
CredentialGenerator properties set in the client security
property file.
LogElement.
GENERIC if one of the other
constructors was called.
ObjectGridEventListeners.
Evictor being used by this BackingMap.
UNKNOWN if one of the other
constructors was called.
retrieveStatsModule() method.
retrieveStatsModule() method.
retrieveStatsModule() method.
retrieveStatsModule() method.
retrieveStatsModule() method.
retrieveStatsModule() method.
get(Object) method except that if pessimistic lock strategy
is used for this map, an upgradable lock mode is obtained for this map entry.
get(Object) method except that if pessimistic lock strategy is used for this map, an
upgradable lock mode is obtained for this map entry.
retrieveStatsModule() method.
java.util.Map that is backed by this ObjectMap.
EvictorData instance.
LogElement.
BackingMap.
LockStrategy object being used by this BackingMap.
BackingMap.
ManagementGateway.
defineMap(String) or setMaps(List) method.
ObjectMap the index is associated with.
retrieveStatsModule() or
refreshStatsModule() method.
retrieveStatsModule() or
refreshStatsModule() method.
retrieveStatsModule() or
refreshStatsModule() method.
retrieveStatsModule() or
refreshStatsModule() method.
retrieveStatsModule() or
refreshStatsModule() method.
MapEventListeners.
retrieveStatsModule() or
refreshStatsModule() method.
MapIndexPlugin objects for this BackingMap.
MapStatsModule attributes
loaded up by the retrieveStatsModule() or
refreshStatsModule() method.
- getMapType() -
Method in interface com.ibm.websphere.objectgrid.BackingMap
- Returns the type of BackingMap.
- getMapType() -
Method in interface com.ibm.websphere.objectgrid.ObjectMap
- Returns the type of the underlying BackingMap.
- 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.
- getMaxMemory() -
Method in interface com.ibm.websphere.objectgrid.management.DynamicServerMBean
-
- 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
- getMaxRequestTime() -
Method in interface com.ibm.websphere.objectgrid.management.StaticServerMBean
- Gets the maximum request time attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- 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
- getMeanRequestTime() -
Method in interface com.ibm.websphere.objectgrid.management.StaticServerMBean
- Gets the mean request time attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- 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.
- getMetadataClass() -
Method in interface com.ibm.websphere.projector.md.EntityMetadata
- Retrieve the entity class 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.
- getMinRequestTime() -
Method in interface com.ibm.websphere.objectgrid.management.StaticServerMBean
- Gets the minimum request time attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- 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.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.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 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 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.objectgrid.streamquery.StreamQueryMetadata
- return the name of the stream or view
- getName() -
Method in interface com.ibm.websphere.objectgrid.streamquery.StreamQuerySet
-
- 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
- getNewKeywords() -
Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
- Returns any new keywords that have been associated with this entry as a result
of this transaction.
- 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.
- 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
- Gets the number of buckets defined for this
BackingMap.
- getNumberOfBuckets() -
Method in interface com.ibm.websphere.objectgrid.config.BackingMapConfiguration
- Gets the number of buckets defined for this BackingMapConfiguration.
- getNumberOfHeaps() -
Method in class com.ibm.websphere.objectgrid.plugins.builtins.LFUEvictor
- Gets number of binary heaps being used.
- getNumberOfLockBuckets() -
Method in interface com.ibm.websphere.objectgrid.BackingMap
- Gets the number of lock buckets defined for the hash map used by lock
manager for this backing map.
- getNumberOfLRUQueues() -
Method in class com.ibm.websphere.objectgrid.plugins.builtins.LRUEvictor
- Gets number of LRU queues being used.
- 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
- 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.
- 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() -
Method in interface com.ibm.websphere.objectgrid.Session
- Returns the ObjectGrid that owns this session.
- getObjectGridAdministrator(ClientClusterContext) -
Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
- Return an
ObjectGridAdministrator instance for the specified static
deployment ClientClusterContext.
- 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 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.objectgrid.streamquery.StreamQueryMetadata
- return the ObjectGrid name of the map that contains the data for this view or stream
- getObjectGridNames() -
Method in interface com.ibm.websphere.objectgrid.management.PlacementServiceMBean
- Gets the names of all ObjectGrids and their mapsets in the domain.
- getObjectGrids() -
Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
- Gets a
List of the local, in-memory ObjectGrid instances that have been previously cached.
- getObjectGridState(ObjectGrid) -
Method in interface com.ibm.websphere.objectgrid.StateManager
- Get the AvailabilityState of an ObjectGrid.
- getObjectGridType() -
Method in interface com.ibm.websphere.objectgrid.ObjectGrid
- Returns the type of ObjectGrid.
- 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.
- getObjectTransformer() -
Method in interface com.ibm.websphere.objectgrid.BackingMap
- Gets the
ObjectTransformer object being used by this
BackingMap and/or Loader.
- getOGCount() -
Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
- Gets the ObjectGrid count attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- getOGMaxTranTime() -
Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
- Gets the maximum transaction time attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- getOGMeanTranTime() -
Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
- Gets the mean transaction time attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- getOGMinTranTime() -
Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
- Gets the minimum transaction time attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- getOGStatsModule() -
Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
- Gets a string representation of the
OGStatsModule attributes
loaded up by the retrieveStatsModule() or
refreshStatsModule() method.
- getOGTotalTranTime() -
Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
- Gets the total transaction time attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- getOGTransPerSecond() -
Method in interface com.ibm.websphere.objectgrid.management.ObjectGridMBean
- Transactions per second attribute loaded up by the retrieveStatsModule call.
- getOptimisticCallback() -
Method in interface com.ibm.websphere.objectgrid.BackingMap
- Gets the
OptimisticCallback being used by this BackingMap
and/or Loader or null if the LockStrategy is not optimistic.
- 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:
- getOverrideObjectGridConfigurations() -
Method in interface com.ibm.websphere.objectgrid.ObjectGridManager
- Get the Map that is used to override client side ObjectGrid and BackingMap plugins.
- 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.
- 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
-
- 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.
- getPartitions() -
Method in interface com.ibm.websphere.objectgrid.streamquery.StreamQuerySet
-
- 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.
- 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
- 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
-
- 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.
- getPort() -
Method in interface com.ibm.websphere.objectgrid.gateway.ManagementGateway
- Gets the connect port used by the gateway process to connect to the
ObjectGrid cluster.
- getPreferZones() -
Method in interface com.ibm.websphere.objectgrid.client.ClientProperties
- Retrieve the preferred zones.
- getPreloadBatchSize() -
Method in class com.ibm.websphere.objectgrid.hibernate.cache.ObjectGridHibernateCacheProvider
- Return the batch size of the preload process.
- 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
-
- getPrimary() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the primary server loaded up by the
retrieveReplicationGroupStatus() call.
- 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.
- 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
- Gets the propagate mode.
- getPropagateService() -
Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
- Gets the propagate service
- getPropagateVersionOption() -
Method in class com.ibm.websphere.objectgrid.plugins.builtins.TranPropListener
- Gets the propagate version option.
- getProperties() -
Method in class com.ibm.websphere.objectgrid.plugins.index.HashIndex
-
- 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.
- getPuName() -
Method in class com.ibm.websphere.objectgrid.hibernate.cache.ObjectGridHibernateCacheProvider
- Return the persistence unit name of the corresponding persistence unit.
- 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.
- getQuorumActivationStatus() -
Method in interface com.ibm.websphere.objectgrid.management.CoreGroupServiceMBean
- Retrieve the catalog server's current quorum activation status.
- getReadOnly() -
Method in interface com.ibm.websphere.objectgrid.BackingMap
- Retrieves the map type.
- getReduceTime(String) -
Method in interface com.ibm.websphere.objectgrid.management.AgentManagerMBean
- Gets the specified agent's total reduce time attribute loaded up by the
retrieveStatsModule() method.
- getReduceTime(boolean) -
Method in interface com.ibm.websphere.objectgrid.stats.AgentStatsModule
- Gets the reduce time statistic.
- getRefreshInterval() -
Method in interface com.ibm.websphere.objectgrid.gateway.ManagementGateway
- Gets the amount of time in seconds between when MBean.
- 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.
- getReplica1() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the first replica server loaded up by the
retrieveReplicationGroupStatus() call.
- getReplica10() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the tenth replica server loaded up by the
retrieveReplicationGroupStatus() call.
- getReplica2() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the second replica server loaded up by the
retrieveReplicationGroupStatus() call.
- getReplica3() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the third replica server loaded up by the
retrieveReplicationGroupStatus() call.
- getReplica4() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the fourth replica server loaded up by the
retrieveReplicationGroupStatus() call.
- getReplica5() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the fifth replica server loaded up by the
retrieveReplicationGroupStatus() call.
- getReplica6() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the sixth replica server loaded up by the
retrieveReplicationGroupStatus() call.
- getReplica7() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the seventh replica server loaded up by the
retrieveReplicationGroupStatus() call.
- getReplica8() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the eighth replica server loaded up by the
retrieveReplicationGroupStatus() call.
- getReplica9() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the ninth replica server loaded up by the
retrieveReplicationGroupStatus() call.
- 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
- getReplicas() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the names of all of the replicas loaded up by the
retrieveReplicationGroupStatus() call.
- getReplicationGroup() -
Method in exception com.ibm.websphere.objectgrid.DominoTransactionException
- Returns the replication group identifier for this exception.
- getReplicationGroup() -
Method in exception com.ibm.websphere.objectgrid.DominoWriteException
- Returns the replication group identifier for this exception.
- getReplicationGroup() -
Method in interface com.ibm.websphere.objectgrid.management.StaticMapMBean
- Gets the name of the replication group for the map associated with this
MBean.
- getReplicationGroup() -
Method in interface com.ibm.websphere.objectgrid.management.StaticObjectGridMBean
- Gets the name of the replication group for the ObjectGrid associated with
this MBean.
- getReplicationGroup() -
Method in interface com.ibm.websphere.objectgrid.management.StaticServerMBean
- Gets the name of the replication group for the server associated with this
MBean.
- getReplicationGroup() -
Method in exception com.ibm.websphere.objectgrid.ObjectGridRPCException
- 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.
- getReplicationGroupMemberState() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMemberMBean
- Gets the replica weight ratio loaded up by the
retrieveStatsModule() or
refreshReplicationGroupMemberStatus() method.
- getReplicationGroupMemberState(boolean) -
Method in interface com.ibm.websphere.objectgrid.stats.ReplicationStatsModule
- Determines the state of a given REPLICA.
- getReplicationGroupMemberType() -
Method in interface com.ibm.websphere.objectgrid.stats.ReplicationStatsModule
- Determines what type of replication group member is represented by this
ReplicationStatsModule.
- getReplicationGroupName() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMBean
- Gets the name of the replication group associated with this MBean
- getReplicationGroupName() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMemberMBean
- Gets the name of the replication group containing the replication
group member associated with this MBean.
- getReplicationGroupStatus(String) -
Method in interface com.ibm.websphere.objectgrid.ObjectGridAdministrator
- Returns an array showing which servers are the primary and replicas.
- getReplicationMode() -
Method in interface com.ibm.websphere.objectgrid.ClientReplicableMap
- Returns the current replication mode
- getRequestCount() -
Method in interface com.ibm.websphere.objectgrid.management.StaticServerMBean
- Gets the request count attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- getRequestProcessTime(String, boolean) -
Method in interface com.ibm.websphere.objectgrid.stats.ServerStatsModule
- Gets the client request process time statistic for the specified type of
requests.
- getRequestsPerSecond() -
Method in interface com.ibm.websphere.objectgrid.management.StaticServerMBean
- Requests per second attribute loaded up by the retrieveStatsModule call.
- 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.
- 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.
- 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.ReplicationGroupMemberMBean
- Gets the name of the server containing the replication group member
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.
- getServerSecurityFileName() -
Method in interface com.ibm.websphere.objectgrid.server.CatalogServerProperties
- Retrieves the server security file name.
- getServerStatsModule() -
Method in interface com.ibm.websphere.objectgrid.management.StaticServerMBean
- Gets a string representation of the
ServerStatsModule attributes
loaded up by the retrieveStatsModule() or
refreshStatsModule() method.
- getServerStatus(String) -
Method in interface com.ibm.websphere.objectgrid.ObjectGridAdministrator
- Returns the status of server for a specific server in the ObjectGrid
cluster that this object is associated with.
- getSession() -
Method in interface com.ibm.websphere.objectgrid.ObjectGrid
- Gets a Session object that can be used by a single thread at a time.
- getSession(Subject) -
Method in interface com.ibm.websphere.objectgrid.ObjectGrid
- Allows the use of a specific
Subject rather than use the
SubjectSource configured on the ObjectGrid to get a Session.
- getSession(CredentialGenerator) -
Method in interface com.ibm.websphere.objectgrid.ObjectGrid
- Get a session using a
CredentialGenerator.
- getSession() -
Method in interface com.ibm.websphere.objectgrid.spring.SpringLocalTxManager
- This returns a managed session for the ObjectGrid associated with this thread.
- getSession() -
Method in interface com.ibm.websphere.objectgrid.TxID
- Returns the Session that owns this TxID.
- getSessionHandle() -
Method in interface com.ibm.websphere.objectgrid.Session
- Retrieves a handle for this session.
- getSessionID() -
Method in interface com.ibm.websphere.objectgrid.management.SessionMBean
- Gets the ID of the session instance associated
with this MBean.
- 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
- getSql() -
Method in interface com.ibm.websphere.objectgrid.streamquery.StreamQueryMetadata
-
- 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.
- getSSLEnabled() -
Method in interface com.ibm.websphere.objectgrid.gateway.ManagementGateway
- Gets whether SSL is enabled on the gateway.
- 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.management.ShardMBean
- Retrieve the state of the shard.
- getStateManager() -
Static method in class com.ibm.websphere.objectgrid.StateManagerFactory
- Returns the
StateManager singleton.
- getStatisticsType() -
Method in interface com.ibm.websphere.objectgrid.management.StaticServerMBean
- Gets the type of the server statistics associated with this MBean.
- 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.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.
- getStatus() -
Method in interface com.ibm.websphere.objectgrid.management.ReplicationGroupMemberMBean
- Gets the status loaded up by the
refreshReplicationGroupMemberStatus() method.
- getStreamMetadatas() -
Method in interface com.ibm.websphere.objectgrid.streamquery.StreamQuerySet
- Returns the current list of
StreamMetadatas.
- getStreamQuerySets() -
Method in interface com.ibm.websphere.objectgrid.streamquery.StreamQueryManager
- Returns the current list of
StreamQuerySets.
- 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.
- 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
- 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
-
- 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.
- getTotalRequestTime() -
Method in interface com.ibm.websphere.objectgrid.management.StaticServerMBean
- Gets the total request time attribute loaded up by the
retrieveStatsModule() or
refreshStatsModule() method.
- getTotalTime() -
Method in interface com.ibm.websphere.objectgrid.stats.TimeStatistic
- Gets the total time since the beginning of the measurement.
- getTraceEnabled() -
Method in interface com.ibm.websphere.objectgrid.gateway.ManagementGateway
- Gets whether ObjectGrid trace is enabled on the gateway process.
- getTraceFile() -
Method in interface com.ibm.websphere.objectgrid.gateway.ManagementGateway
- Gets the file name where trace data is written on the gateway process.
- 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.gateway.ManagementGateway
- Gets the trace specification on the gateway process.
- 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(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.
- 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.
- getTransactionTime(String, boolean) -
Method in interface com.ibm.websphere.objectgrid.stats.OGStatsModule
- Gets the transaction response time statistic for a specified 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.management.StaticObjectGridMBean
- Gets the type of transaction for the ObjectGrid associated with
this MBean.
- 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.
- 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.
- getTxTimeout() -
Method in interface com.ibm.websphere.objectgrid.ObjectGrid
- Gets transaction timeout setting for this ObjectGrid instance.
- getType() -
Method in interface com.ibm.websphere.objectgrid.management.ShardMBean
- Retrieve the type of the shard.
- getType() -
Method in interface com.ibm.websphere.objectgrid.plugins.LogElement
- Gets the type of this
LogElement.
- getType() -
Method in class com.ibm.websphere.objectgrid.security.plugins.builtins.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
- getTypeNames() -
Method in class com.ibm.websphere.objectgrid.hibernate.cache.ObjectGridHibernateCacheProvider
- Return the collection of type names used to create BackingMaps of the ObjectGrid.
- 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.
- 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.
- getValueAttributeMapping() -
Method in interface com.ibm.websphere.objectgrid.streamquery.StreamQueryMetadata
- Return the map which stores the mapping between SQL columns and value class field
or accessor method.
- getValueClass() -
Method in class com.ibm.websphere.objectgrid.config.QueryMapping
- Retrieve the type of object that is stored in the BackingMap.
- getValueClass() -
Method in interface com.ibm.websphere.objectgrid.streamquery.StreamQueryMetadata
- Return the class type of the value stored in the ObjectMap.
- getValueMetadata() -
Method in interface com.ibm.websphere.projector.md.EntityMetadata
- The TupleMetadata for the entity's value.
- 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
-
- getVersionedObjectForValue(Object) -
Method in interface com.ibm.websphere.objectgrid.plugins.OptimisticCallback
- 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.
- getViewMap(String) -
Method in interface com.ibm.websphere.objectgrid.Session
- Get an ObjectMap for the stream query view result map.
- getViewMetadatas() -
Method in interface com.ibm.websphere.objectgrid.streamquery.StreamQuerySet
- Returns the current list of
ViewMetadatas.
- 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.
- 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.
SimpleDeptPrincipal.
SimpleUserPrincipal.
MapIndexPlugin.HostPortConnectionAttributes object represents a host name and port number
pairing.null as its detail
message.
null as its detail
message.
null as its detail
message.
null as its detail
message.
readObject.
initalize() methods will call this method at the appropriate
time.
BackingMap instance during the evictor
initialization time.
ObjectGrid is initialized.
ObjectGrid is initialized.
ObjectGrid is initialized.
LoginModule.
Type that represents the INSERT operation.
int
on a plugin.
java.lang.Integer on a plugin.
INVALIDATE distribution
mode except that it also takes into account the versioned value data associated
with each entry.
null as its detail
message.
null as its detail
message.
commit() operation.
java.util.Map interface is not supported.
true if a WebSphere JTA transaction is active.
flush() operation.
BackingMap
markRollbackOnly(Throwable) method on this Session.
true if the transaction is active.
Loader or
ObjectGrid server(true), or if the changes are only applying to the BackingMap (false)
or client respectively.
MapAuthorization
plugin interface where JAAS is used for authorization.ObjectGridEventListener.JPATxCallback object.null as its detail
message.
java.util.Map interface is not supported.
Authenticator interface
when a user name and password are used as a credential.Authenticator interface
when a user name and password are used as a credential, and the authentication
is against an LDAP server.input into this property object.
input into this property object.
Loader.Loader.null as its detail
message.
null as its detail
message.
null as its detail
message.
null as its detail
message.
null as its detail
message.
BackingMap.setLockStrategy(LockStrategy) method.null as its detail
message.
Type class is used to represent a LogElement
type.LogSequences.java.lang.Long on a plugin.
ManagementGateway
to start the gateway process using API calls.PluginType.MAP_EVENT_LISTENER can be used to attach a MapEventListener
to a BackingMap.
ObjectGrid, ObjectMap, and JavaMap accesses.null as its detail
message.
Query.getSingleResult() is invoked and
there is more than one result from the query.ObjectQuery.getSingleResult() is invoked and there
is more than one result from the query.null as its detail
message.
Query.getSingleResult() is invoked and
there is no result to return.ObjectQuery.getSingleResult() is invoked and there
is no result to return.null as its detail
message.
BackingMap.setOptimisticCallback(OptimisticCallback)
method was never called.
PluginType.OBJECTGRID_EVENT_LISTENER can be used to attach an ObjectGridEventListener
plugin to an ObjectGrid
ObjectGrid, ObjectMap and
JavaMap accesses to the Principals represented
by a Subject object.DataCache implementation is a
DataCache plugin to integrate Open JPA with ObjectGrid for leveraging
the cluster server advantages provided by ObjectGrid.null as its detail
message.
ObjectGridManager instances.QueryCache implementation is a
QueryCache plugin to integrate OpenJPA with ObjectGrid for leveraging the
cluster server advantages provided by ObjectGrid.null as its detail
message.
null as its detail
message.
null as its detail
message.
null as its detail
message.
LogSequence based on the partitioning
algorithm for the Map.
null as its detail
message.
null as its detail
message.
Plugin has a PluginType.ClientLoader.load(ObjectGrid, String, String, Map, Class, String, Map, boolean, ClientLoadCallback)
method.
Loader to preload the data into the map.
LogSequence.
null as its detail
message.
PUSH distribution
mode except that it also takes into account the versioned value data associated
with each entry.
QueryMapping.PROPERTY_ACCESS.
ObjectMap.getNextKey(long) method, specifies the method should block until a key
becomes available.
ObjectMap.getNextKey(long) method, specifies to return a null value if the map is
empty.
null as its detail
message.
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.
BackingMap.
ObjectGridEventListener.
MapEventListener from this BackingMap.
StreamQuerySet.
null as its detail
message.
AgentStatsModule used to retrieve statistics
associated with the specified agent class
HashIndexStatsModule used to retrieve statistics
associated with this index
MapStatsModule used to retrieve statistics
associated with the map for this MBean.
OGStatsModule used to retrieve statistics
associated with the ObjectGrid for this MBean.
QueryStatsModule used to retrieve statistics
associated with the specified query String
ReplicationStatsModule used to retrieve statistics
associated with the replication group member for this MBean.
SessionStatsModule used to retrieve statistics
associated with the session for this MBean.
ServerStatsModule used to retrieve statistics
associated with the server for this MBean.
StatsModule.
EntityTransaction.commit() fails.writeObject.
ObjectMaps.isCatalog is true.
String which represents the endpoints for all available catalog services
ConfigPropertyType for this object.
CopyMode.
CredentialGenerator object for this client
security configuration.
StreamQuerySet.
ObjectGridEventListeners
and replaces it with the supplied List of ObjectGridEventListeners.
Evictor with this BackingMap.
Loader with this BackingMap.
LockStrategy.
BackingMap.
setObjectGridAuthorization(ObjectGridAuthoirzation) instead
to plug in custom authorizations.
If both setMapAuthorization(MapAuthorization) and setObjectGridAuthorization(ObjectGridAuthoirzation)
are used, ObjectGrid will use the provided MapAuthorization to authorize map accesses,
even though this method is deprecated.
MapEventListener objects.
MapIndexPlugin objects for this BackingMap.
BackingMaps that have been previously defined
on this ObjectGrid and replaces them with the List of BackingMaps provided.
BackingMap supports null values.
BackingMap.
BackingMap.
ObjectGridAuthorization for this ObjectGrid instance.
BackingMap and/or
Loader.
OptimisticCallback.
List of ObjectGridConfiguration objects to be
overridden.
PluginType for this Plugin.
Loader is set for this BackingMap.
MapRangeIndex or a MapIndex.
BackingMap.
SSLConfiguration object associated with this client
security configuration.
StreamMetadatas
and replaces it with the supplied List of StreamMetadatas.
StreamQuerySets
and replaces it with the supplied List of StreamQuerySets.
SubjectSource plugin.
SubjectValidation for this ObjectGrid instance.
System.out.
BackingMap entry is computed.
RUN_AS_SUBJECT or
CALLER_SUBJECT
RUN_AS_SUBJECT or
CALLER_SUBJECT.
ViewMetadatas
and replaces it with the supplied List of ViewMetadatas.
java.lang.Short on a plugin.
short on a plugin.
Principal interface
and represents a simple user.Principal interface
and represents a simple user.java.util.Map interface is not supported.
StateManager instance.StatsAccessor objects.NONE statistic
specification
output.
output.
null as its detail message.
java.lang.String on a plugin.
Subject which represents
an ObjectGrid client.Subject
passed to the ObjectGrid is a valid Subject which has not been
tampered with.MapAuthorization
plugin interface where TAM is used for both authentication and authorization.null as its detail
message.
QueryQueue.getNextEntity(long) or QueryQueue.getNextEntity(long) method.
QueryQueue.getNextEntity(long) or QueryQueue.getNextEntity(long) method.
CopyMode.
ShardType.
LockStrategy.
DistributionMode.
SimpleDeptPrincipal.
SimpleUserPrincipal.
AssociationType.
TTLType.
AccessType.
AssociationType.
FetchType.
Type that represents the TOUCH operation.
ObjectGridEventListener interface
allows users to propagate successful ObjectGrid transaction commits to other
WebSphere Application Servers hosting the same ObjectGrid instance (based
upon the ObjectGrid name).PluginType.TRANSACTION_CALLBACK can be used to attach a TransactionCallback plugin
to an ObjectGrid.
setTransactionTimeout(int) method.
null as its detail
message.
null as its detail
message.
Session transaction.
Session transaction.
Session will send corresponding events
to the TransactionCallback.null as its detail
message.
Session transaction.
Session transaction.
null as its detail
message.
ObjectGrid or Session.null as its detail
message.
null as its detail
message.
Type that represents the UNDO action to remove new
keyword associations that were introduced in this LogElement.
Type that represents an UNDO action is NOT required for
this LogElement.
doBatchUpdate(TxID, LogSequence)
method.
Type that represents the UPDATE operation.
UserPasswordCredential objects.java.util.Map interface is not supported.
true if the transaction was rolled back.
SubjectSource plugin
interface for use when an ObjectGrid is accessed in a WebSphere
Application Server.SubjectValidation
interface in a WebSphere Application Server environment.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.null as its detail
message.
|
IBM WebSphere eXtreme ScaleTM, Release 6.1.0.5 ObjectGrid API Specification |
||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||