Uses of Annotation Interface
com.tangosol.net.management.annotation.Description

Packages that use Description

Package	Description
com.oracle.coherence.concurrent.executor.management	MBeans for Coherence Concurrent executors.
com.oracle.coherence.grpc.proxy.common
com.tangosol.io.journal	Contains classes related to the journaling services.
com.tangosol.net.management	Contains classes related to the Coherence Management Framework.
com.tangosol.net.partition	Contains interfaces and classes related to partitioned services.
com.tangosol.persistence	Contains classes and helpers for implementing various types of persistence.
com.tangosol.util	Contains various generic utilities.

Uses of Description in com.oracle.coherence.concurrent.executor.management

Classes in com.oracle.coherence.concurrent.executor.management with annotations of type Description

Modifier and Type	Interface	Description
interface	ExecutorMBean	ExecutorMBean provides a monitor interface for the Executor statistics.

Methods in com.oracle.coherence.concurrent.executor.management with annotations of type Description

Modifier and Type	Method	Description
String	ExecutorMBean.getDescription()	Return the description of the registered ExecutorService.
String	ExecutorMBean.getId()	Return the unique ID of the registered ExecutorService.
String	ExecutorMBean.getLocation()	Get the location where the executor is running.
String	ExecutorMBean.getMemberId()	Get the member id where the executor is running.
String	ExecutorMBean.getName()	Return the logical name of the registered ExecutorService.
String	ExecutorMBean.getState()	Get the state of the executor.
int	ExecutorMBean.getStateCode()	Get the state of the executor as an integer.
long	ExecutorMBean.getTasksCompletedCount()	Get the completed tasks count for the executor.
long	ExecutorMBean.getTasksInProgressCount()	Get the in progress tasks count for the executor.
long	ExecutorMBean.getTasksRejectedCount()	Get the number of tasks rejected by the executor.
boolean	ExecutorMBean.isTraceLogging()	Return a boolean to indicate whether the executor trace logging is enabled (true) or not (false).
void	ExecutorMBean.resetStatistics()	Reset the statistics.
void	ExecutorMBean.setTraceLogging(boolean fTrace)	Set the trace to true to enable executor trace logging; false to disable executor trace logging.

Uses of Description in com.oracle.coherence.grpc.proxy.common

Methods in com.oracle.coherence.grpc.proxy.common with annotations of type Description

