Skip navigation links

Overview | Package | Class | Tree | Index | Help
| Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.tangosol.net.management
Interface Registry

      public interface Registry

The Coherence cluster management gateway is an abstraction of the basic JMX registration APIs that is specific to managing Coherence clustered resources. Though this interface is closely related to the JMX infrastructure, it is independent from `javax.management.*` classes. This enables remote management support for cluster nodes that are not co-located with any JMX services. <p/>

#### MBean Names

Each Coherence MBean has a unique `ObjectName` for registration in a MBeanServer that could either be co-located or remote in relation to the managed object. Each cluster node has a single instance of the following managed beans:

> Managed Bean | ObjectName
> --- | ---
> ManagementMBean | `type=Management`
> ReporterMBean | `type=Reporter`
> ClusterMBean | `type=Cluster`
> ClusterNodeMBean | `type=Node`, nodeId=cluster node's id
> PointToPointMBean | `type=PointToPoint`, nodeId=cluster node's id

<p/> A cluster node may have zero or more instances of the following managed beans:

> Managed Bean | ObjectName
> --- | ---
> ServiceMBean | `type=Service`, name=service name,nodeId=cluster node's id
> CacheMBean | `type=Cache`, service=service name,name=cache name, nodeId=cluster node's id[,tier=tier tag]
> StorageManagerMBean | `type=StorageManager`, service=service name,cache=cache name, nodeId=cluster node's id
> ConnectionManagerMBean | `type=ConnectionManager`, name=service name,nodeId=cluster node's id
> ConnectionMBean | `type=Connection`, name=service name,nodeId=cluster node's id, UUID=connection's UUID&nbsp
> TransactionManagerMBean | `type=TransactionManager`, service=service name,nodeId=cluster node's id

The domain name for each managed bean will be assigned automatically (see `getDomainName()`.)

#### ClusterMBean Attributes and Operations

The ClusterMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> ClusterName | String | RO | The name of the cluster.
> ClusterSize | Integer | RO | The total number of cluster nodes.
> LicenseMode | String | RO | The license mode that this cluster is using. Possible values are Evaluation, Development or Production.
> LocalMemberId | Integer | RO | The member id for the cluster member that is co-located with the reporting MBeanServer; -1 if the cluster service is not running.
> MemberIds | Integer[] | RO | An array of all existing cluster member ids.
> Members | String[] | RO | An array of all existing cluster members.
> MembersDeparted | String[] | RO | An array of strings containing the Member information for recently departed cluster members. Members will be removed from this array when the member id is recycled. This information is since the node has joined the cluster and is reset when the MBeanServer node leaves and rejoins the cluster. The MembersDepartureCount is the total count of departed members and not the size of this array.
> MembersDepartureCount | Long | RO | The number of times this node has observed another node`s departure from the cluster since this management node has joined the cluster or statistics have been reset.
> OldestMemberId | Integer | RO | The senior cluster member id; -1 if the cluster service is not running.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> Running | Boolean | RO | Specifies whether or not the cluster is running.
> Version | String | RO | The Coherence version.

The ClusterMBean has the following operations:

> Name | Parameters | Return Type | Description
> --- | --- | --- | ---
> ensureRunning | void | void | Ensures that the cluster service is running on this node.
> shutdown | void | void | Shuts down the cluster service on this node.

#### ClusterNodeMBean Attributes and Operations

The ClusterNodeMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> BufferPublishSize | Integer | RW | The buffer size of the unicast datagram socket used by the Publisher, measured in the number of packets. Changing this value at runtime is an inherently unsafe operation that will pause all network communications and may result in the termination of all cluster services.
> BufferReceiveSize | Integer | RW | The buffer size of the unicast datagram socket used by the Receiver, measured in the number of packets. Changing this value at runtime is an inherently unsafe operation that will pause all network communications and may result in the termination of all cluster services.
> CpuCount | Integer | RO | Number of CPU cores for the machine this Member is running on.
> FlowControlEnabled | Boolean | RO | Indicates whether or not FlowControl is enabled.
> Id | Integer | RO | The short Member id that uniquely identifies the Member at this point in time and does not change for the life of this Member.
> LoggingDestination | String | RO | The output device used by the logging system. Valid values are stdout, stderr, jdk, log4j, or a file name.
> LoggingFormat | String | RW | Specifies how messages will be formatted before being passed to the log destination
> LoggingLevel | Integer | RW | Specifies which logged messages will be output to the log destination. Valid values are non-negative integers or -1 to disable all logger output.
> LoggingLimit | Integer | RW | The maximum number of characters that the logger daemon will process from the message queue before discarding all remaining messages in the queue. Valid values are integers in the range [0...]. Zero implies no limit.
> MachineId | Integer | RO | The Member`s machine Id.
> MachineName | String | RO | A configured name that should be the same for all Members that are on the same physical machine, and different for Members that are on different physical machines.
> MemberName | String | RO | A configured name that must be unique for every Member.
> MemoryAvailableMB | Integer | RO | The total amount of memory in the JVM available for new objects in MB.
> MemoryMaxMB | Integer | RO | The maximum amount of memory that the JVM will attempt to use in MB.
> MulticastAddress | String | RO | The IP address of the Member`s MulticastSocket for group communication.
> MulticastEnabled | Boolean | RO | Specifies whether or not this Member uses multicast for group communication. If false, this Member will use the WellKnownAddresses to join the cluster and point-to-point unicast to communicate with other Members of the cluster.
> MulticastPort | Integer | RO | The port of the Member`s MulticastSocket for group communication.
> MulticastTTL | Integer | RO | The time-to-live for multicast packets sent out on this Member`s MulticastSocket.
> MulticastThreshold | Integer | RW | The percentage (0 to 100) of the servers in the cluster that a packet will be sent to, above which the packet will be multicasted and below which it will be unicasted.
> NackEnabled | Boolean | RO | Indicates whether or not the early packet loss detection protocol is enabled.
> NackSent | Long | RO | The total number of NACK packets sent since the node statistics were last reset.
> PacketDeliveryEfficiency | Float | RO | The efficiency of packet loss detection and retransmission. A low efficiency is an indication that there is a high rate of unnecessary packet retransmissions.
> PacketsBundled | Long | RO | The total number of packets which were bundled prior to transmission. The total number of network transmissions is equal to (PacketsSent - PacketsBundled).
> PacketsReceived | Long | RO | The number of packets received since the node statistics were last reset.
> PacketsRepeated | Long | RO | The number of duplicate packets received since the node statistics were last reset.
> PacketsResent | Long | RO | The number of packets resent since the node statistics were last reset. A packet is resent when there is no ACK received within a timeout period.
> PacketsResentEarly | Long | RO | The total number of packets resent ahead of schedule. A packet is resent ahead of schedule when there is a NACK indicating that the packet has not been received.
> PacketsResentExcess | Long | RO | The total number of packet retransmissions which were later proven unnecessary.
> PacketsSent | Long | RO | The number of packets sent since the node statistics were last reset.
> Priority | Integer | RO | The priority or "weight" of the Member; used to determine tie-breakers.
> ProcessName | String | RO | A configured name that should be the same for Members that are in the same process (JVM), and different for Members that are in different processes. If not explicitly provided, for processes running with JRE 1.5 or higher the name will be calculated internally as the Name attribute of the system RuntimeMXBean, which normally represents the process identifier (PID).
> ProductEdition | String | RO | The product edition this Member is running. Possible values are: Standard Edition (SE), Enterprise Edition (EE), Grid Edition (GE).
> PublisherPacketUtilization | Float | RO | The publisher packet utilization for this cluster node since the node socket was last reopened. This value is a ratio of the number of bytes sent to the number that would have been sent had all packets been full. A low utilization indicates that data is not being sent in large enough chunks to make efficient use of the network.
> PublisherSuccessRate | Float | RO | The publisher success rate for this cluster node since the node statistics were last reset. Publisher success rate is a ratio of the number of packets successfully delivered in a first attempt to the total number of sent packets. A failure count is incremented when there is no ACK received within a timeout period. It could be caused by either very high network latency or a high packet drop rate.
> QuorumStatus | String | RO | The current state of the cluster quorum.
> RackName | String | RO | A configured name that should be the same for Members that are on the same physical "rack" (or frame or cage), and different for Members that are on different physical "racks".
> ReceiverPacketUtilization | Float | RO | The receiver packet utilization for this cluster node since the socket was last reopened. This value is a ratio of the number of bytes received to the number that would have been received had all packets been full. A low utilization indicates that data is not being sent in large enough chunks to make efficient use of the network.
> ReceiverSuccessRate | Float | RO | The receiver success rate for this cluster node since the node statistics were last reset. Receiver success rate is a ratio of the number of packets successfully acknowledged in a first attempt to the total number of received packets. A failure count is incremented when a re-delivery of previously received packet is detected. It could be caused by either very high inbound network latency or lost ACK packets.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> ResendDelay | Integer | RW | The minimum number of milliseconds that a packet will remain queued in the Publisher`s re-send queue before it is resent to the recipient(s) if the packet has not been acknowledged. Setting this value too low can overflow the network with unnecessary repetitions. Setting the value too high can increase the overall latency by delaying the re-sends of dropped packets. Additionally, change of this value may need to be accompanied by a change in SendAckDelay value.
> RoleName | String | RO | A configured name that can be used to indicate the role of a Member to the application. While managed by Coherence, this property is used only by the application.
> SendAckDelay | Integer | RW | The minimum number of milliseconds between the queueing of an Ack packet and the sending of the same. This value should be not more then a half of the ResendDelay value.
> SendQueueSize | Integer | RO | The number of packets currently scheduled for delivery. This number includes both packets that are to be sent immediately and packets that have already been sent and awaiting for acknowledgment. Packets that do not receive an acknowledgment within ResendDelay interval will be automatically resent.
> SiteName | String | RO | A configured name that should be the same for Members that are on the same physical site (e.g. data center), and different for Members that are on different physical sites.
> SocketCount | Integer | RO | Number of CPU sockets for the machine this Member is running on.
> Statistics | String | RO | Statistics for this cluster node in a human readable format.
> TcpRingFailures | Long | RO | The number of recovered TcpRing disconnects since the node statistics were last reset. A recoverable disconnect is an abnormal event that is registered when the TcpRing peer drops the TCP connection, but recovers after no more then maximum configured number of attempts.This value will be -1 if the TcpRing is disabled.
> Timestamp | Date | RO | The date/time value (in cluster time) that this Member joined the cluster.
> TrafficJamCount | Integer | RW | The maximum total number of packets in the send and resend queues that forces the publisher to pause client threads. Zero means no limit.
> TrafficJamDelay | Integer | RW | The number of milliseconds to pause client threads when a traffic jam condition has been reached. Anything less than one (e.g. zero) is treated as one millisecond.
> UnicastAddress | String | RO | The IP address of the Member`s DatagramSocket for point-to-point communication.
> UnicastPort | Integer | RO | The port of the Member`s DatagramSocket for point-to-point communication.
> WeakestChannel | Integer | RO | The id of the cluster node to which this node is having the most difficulty communicating, or -1 if none is found. A channel is considered to be weak if either the point-to-point publisher or receiver success rates are below 1.0.
> WellKnownAddresses | String[] | RO | An array of well-known socket addresses that this Member uses to join the cluster.

