de.schlichtherle.truezip.fs.inst.jmx.JmxManagerViewMXBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truezip-extension-jmx-jul Show documentation

This module provides a file system manager and an I/O pool service for managing and monitoring TrueZIP via JMX and java.util.logging. 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.

The newest version!

/*
 * Copyright (C) 2005-2015 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
package de.schlichtherle.truezip.fs.inst.jmx;

import de.schlichtherle.truezip.fs.FsManager;
import de.schlichtherle.truezip.fs.FsSyncException;

/**
 * The MXBean interface for a {@link FsManager file system manager}.
 *
 * @author Christian Schlichtherle
 */
public interface JmxManagerViewMXBean {

    /**
     * Returns the total number of file systems.
     * 
     * @return The total number of file systems.
     */
    int getFileSystemsTotal();

    /**
     * Returns the number of file systems
     * which have been mounted and need synchronization by calling
     * {@link #sync}.
     * 
     * Note that you should not use the returned value to synchronize
     * conditionally - this would be unreliable!
     * 
     * @return The number of mounted file systems.
     */
    int getFileSystemsMounted();

    /**
     * Returns the total number of top level archive file systems.
     * 
     * @return The total number of top level archive file systems.
     */
    int getTopLevelArchiveFileSystemsTotal();

    /**
     * Returns the number of top level archive file systems
     * which have been mounted and need synchronization by calling
     * {@link #sync}.
     * 
     * Note that you should not use the returned value to synchronize
     * conditionally - this would be unreliable!
     * 
     * @return The number of mounted top level archive file systems.
     */
    int getTopLevelArchiveFileSystemsMounted();

    /**
     * Synchronizes all managed file systems.
     * 
     * @throws FsSyncException If any managed file system is busy
     *         with I/O.
     */
    void sync() throws FsSyncException;
    
    void clearStatistics();
}