Modifier and Type	Method	Description
int	GrpcProxyMetricsMBean.getAbandonedThreadCount()	Return the total number of abandoned Daemon threads.
String	GrpcConnectionMetrics.ConnectionMetricsMBean.getAddress()	Returns the remote address of the connection.
int	GrpcProxyMetricsMBean.getDaemonCount()	Return the number of Daemon threads that exist, if the pool has been started, or the number of Daemon threads that will be created, if the pool has not yet been started.
int	GrpcProxyMetricsMBean.getDaemonCountMax()	Returns the maximum number of daemon threads that the pool can create.
int	GrpcProxyMetricsMBean.getDaemonCountMin()	Returns the minimum number of daemon threads that the pool should have.
long	GrpcProxyMetricsMBean.getErrorRequestCount()	Return the count of requests that responded with an error.
double	GrpcProxyMetricsMBean.getErrorRequestFifteenMinuteRate()	Return the fifteen minute rate of requests that responded with an error.
double	GrpcProxyMetricsMBean.getErrorRequestFiveMinuteRate()	Return the five minute rate of requests that responded with an error.
double	GrpcProxyMetricsMBean.getErrorRequestMeanRate()	Return the mean rate of requests that responded with an error.
double	GrpcProxyMetricsMBean.getErrorRequestOneMinuteRate()	Return the one minute rate of requests that responded with an error.
int	GrpcProxyMetricsMBean.getHungTaskCount()	Return the total number of currently executing hung tasks.
long	GrpcProxyMetricsMBean.getHungTaskDuration()	Return the longest currently executing hung task duration (in milliseconds).
long	GrpcProxyMetricsMBean.getLastResetMillis()	Return the last time stats were reset.
long	GrpcProxyMetricsMBean.getLastResizeMillis()	Return the last time the daemon pool was resized.
int	GrpcProxyMetricsMBean.getMaxTaskBacklog()	Return the maximum backlog value since the last time the statistics were reset.
double	GrpcProxyMetricsMBean.getMessageDuration75thPercentile()	Return the 75th percentile value from the distribution of samples in the latest snapshot of the message duration metric.
double	GrpcProxyMetricsMBean.getMessageDuration95thPercentile()	Return the 95th percentile value from the distribution of samples in the latest snapshot of the message duration metric.
double	GrpcProxyMetricsMBean.getMessageDuration98thPercentile()	Return the 98th percentile value from the distribution of samples in the latest snapshot of the message duration metric.
double	GrpcProxyMetricsMBean.getMessageDuration999thPercentile()	Return the 99.9th percentile value from the distribution of samples in the latest snapshot of the message duration metric.
double	GrpcProxyMetricsMBean.getMessageDuration99thPercentile()	Return the 99th percentile value from the distribution of samples in the latest snapshot of the message duration metric.
double	GrpcProxyMetricsMBean.getMessageDurationMax()	Return the maximum value from the distribution of samples in the latest snapshot of the message duration metric.
double	GrpcProxyMetricsMBean.getMessageDurationMean()	Return the mean value from the distribution of samples in the latest snapshot of the message duration metric.
double	GrpcProxyMetricsMBean.getMessageDurationMin()	Return the minimum value from the distribution of samples in the latest snapshot of the message duration metric.
double	GrpcProxyMetricsMBean.getMessageDurationStdDev()	Return the standard deviation from the distribution of samples in the latest snapshot of the message duration metric.
long	GrpcProxyMetricsMBean.getMessagesReceivedCount()	Return the count of messages received.
double	GrpcProxyMetricsMBean.getMessagesReceivedFifteenMinuteRate()	Return the fifteen minute rate of messages received.
double	GrpcProxyMetricsMBean.getMessagesReceivedFiveMinuteRate()	Return the five minute rate of messages received.
double	GrpcProxyMetricsMBean.getMessagesReceivedMeanRate()	Return the mean rate of messages received.
double	GrpcProxyMetricsMBean.getMessagesReceivedOneMinuteRate()	Return the one minute rate of messages received.
long	GrpcConnectionMetrics.ConnectionMetricsMBean.getRequestCount()	Returns the number of requests made by this connection.
double	GrpcConnectionMetrics.ConnectionMetricsMBean.getRequestCountFifteenMinuteRate()	Returns the fifteen minute rate of requests made by this connection.
double	GrpcConnectionMetrics.ConnectionMetricsMBean.getRequestCountFiveMinuteRate()	Returns the five minute rate of requests made by this connection.
double	GrpcConnectionMetrics.ConnectionMetricsMBean.getRequestCountMeanRate()	Returns the mean rate of requests made by this connection.
double	GrpcConnectionMetrics.ConnectionMetricsMBean.getRequestCountOneMinuteRate()	Returns the one minute rate of requests made by this connection.
double	GrpcProxyMetricsMBean.getRequestDuration75thPercentile()	Return the 75th percentile value from the distribution of samples in the latest snapshot of the request duration metric.
double	GrpcProxyMetricsMBean.getRequestDuration95thPercentile()	Return the 95th percentile value from the distribution of samples in the latest snapshot of the request duration metric.
double	GrpcProxyMetricsMBean.getRequestDuration98thPercentile()	Return the 98th percentile value from the distribution of samples in the latest snapshot of the request duration metric.
double	GrpcProxyMetricsMBean.getRequestDuration999thPercentile()	Return the 99.9th percentile value from the distribution of samples in the latest snapshot of the request duration metric.
double	GrpcProxyMetricsMBean.getRequestDuration99thPercentile()	Return the 99th percentile value from the distribution of samples in the latest snapshot of the request duration metric.
double	GrpcProxyMetricsMBean.getRequestDurationMax()	Return the maximum value from the distribution of samples in the latest snapshot of the request duration metric.
double	GrpcProxyMetricsMBean.getRequestDurationMean()	Return the mean value from the distribution of samples in the latest snapshot of the request duration metric.
double	GrpcProxyMetricsMBean.getRequestDurationMin()	Return the minimum value from the distribution of samples in the latest snapshot of the request duration metric.
double	GrpcProxyMetricsMBean.getRequestDurationStdDev()	Return the standard deviation from the distribution of samples in the latest snapshot of the request duration metric.
long	GrpcProxyMetricsMBean.getResponsesSentCount()	Return the count of responses sent.
double	GrpcProxyMetricsMBean.getResponsesSentFifteenMinuteRate()	Return the fifteen minute rate of responses sent.
double	GrpcProxyMetricsMBean.getResponsesSentFiveMinuteRate()	Return the five minute rate of responses sent.
double	GrpcProxyMetricsMBean.getResponsesSentMeanRate()	Return the mean rate of responses sent.
double	GrpcProxyMetricsMBean.getResponsesSentOneMinuteRate()	Return the one minute rate of responses sent.
long	GrpcProxyMetricsMBean.getSuccessfulRequestCount()	Return the count of requests that responded with success.
double	GrpcProxyMetricsMBean.getSuccessfulRequestFifteenMinuteRate()	Return the fifteen minute rate of successful requests.
double	GrpcProxyMetricsMBean.getSuccessfulRequestFiveMinuteRate()	Return the five minute rate of successful requests.
double	GrpcProxyMetricsMBean.getSuccessfulRequestMeanRate()	Return the one minute rate of successful requests.
double	GrpcProxyMetricsMBean.getSuccessfulRequestOneMinuteRate()	Return the one minute rate of successful requests.
long	GrpcProxyMetricsMBean.getTaskActiveMillis()	Return the total number of milliseconds spent by all Daemon threads while executing tasks since the last time the statistics were reset.
long	GrpcProxyMetricsMBean.getTaskAddCount()	Return the total number of tasks added to the pool since the last time the statistics were reset.
int	GrpcProxyMetricsMBean.getTaskBacklog()	Return the number of tasks that have been added to the pool, but not yet scheduled for execution.
long	GrpcProxyMetricsMBean.getTaskCount()	Return the total number of tasks executed by Daemon threads since the last time the statistics were reset.
long	GrpcProxyMetricsMBean.getTaskTimeout()	Return the default timeout value for PriorityTasks that don't explicitly specify the execution timeout value.
int	GrpcProxyMetricsMBean.getTaskTimeoutCount()	Return the total number of timed-out tasks since the last time the statistics were reset.
Date	GrpcConnectionMetrics.ConnectionMetricsMBean.getTimestamp()	Returns the time that the connection was opened.
String	GrpcConnectionMetrics.ConnectionMetricsMBean.getUID()	Returns the UID for the connection.

