org.glassfish.virtualization.spi.VirtualMachineInfo Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.virtualization.spi;
import java.util.concurrent.TimeUnit;
/**
* Returns the virtual machine information
* @author Jerome Dochez
*/
public interface VirtualMachineInfo extends StaticVirtualMachineInfo {
/**
* Returns the maximum memory allocated to this virtual machine.
*
* @return the virtual machine maximum memory.
*/
long maxMemory() throws VirtException;
/**
* Returns the current memory used by this virtual machine
* @return the virtual machine current memory usage
*/
long memory() throws VirtException;
/**
* Returns the CPU used by this virtual machine
* @return the CPU time used by this VM.
* @throws VirtException
*/
long cpuTime() throws VirtException;
/**
* Returns the machine's state
* @return the machine's state
*
* @throws VirtException if the machine's state cannot be obtained
*/
Machine.State getState() throws VirtException;
/**
* Registers a memory changes listener
* @param ml the memory listener instance
* @param delay notification interval for memory changes polling.
* @param unit the time unit to express delay
*/
void registerMemoryListener(MemoryListener ml, long delay, TimeUnit unit);
/**
* Un-registers a memory changes listener
* @param ml, the listener to un-register.
*/
void unregisterMemoryListener(MemoryListener ml);
}