org.glassfish.api.container.Adapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-all Show documentation
Payara-Embedded-All Distribution of the Payara Project
There is a newer version: 4.1.2.181
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2006-2012 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.api.container;

import java.net.InetAddress;
import java.util.List;
import org.glassfish.grizzly.http.server.HttpHandler;

import org.jvnet.hk2.annotations.Contract;

/**
 * Contract interface for registering adapters to a port. Each
 * adapter listens to a particular context root. Context root
 * can be / which makes this adapter the default web application
 *
 * @author Jerome Dochez
 *
 */
@Contract
public interface Adapter {

    /**
     * Get the underlying Grizzly {@link HttpHandler}.
     * 
     * @return the underlying Grizzly {@link HttpHandler}.
     */
    public abstract HttpHandler getHttpService();

    /**
     * Returns the context root for this adapter
     * @return context root
     */
    public abstract String getContextRoot();

    /**
     * Returns the listener port for this adapter
     * @return listener port
     */
    public abstract int getListenPort();


    /**
     * @return the {@link InetAddress} on which this adapter is listening
     */
    public abstract InetAddress getListenAddress();

    /**
     * Returns the virtual servers supported by this adapter
     * @return List<String> the virtual server list supported by the adapter
     */
    public abstract List getVirtualServers();

    /**
     * Checks whether this adapter has been registered as a network endpoint.
     */
    public abstract boolean isRegistered();


    /**
     * Marks this adapter as having been registered or unregistered as a
     * network endpoint
     */
    public abstract void setRegistered(boolean isRegistered);
}