appserver/connectors/connectors-runtime/src/main/java/com/sun/enterprise/resource/pool/PoolProperties.java

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.enterprise.resource.pool;

/**
 * Pool supplementary classes can use this to retrieve runtime pool attributes.
 *
 * @author Jagadish Ramu
 */
public interface PoolProperties {

    /**
     * gets the steady pool size of the pool
     * @return steady pool size
     */
    int getSteadyPoolSize();

    /**
     * gets the max pool size of the pool
     * @return max pool size
     */
    int getMaxPoolSize();

    /**
     * gets the resize quantity of the pool
     * @return resize quantity
     */
    int getResizeQuantity();

    /**
     * gets the idle connection timeout value
     * @return idle timeout value
     */
    long getIdleTimeout();

    /**
     * gets the current wait queue length
     * @return wait queue length
     */
    int getWaitQueueLength();
}