net.java.truevfs.ext.pacemaker.PaceManagerMXBean.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truevfs-ext-pacemaker Show documentation

Constrains the number of concurrently mounted archive file systems in order to save some heap space. This module provides a JMX interface for monitoring and management. Add the JAR artifact of this module to the run time class path to make its services available for service location in the client API modules.

There is a newer version: 0.14.0

Show newest version

/*
 * Copyright (C) 2005-2013 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
package net.java.truevfs.ext.pacemaker

import net.java.truevfs.comp.jmx.JmxManagerMXBean

/**
  * An MXBean interface for a [[net.java.truevfs.ext.pace.PaceManager]].
  *
  * @author Christian Schlichtherle
  */
trait PaceManagerMXBean extends JmxManagerMXBean {

  /**
    * Returns the maximum number of file systems which may have been mounted
    * at any time.
    * The minimum value is `MAXIMUM_FILE_SYSTEMS_MOUNTED_MINIMUM_VALUE`.
    * The default value is `MAXIMUM_FILE_SYSTEMS_MOUNTED_DEFAULT_VALUE`.
    *
    * @return The maximum number of mounted file systems.
    */
  def getMaximumFileSystemsMounted: Int

  /**
    * Sets the maximum number of file systems which may have been mounted
    * at any time.
    * Changing this property will show effect upon the next access to any
    * file system.
    *
    * @param  maxMounted the maximum number of mounted file systems.
    * @throws IllegalArgumentException if `maxMounted` is less than
    *         `MAXIMUM_FILE_SYSTEMS_MOUNTED_MINIMUM_VALUE`.
    */
  def setMaximumFileSystemsMounted(maxMounted: Int)
}