com.aspectran.web.adapter.HttpServletResponseAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectran-all Show documentation
Aspectran (All-in-One)
The newest version!
/*
 * Copyright (c) 2008-2025 The Aspectran Project
 *
 * 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 com.aspectran.web.adapter;

import com.aspectran.core.activity.Activity;
import com.aspectran.core.activity.response.Response;
import com.aspectran.core.activity.response.ResponseException;
import com.aspectran.core.activity.response.transform.TransformResponse;
import com.aspectran.core.adapter.AbstractResponseAdapter;
import com.aspectran.core.adapter.ResponseAdapter;
import com.aspectran.core.context.rule.RedirectRule;
import com.aspectran.core.context.rule.type.FormatType;
import com.aspectran.web.support.util.SendRedirectBasedOnXForwardedProtocol;
import com.aspectran.web.support.util.WebUtils;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;
import java.io.OutputStream;
import java.io.Writer;
import java.util.Collection;

/**
 * Adapt {@link HttpServletResponse} to Core {@link ResponseAdapter}.
 *
 * @since 2011. 3. 13.
 */
public class HttpServletResponseAdapter extends AbstractResponseAdapter {

    public static final String PROXY_PROTOCOL_AWARE_SETTING_NAME = "proxyProtocolAware";

    private final Activity activity;

    private boolean precommitDone;

    /**
     * Instantiates a new HttpServletResponseAdapter.
     * @param response the HTTP response
     * @param activity the activity
     */
    public HttpServletResponseAdapter(HttpServletResponse response, Activity activity) {
        super(response);
        this.activity = activity;
    }

    @Override
    public String getHeader(String name) {
        return getHttpServletResponse().getHeader(name);
    }

    @Override
    public Collection getHeaders(String name) {
        return getHttpServletResponse().getHeaders(name);
    }

    @Override
    public Collection getHeaderNames() {
        return getHttpServletResponse().getHeaderNames();
    }

    @Override
    public boolean containsHeader(String name) {
        return getHttpServletResponse().containsHeader(name);
    }

    @Override
    public void setHeader(String name, String value) {
        getHttpServletResponse().setHeader(name, value);
    }

    @Override
    public void addHeader(String name, String value) {
        getHttpServletResponse().addHeader(name, value);
    }

    @Override
    public String getEncoding() {
        return getHttpServletResponse().getCharacterEncoding();
    }

    @Override
    public void setEncoding(String encoding) {
        getHttpServletResponse().setCharacterEncoding(encoding);
    }

    @Override
    public String getContentType() {
        return getHttpServletResponse().getContentType();
    }

    @Override
    public void setContentType(String contentType) {
        getHttpServletResponse().setContentType(contentType);
    }

    @Override
    public OutputStream getOutputStream() throws IOException {
        precommit();
        return getHttpServletResponse().getOutputStream();
    }

    @Override
    public Writer getWriter() throws IOException {
        precommit();
        return getHttpServletResponse().getWriter();
    }

    @Override
    public void flush() throws IOException {
        if (getHttpServletResponse().isCommitted()) {
            getHttpServletResponse().flushBuffer();
        }
    }

    @Override
    public void redirect(String location) throws IOException {
        boolean proxyProtocolAware = Boolean.parseBoolean(activity.getSetting(PROXY_PROTOCOL_AWARE_SETTING_NAME));
        if (proxyProtocolAware) {
            location = SendRedirectBasedOnXForwardedProtocol.getLocation(activity.getTranslet(), location);
        }
        getHttpServletResponse().sendRedirect(location);
    }

    @Override
    public String redirect(RedirectRule redirectRule) throws IOException {
        String path = WebUtils.createRedirectPath(redirectRule, activity);
        String url = getHttpServletResponse().encodeRedirectURL(path);
        redirect(url);
        return path;
    }

    @Override
    public int getStatus() {
        return getHttpServletResponse().getStatus();
    }

    @Override
    public void setStatus(int status) {
        getHttpServletResponse().setStatus(status);
    }

    @Override
    public String transformPath(String path) {
        return getHttpServletResponse().encodeURL(path);
    }

    private HttpServletResponse getHttpServletResponse() {
        return getAdaptee();
    }

    private void precommit() throws IOException {
        if (!precommitDone) {
            precommitDone = true;
            Response response = activity.getDeclaredResponse();
            if (response instanceof TransformResponse transformResponse) {
                FormatType formatType = transformResponse.getFormatType();
                if (formatType == null) {
                    try {
                        response.commit(activity);
                    } catch (ResponseException e) {
                        throw new IOException("Error during pre-commit", e);
                    }
                }
            }
        }
    }

}