org.glassfish.grizzly.config.dom.ProtocolChain 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) 2022, 2023 Contributors to the Eclipse Foundation
 * Copyright (c) 2009, 2020 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 jakarta.validation.constraints.Pattern;

import java.util.List;

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

/**
 * Defines the type of protocol chain and describes protocol filters,
 * which will participate in request processing.
 */
@Configured
public interface ProtocolChain extends ConfigBeanProxy, PropertyBag {

    String TYPE = "STATELESS";

    String TYPE_PATTERN = "STATELESS|STATEFUL";

    /**
     * Protocol chain instance handler implementation class.
     */
    @Attribute
    String getClassname();

    void setClassname(String classname);

    /**
     * Protocol chain type. Could be {@code STATEFUL} or {@code STATELESS}.
     */
    @Attribute(defaultValue = TYPE)
    @Pattern(regexp = TYPE_PATTERN, message = "Valid values: " + TYPE_PATTERN)
    String getType();

    void setType(String type);

    /**
     * Defines protocol filter sequence, which will process a request.
     */
    @Element
    List getProtocolFilter();

    void setProtocolFilter(List protocolFilters);

    @Override
    default Protocol getParent() {
        return getParent(Protocol.class);
    }
}