com.unboundid.directory.sdk.common.api

Interface DiskSpaceConsumer

@Extensible
 @DirectoryServerExtension
 @DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=false)
 @SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=false)
 @MetricsEngineExtension
 @BrokerExtension
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface DiskSpaceConsumer

This interface defines a set of methods that should be implemented by classes which may consume a significant amount of disk space on the server filesystem. It may be used by the server to monitor usable disk space for those components. Disk space consumers should be registered using the ServerContext.registerDiskSpaceConsumer method, and should be deregistered using the corresponding deregisterDiskSpaceConsumer method if they are no longer needed.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDiskSpaceConsumerName() Retrieves the name that should be used to identify this disk space consumer.
java.util.List<java.io.File>	getDiskSpaceConsumerPaths() Retrieves a list of filesystem paths in which this disk space consumer may store files which may consume a significant amount of space.

Method Detail

getDiskSpaceConsumerName

java.lang.String getDiskSpaceConsumerName()

Retrieves the name that should be used to identify this disk space consumer.

Returns:

The name that should be used to identify this disk space consumer.

getDiskSpaceConsumerPaths

java.util.List<java.io.File> getDiskSpaceConsumerPaths()

Retrieves a list of filesystem paths in which this disk space consumer may store files which may consume a significant amount of space. It is generally recommended that the paths be directories, but they may also be individual files.

Returns:

A list of filesystem paths in which this disk space consumer may store files which may consume a significant amount of space.