Package org.apache.logging.log4j.core.jmx

Class RingBufferAdmin

java.lang.Object

org.apache.logging.log4j.core.jmx.RingBufferAdmin

All Implemented Interfaces:

RingBufferAdminMBean

public class RingBufferAdmin
extends java.lang.Object
implements RingBufferAdminMBean

Instruments an LMAX Disruptor ring buffer.

Field Summary

Fields

Modifier and Type	Field	Description
private javax.management.ObjectName	objectName
private com.lmax.disruptor.RingBuffer<?>	ringBuffer

Fields inherited from interface org.apache.logging.log4j.core.jmx.RingBufferAdminMBean

PATTERN_ASYNC_LOGGER, PATTERN_ASYNC_LOGGER_CONFIG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RingBufferAdmin(com.lmax.disruptor.RingBuffer<?> ringBuffer, java.lang.String mbeanName)

Method Summary

Modifier and Type	Method	Description
static RingBufferAdmin	forAsyncLogger(com.lmax.disruptor.RingBuffer<?> ringBuffer, java.lang.String contextName)
static RingBufferAdmin	forAsyncLoggerConfig(com.lmax.disruptor.RingBuffer<?> ringBuffer, java.lang.String contextName, java.lang.String configName)
long	getBufferSize()	Returns the number of slots that the ring buffer was configured with.
javax.management.ObjectName	getObjectName()	Returns the ObjectName of this mbean.
long	getRemainingCapacity()	Returns the number of available slots in the ring buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ringBuffer

private final com.lmax.disruptor.RingBuffer<?> ringBuffer

objectName

private final javax.management.ObjectName objectName

Constructor Detail

RingBufferAdmin

protected RingBufferAdmin(com.lmax.disruptor.RingBuffer<?> ringBuffer,
                          java.lang.String mbeanName)

Method Detail

forAsyncLogger

public static RingBufferAdmin forAsyncLogger(com.lmax.disruptor.RingBuffer<?> ringBuffer,
                                             java.lang.String contextName)

forAsyncLoggerConfig

public static RingBufferAdmin forAsyncLoggerConfig(com.lmax.disruptor.RingBuffer<?> ringBuffer,
                                                   java.lang.String contextName,
                                                   java.lang.String configName)

getBufferSize

public long getBufferSize()

Description copied from interface: RingBufferAdminMBean

Returns the number of slots that the ring buffer was configured with. Disruptor ring buffers are bounded-size data structures, this number does not change during the life of the ring buffer.

Specified by:

getBufferSize in interface RingBufferAdminMBean

Returns:

the number of slots that the ring buffer was configured with

getRemainingCapacity

public long getRemainingCapacity()

Description copied from interface: RingBufferAdminMBean

Returns the number of available slots in the ring buffer. May vary wildly between invocations.

Specified by:

getRemainingCapacity in interface RingBufferAdminMBean

Returns:

the number of available slots in the ring buffer

getObjectName

public javax.management.ObjectName getObjectName()

Returns the ObjectName of this mbean.

Returns:

the ObjectName

See Also:

RingBufferAdminMBean.PATTERN_ASYNC_LOGGER, RingBufferAdminMBean.PATTERN_ASYNC_LOGGER_CONFIG