View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  
22  package org.opencastproject.workspace.impl.jmx;
23  
24  /**
25   * JMX Bean interface exposing workspace storage information
26   */
27  public interface WorkspaceMXBean {
28  
29    /**
30     * Gets the free workspace space in bytes
31     *
32     * @return free space in bytes
33     */
34    long getFreeSpace();
35  
36    /**
37     * Gets the used workspace space in bytes
38     *
39     * @return used space in bytes
40     */
41    long getUsedSpace();
42  
43    /**
44     * Gets the total available workspace space in bytes
45     *
46     * @return total available space in bytes
47     */
48    long getTotalSpace();
49  
50  }