com.wl4g.infra.common.remoting.AbstractClientHttpRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of infra-common Show documentation
A Infra Common.
The newest version!
/*
 * Copyright 2017 ~ 2025 the original author or authors. James Wong 
 *
 * 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.wl4g.infra.common.remoting;

import java.io.IOException;
import java.io.OutputStream;

import com.wl4g.infra.common.lang.Assert2;
import com.wl4g.infra.common.remoting.standard.HttpHeaders;

/**
 * Abstract base for {@link ClientHttpRequest} that makes sure that headers and
 * body are not written multiple times.
 */
public abstract class AbstractClientHttpRequest implements ClientHttpRequest {

    private final HttpHeaders headers = new HttpHeaders();

    private boolean executed = false;

    @Override
    public final HttpHeaders getHeaders() {
        return (this.executed ? HttpHeaders.readOnlyHttpHeaders(this.headers) : this.headers);
    }

    @Override
    public final OutputStream getBody() throws IOException {
        Assert2NotExecuted();
        return getBodyInternal(this.headers);
    }

    @Override
    public final ClientHttpResponse execute() throws IOException {
        Assert2NotExecuted();
        ClientHttpResponse result = executeInternal(this.headers);
        this.executed = true;
        return result;
    }

    /**
     * Assert2 that this request has not been {@linkplain #execute() executed}
     * yet.
     * 
     * @throws IllegalStateException
     *             if this request has been executed
     */
    protected void Assert2NotExecuted() {
        Assert2.state(!this.executed, "ClientHttpRequest already executed");
    }

    /**
     * Abstract template method that returns the body.
     * 
     * @param headers
     *            the HTTP headers
     * @return the body output stream
     */
    protected abstract OutputStream getBodyInternal(HttpHeaders headers) throws IOException;

    /**
     * Abstract template method that writes the given headers and content to the
     * HTTP request.
     * 
     * @param headers
     *            the HTTP headers
     * @return the response object for the executed request
     */
    protected abstract ClientHttpResponse executeInternal(HttpHeaders headers) throws IOException;

}