com.sun.enterprise.admin.monitor.stats.PWCHttpServiceStats Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-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.
 */
// Portions Copyright [2019] Payara Foundation and/or affiliates

package com.sun.enterprise.admin.monitor.stats;

import javax.management.j2ee.statistics.CountStatistic;
import javax.management.j2ee.statistics.Stats;

/**
 * Contains Statistical Information for the HttpService
 * @author  nsegura
 */
public interface PWCHttpServiceStats extends Stats {
    
    /** 
     * Returns HttpService Id
     * @return HttpService Id
     */
    public StringStatistic getID();
    
    /** 
     * Returns the HttpService Version
     * @return HttpService Version
     */
    public StringStatistic getVersionServer();
    
    /** 
     * Returns the Time the HttpService Was Started
     * @return Time HttpService Started
     */
    public StringStatistic getTimeStarted();
    
    /** Returns the amount of seconds the HttpService has been running
     * @return seconds HttpService has been running
     */
    public CountStatistic getSecondsRunning();
       
    /** Returns the max amount of threads
     * @return the max amount of threads
     */
    public CountStatistic getMaxThreads();
    
    /** 
     * The Max amount of virtual servers
     * @return Max amount of virtual servers
     */
    public CountStatistic getMaxVirtualServers();
    
    /** 
     * Returns 1 if profiling is enabled, otherwise 0
     * @return profile enabled?
     */
    public CountStatistic getFlagProfilingEnabled();
    
    /** 
     * Returns 1 if virtual server overflow is enable, otherwise 0
     * @return virtual sever overflow enabled?
     */
    public CountStatistic getFlagVirtualServerOverflow();
    
    /** 
     * Returns the average load in the last minute
     * @return average 1 minute load
     */
    public CountStatistic getLoad1MinuteAverage();
    
    /** 
     * Returns the average load for the last 5 minutes
     * @return average 5 minute load
     */
    public CountStatistic getLoad5MinuteAverage();
    
    /** 
     * Returns the average load for the last 15 minutes
     * @return average 15 minute load
     */
    public CountStatistic getLoad15MinuteAverage();
    
    /**
     * Returns the rate of bytes transmitted
     * @return byte trasmission rate
     */    
    public CountStatistic getRateBytesTransmitted();
    
    /** 
     * Returns the rate of bytes received
     * @return byte receive rate
     */    
    public CountStatistic getRateBytesReceived();
    
}