net.officefloor.server.http.impl.SerialisableHttpRequest Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * HTTP Server
 * %%
 * Copyright (C) 2005 - 2020 Daniel Sagenschneider
 * %%
 * 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.
 * #L%
 */

package net.officefloor.server.http.impl;

import java.io.Serializable;

import net.officefloor.server.http.HttpMethod;
import net.officefloor.server.http.HttpRequest;
import net.officefloor.server.http.HttpRequestCookies;
import net.officefloor.server.http.HttpRequestHeaders;
import net.officefloor.server.http.HttpVersion;
import net.officefloor.server.stream.ServerInputStream;
import net.officefloor.server.stream.impl.ByteArrayByteSequence;
import net.officefloor.server.stream.impl.ByteSequence;
import net.officefloor.server.stream.impl.ByteSequenceServerInputStream;

/**
 * {@link Serializable} {@link HttpRequest}.
 * 
 * @author Daniel Sagenschneider
 */
public class SerialisableHttpRequest implements HttpRequest, Serializable {

	/**
	 * {@link Serializable} version.
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * {@link HttpMethod}.
	 */
	private final HttpMethod method;

	/**
	 * Request URI.
	 */
	private final String requestUri;

	/**
	 * {@link HttpVersion}.
	 */
	private transient final HttpVersion version;

	/**
	 * {@link HttpRequestHeaders}.
	 */
	private final SerialisableHttpRequestHeaders headers;

	/**
	 * {@link HttpRequestCookies}.
	 */
	private transient final HttpRequestCookies cookies;

	/**
	 * {@link ByteArrayByteSequence} for the HTTP entity.
	 */
	private final ByteArrayByteSequence entity;

	/**
	 * {@link ByteSequenceServerInputStream}.
	 */
	private transient ByteSequenceServerInputStream entityStream;

	/**
	 * Instantiate from existing {@link HttpRequest}.
	 * 
	 * @param request
	 *            {@link HttpRequest}.
	 * @param cookies
	 *            {@link HttpRequestCookies}.
	 * @param entity
	 *            {@link ByteSequence} to entity of {@link HttpRequest}.
	 */
	public SerialisableHttpRequest(HttpRequest request, HttpRequestCookies cookies, ByteSequence entity) {
		this.method = request.getMethod();
		this.requestUri = request.getUri();
		this.version = request.getVersion();
		this.cookies = cookies;

		// Ensure have serializable headers
		HttpRequestHeaders headers = request.getHeaders();
		if (headers instanceof SerialisableHttpRequestHeaders) {
			// Use immutable serialisable instance
			this.headers = (SerialisableHttpRequestHeaders) headers;
		} else {
			// Create serialisable copy
			this.headers = new SerialisableHttpRequestHeaders(headers);
		}

		// Create the entity
		if (entity instanceof ByteArrayByteSequence) {
			// Use immutable serialisable instance
			this.entity = (ByteArrayByteSequence) entity;
		} else {
			// Create serialisable copy
			byte[] data = new byte[entity.length()];
			for (int i = 0; i < data.length; i++) {
				data[i] = entity.byteAt(i);
			}
			this.entity = new ByteArrayByteSequence(data);
		}

		// Create the stream
		this.entityStream = new ByteSequenceServerInputStream(this.entity, 0);
	}

	/**
	 * Instantiate.
	 * 
	 * @param method
	 *            {@link HttpMethod}.
	 * @param requestUri
	 *            Request URI.
	 * @param version
	 *            {@link HttpVersion}.
	 * @param headers
	 *            {@link SerialisableHttpRequestHeaders}.
	 * @param cookies
	 *            {@link HttpRequestCookies}.
	 * @param entity
	 *            {@link ByteArrayByteSequence} for the entity.
	 */
	public SerialisableHttpRequest(HttpMethod method, String requestUri, HttpVersion version,
			SerialisableHttpRequestHeaders headers, HttpRequestCookies cookies, ByteArrayByteSequence entity) {
		this.method = method;
		this.requestUri = requestUri;
		this.version = version;
		this.headers = headers;
		this.cookies = cookies;
		this.entity = entity;
		this.entityStream = new ByteSequenceServerInputStream(this.entity, 0);
	}

	/**
	 * Creates a {@link SerialisableHttpRequest} from this {@link Serializable}
	 * state.
	 * 
	 * @param clientHttpVersion
	 *            {@link HttpVersion} that the client is currently using.
	 * @param cookies
	 *            {@link HttpRequestCookies}.
	 * @return {@link SerialisableHttpRequest}.
	 */
	public SerialisableHttpRequest createHttpRequest(HttpVersion clientHttpVersion, HttpRequestCookies cookies) {
		return new SerialisableHttpRequest(this.method, this.requestUri, clientHttpVersion, this.headers, cookies,
				entity);
	}

	/**
	 * Obtains the {@link ByteSequence} for the entity.
	 * 
	 * @return {@link ByteSequence} for the entity.
	 */
	protected ByteSequence getEntityByteSequence() {
		return this.entity;
	}

	/*
	 * ================ HttpRequest =================
	 */

	@Override
	public HttpMethod getMethod() {
		return this.method;
	}

	@Override
	public String getUri() {
		return this.requestUri;
	}

	@Override
	public HttpVersion getVersion() {
		return this.version;
	}

	@Override
	public HttpRequestHeaders getHeaders() {
		return this.headers;
	}

	@Override
	public HttpRequestCookies getCookies() {
		return this.cookies;
	}

	@Override
	public ServerInputStream getEntity() {
		return this.entityStream;
	}

}