org.glassfish.loadbalancer.admin.cli.reader.api.WebModuleReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 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.loadbalancer.admin.cli.reader.api;

/**
 * Provides web module information relavant to Load balancer tier.
 *
 * @author Satish Viswanatham
 */
public interface WebModuleReader extends BaseReader {

    /**
     * Returns config context of this module
     *
     * @return String           context root for this web module
     */
    public String getContextRoot() throws LbReaderException;

    /**
     * Returns error url for this web module
     *
     * @return  String          This url acts as error page for this module
     */
    public String getErrorUrl() throws LbReaderException;

    /**
     * Returns load balancer enabled flag.
     *
     * @return @boolean         true, if enabled; false, if disabled in LB
     */
    public boolean getLbEnabled() throws LbReaderException;

    /**
     * Returns disable timeout for this module
     *
     * @return @String          value must be > 0
     */
    public String getDisableTimeoutInMinutes() throws LbReaderException;

    /**
     * Returns idempotent url patterns for this module.
     *
     * @return  IdempotentUrlPatternReader[]    list of idempotent url patterns
     */
    public IdempotentUrlPatternReader[] getIdempotentUrlPattern()
            throws LbReaderException;
}