org.apache.jackrabbit.oak.index.indexer.document.flatfile

Class DefaultMemoryManager

java.lang.Object

org.apache.jackrabbit.oak.index.indexer.document.flatfile.DefaultMemoryManager

All Implemented Interfaces:

MemoryManager

public class DefaultMemoryManager
extends java.lang.Object
implements MemoryManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.index.indexer.document.flatfile.MemoryManager

MemoryManager.Type

Constructor Summary

Constructors

Constructor and Description
DefaultMemoryManager()
DefaultMemoryManager(long minMemoryInBytes, long maxMemoryInBytes)

Method Summary

Modifier and Type	Method and Description
void	changeMemoryUsedBy(long memory) Adds the provided memory value to existing memory usage.
boolean	deregisterClient(java.lang.String registrationID) Deregister a client with the given registrationID.
MemoryManager.Type	getType()
boolean	isMemoryLow() Checks if available memory is low.
java.util.Optional<java.lang.String>	registerClient(MemoryManagerClient client) Register a client with this memory manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMemoryManager

public DefaultMemoryManager()

DefaultMemoryManager

public DefaultMemoryManager(long minMemoryInBytes,
                            long maxMemoryInBytes)

Method Detail

getType

public MemoryManager.Type getType()

Specified by:

getType in interface MemoryManager

isMemoryLow

public boolean isMemoryLow()

Description copied from interface: MemoryManager

Checks if available memory is low. NOTE - this method should only be used with MemoryManager.Type.SELF_MANAGED instance types, otherwise it throws UnsupportedOperationException

Specified by:

isMemoryLow in interface MemoryManager

Returns:

true if available memory is low, false otherwise.

changeMemoryUsedBy

public void changeMemoryUsedBy(long memory)

Description copied from interface: MemoryManager

Adds the provided memory value to existing memory usage. Callers of this method could also provide negative values to indicate reduction in memory usage. NOTE - this method should only be used with MemoryManager.Type.SELF_MANAGED instance types, otherwise it throws UnsupportedOperationException

Specified by:

changeMemoryUsedBy in interface MemoryManager

registerClient

public java.util.Optional<java.lang.String> registerClient(MemoryManagerClient client)

Description copied from interface: MemoryManager

Register a client with this memory manager. All registered clients are informed when available memory level is low. If memory level is already low, client is not registered. NOTE - this method should only be used with MemoryManager.Type.JMX_BASED instance types, otherwise it throws UnsupportedOperationException

Specified by:

registerClient in interface MemoryManager

Parameters:

client - client to register

Returns:

an optional containing registration id if registration was successful, empty optional otherwise

deregisterClient

public boolean deregisterClient(java.lang.String registrationID)

Description copied from interface: MemoryManager

Deregister a client with the given registrationID. NOTE - this method should only be used with MemoryManager.Type.JMX_BASED instance types, otherwise it throws UnsupportedOperationException

Specified by:

deregisterClient in interface MemoryManager

Parameters:

registrationID - registration id of client to deregister

Returns:

true if deregistration was successful, false otherwise.