org.eclipse.jetty.rewrite.handler.HeaderPatternRule Maven / Gradle / Ivy

Go to download
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.rewrite.handler;

import java.io.IOException;

import org.eclipse.jetty.server.Response;
import org.eclipse.jetty.util.Callback;
import org.eclipse.jetty.util.annotation.Name;

/**
 * Puts or adds a response header whenever the rule matches a path Servlet pattern.
 */
public class HeaderPatternRule extends PatternRule
{
    private String _headerName;
    private String _headerValue;
    private boolean _add;

    public HeaderPatternRule()
    {
    }

    public HeaderPatternRule(@Name("pattern") String pattern, @Name("name") String name, @Name("value") String value)
    {
        super(pattern);
        _headerName = name;
        _headerValue = value;
    }

    public String getHeaderName()
    {
        return _headerName;
    }

    public void setHeaderName(String name)
    {
        _headerName = name;
    }

    public String getHeaderValue()
    {
        return _headerValue;
    }

    public void setHeaderValue(String value)
    {
        _headerValue = value;
    }

    public boolean isAdd()
    {
        return _add;
    }

    /**
     * Use {@code true} to add the response header, {@code false} to put the response header.
     *
     * @param add {@code true} to add the response header, {@code false} to put the response header.
     */
    public void setAdd(boolean add)
    {
        _add = add;
    }

    @Override
    public Handler apply(Handler input) throws IOException
    {
        return new Handler(input)
        {
            @Override
            protected boolean handle(Response response, Callback callback) throws Exception
            {
                if (isAdd())
                    response.getHeaders().add(getHeaderName(), getHeaderValue());
                else
                    response.getHeaders().put(getHeaderName(), getHeaderValue());
                return super.handle(response, callback);
            }
        };
    }

    @Override
    public String toString()
    {
        return "%s[header:%s=%s]".formatted(super.toString(), getHeaderName(), getHeaderValue());
    }
}