Package org.forgerock.bloomfilter.monitoring

Class BloomFilterMonitor<T>

java.lang.Object

org.forgerock.bloomfilter.monitoring.BloomFilterMonitor<T>

All Implemented Interfaces:

BloomFilter<T>, BloomFilterMXBean

public final class BloomFilterMonitor<T>
extends Object
implements BloomFilterMXBean, BloomFilter<T>

Generic Bloom Filter JMX monitoring.

Constructor Summary

Constructors

Constructor	Description
BloomFilterMonitor(BloomFilter<T> delegate)

Method Summary

Modifier and Type	Method	Description
void	add(T element)	Adds the specified element to this set if it is not already possibly present.
void	addAll(Collection<? extends T> elements)	Adds all of the specified elements to this set if they are not possibly already present.
double	getConfiguredFalsePositiveProbability()
long	getCurrentCapacity()
long	getEstimatedRemainingCapacity()
double	getExpectedFalsePositiveProbability()
Date	getExpiryTime()
long	getMemorySizeKB()
BloomFilterStatistics	getStatistics()	Gets a snapshot of the current statistics of the set.
boolean	mightContain(T element)	Checks if the given element might be a member of this set.
void	register()
void	register(MBeanServer mBeanServer)
ObjectInstance	register(MBeanServer mBeanServer, String packageName, String instanceName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BloomFilterMonitor

public BloomFilterMonitor(BloomFilter<T> delegate)

Method Details

register

public ObjectInstance register(MBeanServer mBeanServer,
 String packageName,
 String instanceName)
                        throws InstanceAlreadyExistsException,
MBeanRegistrationException,
MalformedObjectNameException

Throws:

InstanceAlreadyExistsException

MBeanRegistrationException

MalformedObjectNameException

register

public void register(MBeanServer mBeanServer)
              throws InstanceAlreadyExistsException,
MBeanRegistrationException

Throws:

InstanceAlreadyExistsException

MBeanRegistrationException

register

public void register()
              throws InstanceAlreadyExistsException,
MBeanRegistrationException

Throws:

InstanceAlreadyExistsException

MBeanRegistrationException

add

public void add(T element)

Description copied from interface: BloomFilter

Adds the specified element to this set if it is not already possibly present. After a call to this method, subsequent calls to BloomFilter.mightContain(Object) will return true for the same object.

Specified by:

add in interface BloomFilter<T>

Parameters:

element - the element to add to this set.

addAll

public void addAll(Collection<? extends T> elements)

Description copied from interface: BloomFilter

Adds all of the specified elements to this set if they are not possibly already present.

Specified by:

addAll in interface BloomFilter<T>

Parameters:

elements - the elements to add to the set.

mightContain

public boolean mightContain(T element)

Description copied from interface: BloomFilter

Checks if the given element might be a member of this set. If this method returns false, then the given object is definitely not a member of the set. If the result is true then the object may or may not be a member of this set, with a certain probability of false positives.

Specified by:

mightContain in interface BloomFilter<T>

Parameters:

element - the element to check for membership in this set.

Returns:

false if the element is definitely not in the set, or true if it might be.

getStatistics

public BloomFilterStatistics getStatistics()

Description copied from interface: BloomFilter

Gets a snapshot of the current statistics of the set.

Specified by:

getStatistics in interface BloomFilter<T>

getConfiguredFalsePositiveProbability

public double getConfiguredFalsePositiveProbability()

Specified by:

getConfiguredFalsePositiveProbability in interface BloomFilterMXBean

getExpectedFalsePositiveProbability

public double getExpectedFalsePositiveProbability()

Specified by:

getExpectedFalsePositiveProbability in interface BloomFilterMXBean

getCurrentCapacity

public long getCurrentCapacity()

Specified by:

getCurrentCapacity in interface BloomFilterMXBean

getEstimatedRemainingCapacity

public long getEstimatedRemainingCapacity()

Specified by:

getEstimatedRemainingCapacity in interface BloomFilterMXBean

getMemorySizeKB

public long getMemorySizeKB()

Specified by:

getMemorySizeKB in interface BloomFilterMXBean

getExpiryTime

public Date getExpiryTime()

Specified by:

getExpiryTime in interface BloomFilterMXBean

toString

public String toString()

Overrides:

toString in class Object