The ClusterNodeMBean has the following operations:

> Name | Parameters | Return Type | Description
> --- | --- | --- | ---
> ensureCacheService | String sCacheName | void | Ensure that a CacheService for the specified cache runs at the cluster node represented by this MBean. This method will use the configurable cache factory to find out which cache service to start if necessary. Return value indicates the service name; null if a match could not be found.
> ensureInvocationService | String sServiceName | void | Ensure that an InvocationService with the specified name runs at the cluster node represented by this MBean.
> resetStatistics | void | void | Reset the cluster node statistics.
> shutdown | void | void | Stop all the clustered services running at this node (controlled shutdown). The management of this node will node be available until the node is restarted (manually or programmatically).

#### PointToPointMBean Attributes and Operations

The PointToPointMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> DeferredPackets | Integer | RO | The number of packets addressed to the viewed member that the viewing member is currently deferring to send. The viewing member will delay sending these packets until the number of outstanding packets falls below the value of the Threshold attribute. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
> Deferring | Boolean | RO | Indicates whether or not the viewing member is currently deferring packets to the viewed member. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
> LastIn | Long | RO | The number of milliseconds that have elapsed since the viewing member last received an acknowledgment from the viewed member.
> LastOut | Long | RO | The number of milliseconds that have elapsed since the viewing member last sent a packet to the viewed member.
> LastSlow | Long | RO | The number of milliseconds that have elapsed since the viewing member declared the viewed member as slow, or -1 if the viewed member has never been declared slow.
> OutstandingPackets | Integer | RO | The number of packets that the viewing member has sent to the viewed member which have yet to be acknowledged. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
> PauseRate | Float | RO | The percentage of time since the last time statistics were reset in which the viewing member considered the viewed member to be unresponsive. Under normal conditions this value should be very close to 0.0. Values near 1.0 would indicate that the viewed node is nearly inoperable, likely due to extremely long GC pauses. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
> Paused | Boolean | RO | Indicates whether or not the viewing member currently considers the viewed member to be unresponsive. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
> PublisherSuccessRate | Float | RO | The publisher success rate from the viewing node to the viewed node since the statistics were last reset.
> ReceiverSuccessRate | Float | RO | The receiver success rate from the viewing node to the viewed node since the statistics were last reset.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> Threshold | Integer | RO | The maximum number of outstanding packets for the viewed member that the viewing member is allowed to accumulate before initiating the deferral algorithm. The value of this attribute is only meaningful if the viewing member has FlowControl enabled.
> ViewedMemberId | Integer | RW | The Id of the member being viewed.
> ViewerStatistics | String[] | RO | Human readable summary of the point-to-point statistics from the viewing member for all other members.

The PointToPointMBean has the following operations:

