All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.restheart.exchange.UninitializedRequest Maven / Gradle / Ivy

There is a newer version: 8.1.4
Show newest version
/*-
 * ========================LICENSE_START=================================
 * restheart-commons
 * %%
 * Copyright (C) 2019 - 2024 SoftInstigate
 * %%
 * 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.
 * =========================LICENSE_END==================================
 */

package org.restheart.exchange;

import java.io.IOException;
import java.util.function.Consumer;

import org.restheart.utils.ChannelReader;

import io.undertow.server.HttpServerExchange;
import io.undertow.util.AttachmentKey;

/**
 * UninitializedRequest wraps the exchage and provides access to
 * request attributes (such as getPath()) and allows
 * setting a customRequestInitializer
 *
 * The request content can be only accessed in raw format
 * with getRawContent() and setRawContent()
 *
 * Interceptors at intercePoint REQUEST_BEFORE_EXCHANGE_INIT
 * receive UninitializedRequest as request argument
 *
 */
public class UninitializedRequest extends ServiceRequest {
    static final AttachmentKey> CUSTOM_REQUEST_INITIALIZER_KEY = AttachmentKey.create(Consumer.class);

    private UninitializedRequest(HttpServerExchange exchange) {
        super(exchange, true);
    }

    public static UninitializedRequest of(HttpServerExchange exchange) {
        return new UninitializedRequest(exchange);
    }

    /**
     * throws IllegalStateException
     *
     * the content can only be retrieved in raw format, use getRawContent()
     * @return
     */
    @Override
    public Object getContent() {
        throw new IllegalStateException("the request is not initialized");
    }

    /**
     * throws IllegalStateException
     *
     * the content can only be set in raw format, use setRawContent()
     * @param content
     */
    @Override
    public void setContent(Object content) {
        throw new IllegalStateException("the request is not initialized");
    }

    /**
     *
     * @return the request body raw bytes
     */
    public byte[] getRawContent() {
        try {
            return ChannelReader.readBytes(wrapped);
        } catch (IOException e) {
            throw new IllegalStateException("error getting raw request content", e);
        }
    }

    /**
     * overwrite the request body raw bytes
     * make sense to invoke it before request initialization
     *
     * @param data
     * @throws java.io.IOException
     */
    public void setRawContent(byte[] data) throws IOException {
        ByteArrayProxyRequest.of(wrapped).writeContent(data);
    }

    /**
     * If a customRequestInitializer is set (not null), the ServiceExchangeInitializer will
     * delegate to customRequestInitializer.accept(exchange) the responsability to initialize the request
     *
     * @param customRequestInitializer
     */
    public void setCustomRequestInitializer(Consumer customRequestInitializer) {
        this.wrapped.putAttachment(CUSTOM_REQUEST_INITIALIZER_KEY, customRequestInitializer);
    }

    /**
     *
     * @return the custom Consumer used to initialize the request in place of the Service default one
     */
    public Consumer customRequestInitializer() {
        return this.wrapped.getAttachment(CUSTOM_REQUEST_INITIALIZER_KEY);
    }

    @Override
    public Object parseContent() throws IOException, BadRequestException {
        throw new IllegalStateException("the request is not initialized");
    }
}