com.yahoo.application.container.handler.Request Maven / Gradle / Ivy

Go to download
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.application.container.handler;

import com.yahoo.api.annotations.Beta;

import java.net.SocketAddress;
import java.nio.charset.StandardCharsets;
import java.security.Principal;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;

/**
 * A request for use with {@link com.yahoo.application.container.JDisc#handleRequest(Request)}.
 *
 * @author Einar M R Rosenvinge
 * @see Response
 */
@Beta
public class Request {

    private final Headers headers = new Headers();
    private final String uri;
    private final byte[] body;
    private final Method method;
    private final Map attributes = new ConcurrentHashMap<>();
    private final Principal userPrincipal;
    private final SocketAddress remoteAddress;

    /**
     * Creates a Request with an empty body.
     *
     * @param uri the URI of the request
     */
    public Request(String uri) {
        this(uri, new byte[0]);
    }

    /**
     * Creates a GET Request with a message body.
     *
     * @param uri the URI of the request
     * @param body the body of the request
     */
    public Request(String uri, byte[] body) {
        this(uri, body, Method.GET);
    }

    /**
     * Creates a GET Request with a message body.
     *
     * @param uri the URI of the request
     * @param body the body of the request as a UTF-8 string
     */
    public Request(String uri, String body) {
        this(uri, body.getBytes(StandardCharsets.UTF_8), Method.GET);
    }

    /**
     * Creates a Request with a message body.
     *
     * @param uri the URI of the request
     * @param body the body of the request
     */
    public Request(String uri, byte[] body, Method method) {
        this(uri, body, method, null);
    }

    /**
     * Creates a Request with a message body, method and user principal.
     *
     * @param uri the URI of the request
     * @param body the body of the request
     * @param method the method of the request
     * @param principal the user principal of the request
     */
    public Request(String uri, byte[] body, Method method, Principal principal) {
        this(uri, body, method, principal, null);
    }

    /**
     * Creates a Request with a message body, method and user principal.
     *
     * @param uri the URI of the request
     * @param body the body of the request
     * @param method the method of the request
     * @param principal the user principal of the request
     * @param remoteAddress the remote address of the request
     */
    public Request(String uri, byte[] body, Method method, Principal principal, SocketAddress remoteAddress) {
        this.uri = uri;
        this.body = body;
        this.method = method;
        this.userPrincipal = principal;
        this.remoteAddress = remoteAddress;
    }

    /**
     * Creates a Request with a message body.
     *
     * @param uri the URI of the request
     * @param body the body of the request as a UTF-8 string
     */
    public Request(String uri, String body, Method method) {
        this(uri, body.getBytes(StandardCharsets.UTF_8), method);
    }
    /**
     * Returns a mutable multi-map of headers for this Request.
     *
     * @return a mutable multi-map of headers for this Request
     */
    public Headers getHeaders() {
        return headers;
    }

    /**
     * Returns the body of this Request.
     *
     * @return the body of this Request
     */
    public byte[] getBody() {
        return body;
    }

    /**
     * Returns the URI of this Request.
     *
     * @return the URI of this Request
     */
    public String getUri() {
        return uri;
    }

    /**
     * @return a mutable attribute map for this request.
     */
    public Map getAttributes() {
        return attributes;
    }

    public Optional remoteAddress() { return Optional.ofNullable(remoteAddress); }

    @Override
    public String toString() {
        String bodyStr = (body == null || body.length == 0) ? "[empty]" : "[omitted]";
        return "Request to " + uri + ", headers: " + headers + ", body: " + bodyStr;
    }

    public Method getMethod() {
        return method;
    }

    public Optional getUserPrincipal() {
        return Optional.ofNullable(userPrincipal);
    }

    public enum Method {
        OPTIONS,
        GET,
        HEAD,
        POST,
        PUT,
        PATCH,
        DELETE,
        TRACE,
        CONNECT
    }

}