Uses of Description in com.tangosol.io.journal

Classes in com.tangosol.io.journal with annotations of type Description

Modifier and Type	Interface	Description
interface	JournalMBean	A JournalMBean is an MBean interface providing statistics for a Journal Resource Manager as implemented by either FlashJournalRM or RamJournalRM implementations.

Methods in com.tangosol.io.journal with annotations of type Description

Modifier and Type	Method	Description
void	JournalMBean.compact(boolean fRegular)	Execute either a regular or exhaustive compaction on the journal based on the provided parameter.
int	JournalMBean.getBacklogCount()	Determine the number of serialized values that have not yet been persisted to disk.
int	JournalMBean.getBacklogSize()	Determine the total size in bytes of the serialized values that have not yet been persisted to disk.
int	JournalMBean.getBinaryStoreCount()	Determine the number of active BinaryStore objects that are using this Journal.
int	JournalMBean.getBufferSize()	Determine the size of the buffers used to write a chunk of data at a time to an underlying journal file.
double	JournalMBean.getCollectorLoadFactor()	Determine the load factor threshold at which files become eligible for garbage collection (compaction).
int	JournalMBean.getCompactionCount()	Determine the number of compactions (garbage collections) performed by this journal.
double	JournalMBean.getCurrentCollectorLoadFactor()	Determine the current load factor threshold for the journal.
int	JournalMBean.getExhaustiveCompactionCount()	Determine the total number of exhaustive compactions performed by the collector.
long	JournalMBean.getExhaustiveCompactionTime()	Return the total amount time spent performing exhaustive compaction.
int	JournalMBean.getFileCount()	Determine the number of Journal files used by this Journal.
double	JournalMBean.getHighestLoadFactor()	Determine the high-water mark load factor for the entire journal.
int	JournalMBean.getHighFileCount()	Determine the high file count for this Journal.
int	JournalMBean.getMaxBacklogSize()	Determine the maximum allowable size, in bytes, of the backlog; when the backlog reaches this level, writes are delayed until the backlog drops below its maximum.
long	JournalMBean.getMaxFileSize()	Determine the maximum allowable size, in bytes, of each individual file used to hold Journal data.
int	JournalMBean.getMaxJournalFilesNumber()	Determine the maximum number of Journal files.
long	JournalMBean.getMaxPoolSize()	Determine the maximum size (in bytes) of the buffers that can be held by the pool.
long	JournalMBean.getMaxTotalRam()	Determine the total amount, in bytes, of RAM that will be used for the Journal.
int	JournalMBean.getMaxValueSize()	Determine the maximum allowable size, in bytes, of a Binary value.
int	JournalMBean.getPoolSize()	Determine the size (in bytes) of the buffers that are currently available in the pool.
long	JournalMBean.getTotalDataSize()	Determine the amount of data currently stored by this Journal.
long	JournalMBean.getTotalFileSize()	Determine the number of bytes in the Journal files for this Journal.
boolean	JournalMBean.isNioRam()	Determine if the journal will use direct buffers (NIO RAM) instead of on-heap buffers (byte arrays).
void	JournalMBean.resetStatistics()	Reset the journal statistics.

