org.glassfish.grizzly.config.dom.ProtocolFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grizzly-config Show documentation

There is a newer version: 8.0.0-JDK17-M9

/*
 * Copyright (c) 2023 Contributors to the Eclipse Foundation
 * Copyright (c) 2009, 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 org.glassfish.grizzly.config.dom;

import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.types.PropertyBag;

/**
 * Describes a protocol finder/recognizer, which is able to recognize whether
 * incoming request belongs to the specific protocol or not. If {@code yes} -
 * protocol-finder forwards request processing to a specific protocol.
 */
@Configured
public interface ProtocolFinder extends ConfigBeanProxy, PropertyBag {

    /**
     * Finder {@code name}, which could be used as reference.
     */
    @Attribute(key = true)
    String getName();

    void setName(String name);

    /**
     * Reference to a {@code protocol}, which was defined before.
     */
    @Attribute
    String getProtocol();

    void setProtocol(String protocol);

    /**
     * Finder logic implementation class
     */
    @Attribute(required = true)
    String getClassname();

    void setClassname(String classname);

    default Protocol findProtocol() {
        final NetworkConfig networkConfig = getParent().getParent().getParent().getParent();
        return networkConfig.findProtocol(getProtocol());
    }

    default PortUnification getParent() {
        return getParent(PortUnification.class);
    }
}