/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. 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.html
 * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [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.
 */

/*
 * Copyright 2004-2005 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*
 * PWCKeepAliveStats.java
 *
 * Created on April 2, 2004, 10:33 AM
 */

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

/**
 *
 * @author  nsegura
 */

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

/** 
 * Provides statistical information about the HttpService HTTP-level keep-alive
 * system
 */
public interface PWCKeepAliveStats extends Stats {
    
    /** 
     * Number of connections in keep-alive mode
     * @return number of connections
     */    
    public CountStatistic getCountConnections();
    
    /** 
     * Maximum number of connections allowed in keep-alive mode simultaneously
     * @return Max number of connections allowed
     */    
    public CountStatistic getMaxConnections();
    
    /** 
     * The number of times a request was successfully received from a 
     * connection that had been kept alive
     * @return hits
     */    
    public CountStatistic getCountHits();
    
    /** 
     * The number of times the server had to close a connection because the
     * KeepAliveCount exceeded the MaxKeepAliveConnections
     * @return connections
     */    
    public CountStatistic getCountFlushes();
    
    /** 
     * The number of times the server could not hand off the connection to a 
     * keep-alive thread, possibly due to too many persistent connections
     * @return refusals
     */    
    public CountStatistic getCountRefusals();
    
    /** 
     * The number of times the server terminated keep-alive connections as the 
     * client connections timed out, without any activity
     * @return connections timed out
     */    
    public CountStatistic getCountTimeouts();
    
    /** 
     * The time (in seconds) before idle keep-alive connections are closed
     * @return time in seconds
     */    
    public CountStatistic getSecondsTimeouts();
    
}