Method parameters in com.tangosol.io.journal with annotations of type Description

Modifier and Type	Method	Description
void	JournalMBean.compact(boolean fRegular)	Execute either a regular or exhaustive compaction on the journal based on the provided parameter.

Uses of Description in com.tangosol.net.management

Classes in com.tangosol.net.management with annotations of type Description

Modifier and Type	Interface	Description
interface	ViewMBean

Methods in com.tangosol.net.management with annotations of type Description

Modifier and Type	Method	Description
String	ViewMBean.getFilter()	Obtain the Filter that this ContinuousQueryCache is using to query the underlying NamedCache.
long	ViewMBean.getReconnectInterval()	Return the reconnection interval (in milliseconds).
long	ViewMBean.getSize()	Returns the number of key-value mappings in this cache.
String	ViewMBean.getTransformer()	Obtain the transformer that this ContinuousQueryCache is using to transform the results from the underlying cache prior to storing them locally.
String	ViewMBean.getViewName()	Returns name of this cache.
boolean	ViewMBean.isCacheValues()	Determine if this ContinuousQueryCache caches values locally.
boolean	ViewMBean.isReadOnly()	Determine if this ContinuousQueryCache disallows data modification operations.
boolean	ViewMBean.isTransformed()	Determine if this ContinuousQueryCache transforms values.

Uses of Description in com.tangosol.net.partition

Classes in com.tangosol.net.partition with annotations of type Description

Modifier and Type	Interface	Description
interface	SimpleStrategyMBean	Standard MBean interface that exposes management attributes and operations for a SimpleAssignmentStrategy used by a PartitionedService.

Methods in com.tangosol.net.partition with annotations of type Description

Modifier and Type	Method	Description
long	SimpleStrategyMBean.getAveragePartitionSizeKB()	Get the average partition storage size.
long	SimpleStrategyMBean.getAverageStorageSizeKB()	Get the average node storage size.
int	SimpleStrategyMBean.getBackupCount()	Get the configured number of backups.
int	SimpleStrategyMBean.getCoordinatorId()	Get the node id of the ownership distribution coordinator.
int	SimpleStrategyMBean.getFairShareBackup()	Get the number of backup partitions per storage-enabled service member that this strategy will currently attempt to maintain.
int	SimpleStrategyMBean.getFairSharePrimary()	Get the number of primary partitions per storage-enabled service member that this strategy will currently attempt to maintain.
String	SimpleStrategyMBean.getHAStatus()	The High Availability status for the service.
int	SimpleStrategyMBean.getHAStatusCode()	The High Availability status for the service as an integer.
String	SimpleStrategyMBean.getHATarget()	The High Availability status that this strategy attempts to achieve.
Date	SimpleStrategyMBean.getLastAnalysisTime()	Get the last time a partition distribution analysis was performed.
int	SimpleStrategyMBean.getMaxLoadNodeId()	Get the node id with the maximum storage size.
long	SimpleStrategyMBean.getMaxPartitionSizeKB()	Get the maximum partition storage size.
long	SimpleStrategyMBean.getMaxStorageSizeKB()	Get maximum node storage size.
int	SimpleStrategyMBean.getPartitionCount()	Get the configured number of partitions for the service.
int	SimpleStrategyMBean.getRemainingDistributionCount()	Get the number of distributions (partition transfers) that remain to be completed before the service achieves the goals set by this strategy.
int	SimpleStrategyMBean.getServiceMachineCount()	Get the number of machines that host storage-enabled nodes running this service.
int	SimpleStrategyMBean.getServiceNodeCount()	Get the number of storage-enabled nodes running this service.
int	SimpleStrategyMBean.getServiceRackCount()	Get the number of racks that host storage-enabled nodes running this service.
int	SimpleStrategyMBean.getServiceSiteCount()	Get the number of sites that host storage-enabled nodes running this service.
String	SimpleStrategyMBean.getStrategyName()	Get name of the PartitionAssignmentStrategy in use.
String	SimpleStrategyMBean.reportScheduledDistributions(boolean fVerbose)	Report partitions that storage-enabled members are waiting to receive or still need to send in order to achieve distribution goal set by the strategy.

