org.apache.tiles.request.jakarta.servlet.ExternalWriterHttpServletResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tiles-request-jakarta-servlet Show documentation

Tiles request implementation for Jakarta-Servlet technology.

The newest version!

/*
 * Copyright 2023 Web-Legacy
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.tiles.request.jakarta.servlet;

import java.io.PrintWriter;

import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpServletResponseWrapper;

/**
 * Wraps an HTTP response and overrides its print writer.
 *
 * Copied from Apache tiles-request-servlet 1.0.7 and adapted for
 * Jakarta EE 9.
 */
public class ExternalWriterHttpServletResponse extends
        HttpServletResponseWrapper {

    /**
     * The print writer to use, instead of the response's one.
     */
    private PrintWriter writer;

    /**
     * Constructor.
     *
     * @param response The response to wrap.
     * @param writer   The print writer to use, instead of the response's one.
     */
    public ExternalWriterHttpServletResponse(HttpServletResponse response,
            PrintWriter writer) {

        super(response);

        this.writer = writer;
    }

    /**
     * Returns the print writer to use, instead of the response's one.
     *
     * @return the {@code PrintWriter} object that is set within the
     *         constructor
     */
    @Override
    public PrintWriter getWriter() {
        return writer;
    }
}