net.javapla.jawn.core.Context Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jawn-core Show documentation
java-web-planet / jawn - A simple web framework in Java
The newest version!
package net.javapla.jawn.core;

import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.lang.reflect.Type;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;

import net.javapla.jawn.core.util.MultiList;
import net.javapla.jawn.core.util.PrintJournalist;

public interface Context {
    
    
    // Often used headers
    static final String ACCEPT = "Accept";
    static final String LOCATION = "Location";
    
    interface Request {
        HttpMethod httpMethod();
        String path();
        String address();
        String queryString();
        Value queryParam(String name); // URLDecoded
        
        Value header(String name);
        MultiList headers();
        Value pathParam(String name);
        Value cookie(String name);
        Map cookies();
        
        default boolean isPreflight() {
            return httpMethod() == HttpMethod.OPTIONS && header("Access-Control-Request-Method").isMissing();
        }
        
        default boolean accept(MediaType contentType) {
            Value accept = header(ACCEPT);
            if (accept.isMissing()) {
                return false;
            }
            return Objects.equals(contentType, MediaType.valueOf(accept.value()));
        }
        
        long contentLength();
        default MediaType contentType() {
            Value header = header("Content-Type");
            return header.isMissing() ? null : MediaType.valueOf(header.value());
        }
        
        
        MultiList multipart();
        default MultiList form() {
            return multipart();
        }
        
        Body body();
         T parse(Type type);
        
        void upgrade(WebSocket.Initialiser init);
        
    }
    
    interface Response {
        static final String STANDARD_HEADER_CONTENT_TYPE = MediaType.TEXT.value() + ";charset=" + StandardCharsets.UTF_8.name();
        
        Value header(String name);
        Response header(String name, String value);
        Response removeHeader(String name);
        Response cookie(Cookie cookie);
        
        MediaType contentType();
        Response contentType(MediaType type);
        Response rendererContentType(MediaType type);
        Response charset(Charset encoding);
        Charset charset();
        
        
        
        Response status(int statusCode);
        int status();
        default Response status(Status status) {
            return status(status.value());
        }
        
        /**
         * 301 Moved Permanently
         * @see Status.MOVED_PERMANENTLY
         * @param location
         */
        default Response redirectPermanently(String location) {
            header(LOCATION, location).respond(Status.MOVED_PERMANENTLY);
            return this;
        }
        /**
         * 302 Found
         * @see Status.FOUND
         * @param location
         */
        default Response redirectFound(String location) {
            header(LOCATION, location).respond(Status.FOUND);
            return this;
        }
        /**
         * 303 See Other
         * @see Status.SEE_OTHER
         * @param location
         */
        default Response redirectSeeOther(String location) {
            header(LOCATION, location).respond(Status.SEE_OTHER);
            return this;
        }
        /**
         * 307 Temporary Redirect
         * @see Status.TEMPORARY_REDIRECT
         * @param location
         * @return 
         */
        default Response redirectTemporary(String location) {
            header(LOCATION, location).respond(Status.TEMPORARY_REDIRECT);
            return this;
        }
        
        OutputStream stream();
        default PrintWriter writer(/*MediaType type, Charset charset*/) {
            //return new PrintWriter(new OutputStreamWriter(stream(), charset()));
            return new PrintWriter(new PrintJournalist(stream(), charset()));
        }
        
        /**
         * This is a terminal operation
         * @param status
         */
        Response respond(Status status);
        
        /**
         * This is a terminal operation
         * @param data
         */
        Response respond(ByteBuffer data);
        
        /**
         * This is a terminal operation
         * @param stream
         */
        Response respond(InputStream stream);
        
        /**
         * This is a terminal operation
         * @param channel
         */
        Response respond(FileChannel channel);
        
        /**
         * This is a terminal operation
         * @param data
         */
        default Response respond(byte[] data) {
            return respond(ByteBuffer.wrap(data));
        }
        
        /**
         * This is a terminal operation
         * @param data
         */
        default Response respond(String data) {
            return respond(data.getBytes(charset()));
        }
        
        boolean isResponseStarted();
    }
    
    Request req();
    Response resp();
    
    
    // ** Attributes ** //
    Context attribute(final String name, final Object value);
    Optional