> Name | Parameters | Return Type | Description
> --- | --- | --- | ---
> resetStatistics | void | void | Reset the viewing member`s point-to-point statistics for all other members.
> trackWeakest | void | void | Instruct the PointToPointMBean to track the weakest member. A viewed member is considered to be weak if either the corresponding publisher or receiver success rates are below 1.0.

#### ServiceMBean Attributes and Operations

The ServiceMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> BackupCount | Integer | RO | The number of backups for every cache storage.
> BackupCountAfterWritebehind | Integer | RO | The number of members of the partitioned (distributed) cache service that will retain backup data that does _not_ require write-behind, i.e. data that is not vulnerable to being lost even if the entire cluster were shut down.
> OwnedPartitionsBackup | Integer | RO | The number of partitions that this Member backs up (responsible for the backup storage).
> OwnedPartitionsPrimary | Integer | RO | The number of partitions that this Member owns (responsible for the primary storage).
> PartitionsAll | Integer | RO | The total number of partitions that every cache storage will be divided into.
> PartitionsEndangered | Integer | RO | The total number of partitions that are not currently backed up.
> PartitionsUnbalanced | Integer | RO | The total number of primary and backup partitions which remain to be transferred until the partition distribution across the storage enabled service members is fully balanced.
> PartitionsVulnerable | Integer | RO | The total number of partitions that are backed up on the same machine where the primary partition owner resides.
> QuorumStatus | String | RO | The current state of the service quorum.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> RequestAverageDuration | Float | RO | The average duration (in milliseconds) of an individual synchronous request issued by the service since the last time the statistics were reset.
> RequestMaxDuration | Long | RO | The maximum duration (in milliseconds) of a synchronous request issued by the service since the last time the statistics were reset.
> RequestPendingCount | Long | RO | The number of pending synchronous requests issued by the service.
> RequestPendingDuration | Long | RO | The duration (in milliseconds) of the oldest pending synchronous request issued by the service.
> RequestTimeoutCount | Long | RO | The total number of timed-out requests since the last time the statistics were reset.
> RequestTimeoutMillis | Long | RW | The default timeout value in milliseconds for requests that can be timed-out (e.g. implement the com.tangosol.net.PriorityTask interface), but do not explicitly specify the request timeout value.
> RequestTotalCount | Long | RO | The total number of synchronous requests issued by the service since the last time the statistics were reset.
> Running | Boolean | RO | Specifies whether or not the service is running.
> SeniorMemberId | Integer | RO | The service senior member id; -1 if the service is not running.
> Statistics | String | RO | Statistics for this service in human readable format.
> StatusHA | String | RO | The High Availability status for this service. The value of MACHINE-SAFE means that all the cluster nodes running on any given machine could be stoppped at once without data loss. The value of NODE-SAFE means that any cluster node could be stoppped without data loss. The value of ENDANGERED indicates that abnormal termination of any cluster node that runs this service may cause data loss.
> StorageEnabled | Boolean | RO | Specifies whether or not the local storage is enabled for this cluster Member.
> StorageEnabledCount | Integer | RO | Specifies the total number of cluster nodes running this Service for which local storage is enabled.
> TaskAverageDuration | Float | RO | The average duration (in milliseconds) of an individual task execution.
> TaskBacklog | Integer | RO | The size of the backlog queue that holds tasks scheduled to be executed by one of the service threads.
> TaskCount | Long | RO | The total number of executed tasks since the last time the statistics were reset.
> TaskHungCount | Integer | RO | The total number of currently executing hung tasks.
> TaskHungDuration | Long | RO | The longest currently executing hung task duration in milliseconds.
> TaskHungTaskId | String | RO | The id of the of the longest currently executing hung task.
> TaskHungThresholdMillis | Long | RW | The amount of time in milliseconds that a task can execute before it is considered hung. Note that a posted task that has not yet started is never considered as hung.
> TaskMaxBacklog | Integer | RO | The maximum size of the backlog queue since the last time the statistics were reset.
> TaskTimeoutCount | Integer | RO | The total number of timed-out tasks since the last time the statistics were reset.
> TaskTimeoutMillis | Long | RW | The default timeout value in milliseconds for tasks that can be timed-out (e.g. implement the com.tangosol.net.PriorityTask interface), but do not explicitly specify the task execution timeout value.
> ThreadAbandonedCount | Integer | RO | The number of abandoned threads from the service thread pool. A thread is abandoned and replaced with a new thread if it executes a task for a period of time longer than execution timeout and all attempts to interrupt it fail.
> ThreadAverageActiveCount | Float | RO | The average number of active (not idle) threads in the service thread pool since the last time the statistics were reset.
> ThreadCount | Integer | RW | The number of threads in the service thread pool.
> ThreadIdleCount | Integer | RO | The number of currently idle threads in the service thread pool.
> Type | String | RO | The type identifier of the service.

The ServiceMBean has the following operations:

> Name | Parameters | Return Type | Description
> --- | --- | --- | ---
> reportOwnership | void | String | Format the ownership info.
> resetStatistics | void | void | Reset the service statistics.
> shutdown | void | void | Stop the service. This is a controlled shut-down, and is preferred to the 'stop' method.
> start | void | void | Start the service.
> stop | void | void | Hard-stop the service. Use 'shutdown()' method for normal service termination.

#### CacheMBean Attributes and Operations

The CacheMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> AverageGetMillis | Double | RO | The average number of milliseconds per get() invocation since the last time statistics were reset.
> AverageHitMillis | Double | RO | The average number of milliseconds per get() invocation that is a hit.
> AverageMissMillis | Double | RO | The average number of milliseconds per get() invocation that is a miss.
> AveragePutMillis | Double | RO | The average number of milliseconds per put() invocation since the cache statistics were last reset.
> BatchFactor | Double | RW | The BatchFactor attribute is used to calculate the `soft-ripe` time for write-behind queue entries. A queue entry is considered to be `ripe` for a write operation if it has been in the write-behind queue for no less than the QueueDelay interval. The `soft-ripe` time is the point in time prior to the actual `ripe` time after which an entry will be included in a batched asynchronous write operation to the CacheStore (along with all other `ripe` and `soft-ripe` entries). This attribute is only applicable if asynchronous writes are enabled (i.e. the value of the QueueDelay attribute is greater than zero) and the CacheStore implements the storeAll() method. The value of the element is expressed as a percentage of the QueueDelay interval. Valid values are doubles in the interval [0.0, 1.0].
> CacheHits | Long | RO | The rough number of cache hits since the last time statistics were reset. A cache hit is a read operation invocation (i.e. get()) for which an entry exists in this map.
> CacheHitsMillis | Long | RO | The total number of milliseconds (since the last time statistics were reset) for the get() operations for which an entry existed in this map.
> CacheMisses | Long | RO | The rough number of cache misses since the last time statistics were reset.
> CacheMissesMillis | Long | RO | The total number of milliseconds ( since the last time statistics were reset) for the get() operations for which no entry existed in this map.
> CachePrunes | Long | RO | The number of `prune` operations since the last time statistics were reset. A prune operation occurs every time the cache reaches its high watermark.
> CachePrunesMillis | Long | RO | The total number of milliseconds for the prune operations since the last time statistics were reset.
> Description | String | RO | The cache description.
> ExpiryDelay | Integer | RW | The time-to-live for cache entries in milliseconds. Value of zero indicates that the automatic expiry is disabled. Change of this attribute will not affect already-scheduled expiry of existing entries.
> FlushDelay | Integer | RW | The number of milliseconds between cache flushes. Value of zero indicates that the cache will never flush.
> HighUnits | Integer | RW | The limit of the cache size measured in units. The cache will prune itself automatically once it reaches its maximum unit level. This is often referred to as the `high water mark` of the cache.
> HitProbability | Double | RO | The rough probability (0 <= p <= 1) that the next invocation will be a hit, based on the statistics collected since the last time statistics were reset.
> LowUnits | Integer | RW | The number of units to which the cache will shrink when it prunes. This is often referred to as a `low water mark` of the cache.
> PersistenceType | String | RO | The persistence type for this cache. Possible values include: NONE, READ-ONLY, WRITE-THROUGH, WRITE-BEHIND.
> QueueDelay | Integer | RW | The number of seconds that an entry added to a write-behind queue will sit in the queue before being stored via a CacheStore. Applicable only for WRITE-BEHIND persistence type.
> QueueSize | Integer | RO | The size of the write-behind queue size. Applicable only for WRITE-BEHIND persistence type.
> RefreshFactor | Double | RW | The RefreshFactor attribute is used to calculate the `soft-expiration` time for cache entries. Soft-expiration is the point in time prior to the actual expiration after which any access request for an entry will schedule an asynchronous load request for the entry. This attribute is only applicable for a ReadWriteBackingMap which has an internal LocalCache with scheduled automatic expiration. The value of this element is expressed as a percentage of the internal LocalCache expiration interval. Valid values are doubles in the interval[0.0, 1.0]. If zero, refresh-ahead scheduling will be disabled.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> RequeueThreshold | Integer | RW | The maximum size of the write-behind queue for which failed CacheStore write operations are requeued. If zero, the write-behind requeueing will be disabled. Applicable only for WRITE-BEHIND persistence type.
> Size | Integer | RO | The number of entries in the cache.
> StoreAverageBatchSize | Long | RO | The average number of entries stored per CacheStore write operation. A call to the store() method is counted as a batch of one, whereas a call to the storeAll() method is counted as a batch of the passed Map size. The value of this attribute is -1 if the persistence type is NONE.
> StoreAverageReadMillis | Long | RO | The average time (in millis) spent per read operation; -1 if persistence type is NONE.
> StoreAverageWriteMillis | Long | RO | The average time (in millis) spent per write operation; -1 if persistence type is NONE.
> StoreFailures | Long | RO | The total number of CacheStore failures (load, store and erase operations); -1 if persistence type is NONE.
> StoreReadMillis | Long | RO | The cummulative time (in millis) spent on load operations; -1 if persistence type is NONE.
> StoreReads | Long | RO | The total number of load operations; -1 if persistence type is NONE.
> StoreWriteMillis | Long | RO | The cummulative time (in milliseconds) spent on store and erase operations; -1 if persistence type is NONE or READ-ONLY.
> StoreWrites | Long | RO | The total number of store and erase operations; -1 if persistence type is NONE or READ-ONLY.
> TotalGets | Long | RO | The total number of get() operations since the last time statistics were reset.
> TotalGetsMillis | Long | RO | The total number of milliseconds spent on get() operations since the last time statistics were reset.
> TotalPuts | Long | RO | The total number of put() operations since the last time statistics were reset.
> TotalPutsMillis | Long | RO | The total number of milliseconds spent on put() operations since the last time statistics were reset.
> UnitFactor | Integer | RO | The factor by which the Units, LowUnits and HighUnits properties are adjusted. Using a BINARY unit calculator, for example, the factor of 1048576 could be used to count megabytes instead of bytes.
> Units | Integer | RO | The size of the cache measured in units. This value needs to be adjusted by the UnitFactor.

The CacheMBean has the following operations:

> Name | Parameters | Return Type | Description
> --- | --- | --- | ---
> resetStatistics | void | void | Reset the cache statistics.

#### StorageManagerMBean Attributes and Operations

The StorageManagerMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> EventsDispatched | Long | RO | The total number of events dispatched by the StorageManager since the last time the statistics were reset.
> EvictionCount | Long | RO | The number of evictions from the backing map managed by this StorageManager caused by entries expiry or insert operations that would make the underlying backing map to reach its configured size limit. The eviction count is used to audit the cache size in a static system. Cache Size = Insert Count - Remove Count - Eviction count. Therefore the eviction count is not reset by the reset statistics method.
> IndexInfo | String[] | RO | An array of information for each index applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that includes a ValueExtractor description, ordered flag (true to indicate that the contents of the index are ordered; false otherwise), and cardinality (number of unique values indexed).
> InsertCount | Long | RO | The number of inserts into the backing map managed by this StorageManager. In addition to standard inserts caused by put and invoke operations or synthetic inserts caused by get operations with read-through backing map topology, this counter is incremented when distribution transfers move resources `into` the underlying backing map and is decremented when distribution transfers move data `out`. The insert count is used to audit the cache size in a static system. Cache Size = Insert Count - Remove Count - Eviction count. Therefore the insert count is not reset by the reset statistics method.
> ListenerFilterCount | Integer | RO | The number of filter-based listeners currently registered with the StorageManager.
> ListenerKeyCount | Integer | RO | The number of key-based listeners currently registered with the StorageManager.
> ListenerRegistrations | Long | RO | The total number of listener registration requests processed by the StorageManager since the last time the statistics were reset.
> LocksGranted | Integer | RO | The number of locks currently granted for the portion of the partitioned cache managed by the StorageManager.
> LocksPending | Integer | RO | The number of pending lock requests for the portion of the partitioned cache managed by the StorageManager.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> RemoveCount | Long | RO | The number of removes from the backing map managed by this StorageManager caused by operations such as clear, remove or invoke. The remove count is used to audit the cache size in a static system. Cache Size = Insert Count - Remove Count - Eviction count. Therefore the remove count is not reset by the reset statistics method.
> TriggerInfo | String[] | RO | An array of information for each trigger applied to the portion of the partitioned cache managed by the StorageManager. Each element is a string value that represents a human-readable description of the corresponding MapTrigger.

The StorageManagerMBean has the following operations:

> Name | Parameters | Return Type | Description
> --- | --- | --- | ---
> resetStatistics | void | void | Reset the storage statistics. This method does not reset the EvictionCount, InsertCount or RemoveCount attributes.

#### ConnectionMBean Attributes and Operations

The ConnectionMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> ConnectionTimeMillis | Long | RO | The time duration (in milliseconds) that the client has been connected.
> OutgoingByteBacklog | Long | RO | The backlog (in bytes) of the outgoing queue
> OutgoingMessageBacklog | Integer | RO | The backlog of the outgoing message queue.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> RemoteAddress | String | RO | The IP address of the corresponding client.
> RemotePort | Integer | RO | The port of the corresponding client.
> Timestamp | Date | RO | The date/time value (in local time) that the corresponding client connected to the Proxy.
> TotalBytesReceived | Long | RO | The total number of bytes recieved since the last time the statistics were reset.
> TotalBytesSent | Long | RO | The total number of bytes sent since the last time the statistics were reset.
> TotalMessagesReceived | Long | RO | The total number of messages received since the last time the statistics were reset.
> TotalMessagesSent | Long | RO | The total number of messages sent since the last time the statistics were reset.
> UUID | String | RO | The unique identifier for this connection.

The ConnectionMBean has the following operations:

> Name | Parameters | Return Type | Description
> --- | --- | --- | ---
> closeConnection | void | void | Close the corresponding connection.
> resetStatistics | void | void | Reset statistics.

#### ConnectionManagerMBean Attributes and Operations

The ConnectionManagerMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> ConnectionCount | Integer | RO | The number of client connections.
> HostIP | String | RO | The IP address and port of the Proxy host.
> IncomingBufferPoolCapacity | Long | RO | The pool capacity (in bytes) of the incoming buffer.
> IncomingBufferPoolSize | Integer | RO | The number of buffers in the incoming pool.
> OutgoingBufferPoolCapacity | Long | RO | The pool capacity (in bytes) of the outgoing buffer.
> OutgoingBufferPoolSize | Integer | RO | The number of buffers in the outgoing pool.
> OutgoingByteBacklog | Long | RO | The backlog (in bytes) of the outgoing queue
> OutgoingMessageBacklog | Long | RO | The backlog of the outgoing message queue.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> TotalBytesReceived | Long | RO | The total number of bytes received by the Proxy host since the statistics were last reset.
> TotalBytesSent | Long | RO | The total number of bytes sent by the Proxy host since the statistics were last reset.
> TotalMessagesReceived | Long | RO | The total number of messgaes received by the Proxy host since the statistics were last reset.
> TotalMessagesSent | Long | RO | The total number of messgaes sent by the Proxy host since the statistics were last reset.

#### ManagementMBean Attributes and Operations

The ManagementMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> ExpiryDelay | Long | RW | The number of milliseconds that the MBeanServer will keep a remote model snapshot before refreshing.
> RefreshCount | Long | RO | The total number of snapshots retrieved since the statistics were last reset.
> RefreshExcessCount | Long | RO | The number of times the MBean server predictively refreshed information and the information was not accessed.
> RefreshOnQuery | Boolean | RO | Specifies whether or not the refresh-on-query MBeanServer is configured. If this is true then the RefreshPolicy value should be `refresh-onquery`.
> RefreshPolicy | String | RW | The policy used to determine the behavior when refreshing remote models. Valid values are: refresh-ahead, refresh-behind, refresh-expired, refresh-onquery. Invalid values will convert to `refresh-expired`.
> RefreshPredictionCount | Long | RO | The number of times the MBeanServer used a predictive (refresh-behind, refresh-ahead, refresh-onquery) algorithm to refresh MBean information.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> RefreshTimeoutCount | Long | RO | The number of times this management node has timed out while attempting to refresh remote MBean attributes.
> RemoteNotificationCount | Long | RO | The total number of remote notifications received for all MBeans by this node since the last time the statistis were reset.

The ManagementMBean has the following operations:

> Name | Parameters | Return Type | Description
> --- | --- | --- | ---
> resetStatistics | void | void | Reset the SyncCount, MissCount and AsyncCount Statistics.

#### TransactionManagerMBean Attributes and Operations

The TransactionManagerMBean has the following attributes:

> Name | Type | Access | Description
> --- | --- | --- | ---
> CommitTotalMillis | Long | RO | The cumulative time (in milliseconds) spent during the commit phase since the last time statistics were reset.
> RefreshTime | Date | RO | The timestamp when this model was last retrieved from a corresponding node. For local servers it is the local time.
> TimeoutMillis | Long | RO | The transaction timeout value in milliseconds. Note that this value will only apply to transactional connections obtained after the value is set.
> TotalActive | Long | RO | The total number of currently active transactions. An active transaction is counted as any transaction that contains at least one modified entry and has yet to be committed or rolled back. Note that the count is maintained at the coordinator node for the transaction, even though multiple nodes may have participated in the transaction.
> TotalCommitted | Long | RO | The total number of transactions that have been committed by the Transaction Manager since the last time the statistics were reset. Note that the count is maintained at the coordinator node for the transaction being committed, even though multiple nodes may have participated in the transaction.
> TotalRecovered | Long | RO | The total number of transactions that have been recovered by the Transaction Manager since the last time the statistics were reset. Note that the count is maintained at the coordinator node for the transaction being recovered, even though multiple nodes may have participated in the transaction.
> TotalRolledback | Long | RO | The total number of transactions that have been rolled back by the Transaction Manager since the last time the statistics were reset. Note that the count is maintained at the coordinator node for the transaction being rolled back, even though multiple nodes may have participated in the transaction.
> TransactionTotalMillis | Long | RO | The cumulative time (in milliseconds) spent on active transactions since the last time the statistics were reset.

The TransactionManagerMBean has the following operations:

> Name | Parameters | Return Type | Description
> --- | --- | --- | ---
> resetStatistics | void | void | Reset the transaction statistics.

<p/>

#### Custom MBeans

In addition to the standard Coherence managed object types, any dynamic or standard MBean type may be registered locally or globally using the Registry. <p/> For example, the following code registers a custom standard MBean object globally:

     Registry    registry = CacheFactory.ensureCluster().getManagement();
     CustomMBean bean     = new Custom();
     String      sName    = registry.ensureGlobalName("type=Custom");

     registry.register(sName, bean);

Since:
  Coherence 3.0
Author:
  gg 2004.11.01, jh 2005.09.14

Field Summary
`static String` | `CACHE_TYPE` String representing the "type" part of `ObjectName` for the CacheMBean.
`static String` | `CLUSTER_TYPE` String representation of the `ObjectName` for the ClusterMBean.
`static String` | `CONNECTION_MANAGER_TYPE` String representing the "type" part of `ObjectName` for the ConnectionManagerMBean.
`static String` | `CONNECTION_TYPE` String representing the "type" part of `ObjectName` for the ConnectionMBean.
`static String` | `MANAGEMENT_TYPE` String representing the "type" part of `ObjectName` for the ManagementMBean.
`static String` | `NODE_TYPE` String representing the "type" part of `ObjectName` for the ClusterNodeMBean.
`static String` | `POINT_TO_POINT_TYPE` String representing the "type" part of `ObjectName` for the PointToPointMBean.
`static String` | `REPORTER_TYPE` String representing the "type" part of `ObjectName` for the ReporterMBean.
`static String` | `SERVICE_TYPE` String representing the "type" part of `ObjectName` for the ServiceMBean.
`static String` | `STORAGE_MANAGER_TYPE` String representing the "type" part of `ObjectName` for the StorageManagerMBean.
`static String` | `TRANSACTION_MANAGER_TYPE` String representing the "type" part of `ObjectName` for the TransactionManagerMBean.

Method Summary
`String` | `ensureGlobalName(String sName)` Convert the passed MBean name to a global name if necessary.
`String` | `getDomainName()` Domain name for managed beans registered by Coherence clustered services.
`NotificationManager` | `getNotificationManager()` Obtain a reference to the NotificationManager for this Registry.
`boolean` | `isRegistered(String sName)` Check whether or not the specified name is already registered.
`void` | `register(String sName, Object oBean)` Register a manageable object.
`void` | `unregister(String sName)` Unregister managed objects that match the specified object name or name pattern (query name).

Field Detail

### CLUSTER_TYPE

    static final String CLUSTER_TYPE

  String representation of the `ObjectName` for the ClusterMBean. There will be one and only one MBean by this name. It represents a local cluster node and can only be viewed or managed locally.
  See Also:
    Constant Field Values

### NODE_TYPE

    static final String NODE_TYPE

  String representing the "type" part of `ObjectName` for the ClusterNodeMBean.
  See Also:
    Constant Field Values

### SERVICE_TYPE

    static final String SERVICE_TYPE

  String representing the "type" part of `ObjectName` for the ServiceMBean.
  See Also:
    Constant Field Values

### CACHE_TYPE

    static final String CACHE_TYPE

  String representing the "type" part of `ObjectName` for the CacheMBean.
  See Also:
    Constant Field Values

### STORAGE_MANAGER_TYPE

    static final String STORAGE_MANAGER_TYPE

  String representing the "type" part of `ObjectName` for the StorageManagerMBean.
  See Also:
    Constant Field Values

### POINT_TO_POINT_TYPE

    static final String POINT_TO_POINT_TYPE

  String representing the "type" part of `ObjectName` for the PointToPointMBean.
  See Also:
    Constant Field Values

### CONNECTION_MANAGER_TYPE

    static final String CONNECTION_MANAGER_TYPE

  String representing the "type" part of `ObjectName` for the ConnectionManagerMBean.
  See Also:
    Constant Field Values

### CONNECTION_TYPE

    static final String CONNECTION_TYPE

  String representing the "type" part of `ObjectName` for the ConnectionMBean.
  See Also:
    Constant Field Values

### MANAGEMENT_TYPE

    static final String MANAGEMENT_TYPE

  String representing the "type" part of `ObjectName` for the ManagementMBean.
  See Also:
    Constant Field Values

### REPORTER_TYPE

    static final String REPORTER_TYPE

  String representing the "type" part of `ObjectName` for the ReporterMBean.
  See Also:
    Constant Field Values

### TRANSACTION_MANAGER_TYPE

    static final String TRANSACTION_MANAGER_TYPE

  String representing the "type" part of `ObjectName` for the TransactionManagerMBean.
  See Also:
    Constant Field Values

Method Detail

### getDomainName

    String getDomainName()

  Domain name for managed beans registered by Coherence clustered services. For cluster nodes that are co-located with an MBeanServer instance, the returned value is "Coherence" (or "Coherence@NNN" in a case of a name conflict when multiple clusters run within the same JVM). For the nodes that are managed remotely and do not run an MBeanServer, the returned value is an empty string.
  Returns:
    the domain name

### ensureGlobalName

    String ensureGlobalName(String sName)

  Convert the passed MBean name to a global name if necessary. <p/> A global name contains a `nodeId` key property that differentiates an MBean name from an otherwise identical MBean name registered by a different cluster node.
  Parameters:
    `sName` - any valid MBean name
  Returns:
    a fully qualified version of the given MBean name

### isRegistered

    boolean isRegistered(String sName)

  Check whether or not the specified name is already registered.
  Parameters:
    `sName` - the MBean's name
  Returns:
    true iff the specified name is already registered

### register

    void register(String sName,
                  Object oBean)

  Register a manageable object. The object itself is not necessarily an MBean. If the object is not an MBean (standard or dynamic), the Registry will determine what MBean corresponds to the object and will instantiate and register the neccesary MBean either locally or globally depending on the type of the managed object. <p/> If the given MBean name is a `global` name, the corresponding MBean will be registered with all available MBeanServers (local or remote); otherwise, the MBean will only be registered with the local MBeanServer.
  Parameters:
    `sName` - the MBean's name
    `oBean` - the managed object

### unregister

    void unregister(String sName)

  Unregister managed objects that match the specified object name or name pattern (query name).
  Parameters:
    `sName` - MBean's name or a name pattern

### getNotificationManager

    NotificationManager getNotificationManager()

  Obtain a reference to the NotificationManager for this Registry.
  Returns:
    the NotificationManager object

Skip navigation links

Overview | Package | Class | Tree | Index | Help
| Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.