Method parameters in com.tangosol.net.partition with annotations of type Description

Modifier and Type	Method	Description
String	SimpleStrategyMBean.reportScheduledDistributions(boolean fVerbose)	Report partitions that storage-enabled members are waiting to receive or still need to send in order to achieve distribution goal set by the strategy.

Uses of Description in com.tangosol.persistence

Methods in com.tangosol.persistence with annotations of type Description

Modifier and Type	Method	Description
void	PersistenceManagerMBean.archiveSnapshot(String sName)	Archive the snapshot to a centralized location.
void	PersistenceManagerMBean.createSnapshot(String sName)	Create a snapshot of the service with the specified name.
void	PersistenceManagerMBean.forceRecovery()	Proceed with recovery despite the dynamic quorum policy objections.
int	PersistenceManagerMBean.getCoordinatorId()	Return the node id of the persistence coordinator.
String	PersistenceManagerMBean.getOperationStatus()	Return the status of the current operation issued by the persistence coordinator.
String	PersistenceManagerMBean.getSnapshotRecoveryStatus(String sName)	Return the recovery status of the specific snapshot.
String[]	PersistenceManagerMBean.getSnapshots()	Return a list of snapshots that are available for recovery.
String	PersistenceManagerMBean.getSnapshotStatus(String sName)	Return the status of the specific snapshot.
boolean	PersistenceManagerMBean.isIdle()	Specifies whether or not the persistence coordinator is idle.
String[]	PersistenceManagerMBean.listArchivedSnapshots()	Return a list of archived snapshots that the configured archiver knows about.
String[]	PersistenceManagerMBean.listArchivedSnapshotStores(String sName)	Return a list of stores for a given archived snapshot.
String[]	PersistenceManagerMBean.listFailedSnapshots()	Return a list of failed snapshots.
void	PersistenceManagerMBean.recoverSnapshot(String sName)	Recover the snapshot that was previously created with the specified name.
void	PersistenceManagerMBean.removeArchivedSnapshot(String sName)	Purge the archived snapshot from a centralized location.
void	PersistenceManagerMBean.removeSnapshot(String sName)	Remove the snapshot that was previously created with the specified name.
void	PersistenceManagerMBean.retrieveArchivedSnapshot(String sName)	Retrieve the archived snapshot from a centralized location.

Method parameters in com.tangosol.persistence with annotations of type Description

Modifier and Type	Method	Description
void	PersistenceManagerMBean.archiveSnapshot(String sName)	Archive the snapshot to a centralized location.
void	PersistenceManagerMBean.createSnapshot(String sName)	Create a snapshot of the service with the specified name.
String	PersistenceManagerMBean.getSnapshotRecoveryStatus(String sName)	Return the recovery status of the specific snapshot.
String	PersistenceManagerMBean.getSnapshotStatus(String sName)	Return the status of the specific snapshot.
String[]	PersistenceManagerMBean.listArchivedSnapshotStores(String sName)	Return a list of stores for a given archived snapshot.
void	PersistenceManagerMBean.recoverSnapshot(String sName)	Recover the snapshot that was previously created with the specified name.
void	PersistenceManagerMBean.removeArchivedSnapshot(String sName)	Purge the archived snapshot from a centralized location.
void	PersistenceManagerMBean.removeSnapshot(String sName)	Remove the snapshot that was previously created with the specified name.
void	PersistenceManagerMBean.retrieveArchivedSnapshot(String sName)	Retrieve the archived snapshot from a centralized location.

Uses of Description in com.tangosol.util

Methods in com.tangosol.util with annotations of type Description

Modifier and Type	Method	Description
String	HealthCheck.getName()	Returns the unique name of this health check.
boolean	HealthCheck.isLive()	Returns true if the resource represented by this HealthCheck is alive, otherwise returns false.
default boolean	HealthCheck.isMemberHealthCheck()	Return true if this HealthCheck should be included when working out this Coherence member's health status.
boolean	HealthCheck.isReady()	Returns true if the resource represented by this HealthCheck is ready, otherwise returns false.
boolean	HealthCheck.isSafe()	Returns true if the resource represented by this HealthCheck is in a safe state to allow a rolling upgrade to proceed, otherwise returns false.
boolean	HealthCheck.isStarted()	Returns true if the resource represented by this HealthCheck is started, otherwise returns false.