juneau-rest/juneau-rest-common/src/main/java/org/apache/juneau/http/BasicStatusLine.java

// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you 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 org.apache.juneau.http;

import static org.apache.juneau.internal.ObjectUtils.*;

import java.util.*;

import org.apache.http.*;
import org.apache.http.impl.*;
import org.apache.http.message.*;
import org.apache.juneau.http.BasicStatusLine;
import org.apache.juneau.internal.*;

/**
 * A basic implementation of the {@link StatusLine} interface.
 *
 * <h5 class='section'>See Also:</h5><ul>
 * 	<li class='link'><a class="doclink" href="../../../../index.html#juneau-rest-common">juneau-rest-common</a>
 * </ul>
 */
@FluentSetters
public class BasicStatusLine implements StatusLine {

	//-----------------------------------------------------------------------------------------------------------------
	// Static
	//-----------------------------------------------------------------------------------------------------------------

	/**
	 * Instantiates a new instance of this bean.
	 *
	 * @return A new bean.
	 */
	public static BasicStatusLine create() {
		return new BasicStatusLine();
	}

	/**
	 * Instantiates a new instance of this bean.
	 *
	 * @param statusCode The initial status code.
	 * @param reasonPhrase The initial reason phrase.
	 * @return A new bean.
	 */
	public static BasicStatusLine create(int statusCode, String reasonPhrase) {
		return new BasicStatusLine().setStatusCode(statusCode).setReasonPhrase(reasonPhrase);
	}

	//-----------------------------------------------------------------------------------------------------------------
	// Instance
	//-----------------------------------------------------------------------------------------------------------------

	private ProtocolVersion DEFAULT_PROTOCOL_VERSION = new ProtocolVersion("HTTP", 1, 1);

	private ProtocolVersion protocolVersion = DEFAULT_PROTOCOL_VERSION;
	private int statusCode = 0;
	private String reasonPhrase;
	private ReasonPhraseCatalog reasonPhraseCatalog;
	private Locale locale = Locale.getDefault();
	private boolean unmodifiable;

	/**
	 * Constructor.
	 */
	public BasicStatusLine() {
	}

	/**
	 * Copy constructor.
	 *
	 * @param copyFrom The status line being copied.
	 */
	protected BasicStatusLine(BasicStatusLine copyFrom) {
		this.protocolVersion = copyFrom.protocolVersion;
		this.statusCode = copyFrom.statusCode;
		this.reasonPhrase = copyFrom.reasonPhrase;
		this.locale = copyFrom.locale;
	}

	/**
	 * Returns a copy of this bean.
	 *
	 * @return A copy of this bean.
	 */
	public BasicStatusLine copy() {
		return new BasicStatusLine(this);
	}

	//-----------------------------------------------------------------------------------------------------------------
	// Properties
	//-----------------------------------------------------------------------------------------------------------------

	/**
	 * Specifies whether this bean should be unmodifiable.
	 * <p>
	 * When enabled, attempting to set any properties on this bean will cause an {@link UnsupportedOperationException}.
	 *
	 * @return This object.
	 */
	@FluentSetter
	public BasicStatusLine setUnmodifiable() {
		unmodifiable = true;
		return this;
	}

	/**
	 * Throws an {@link UnsupportedOperationException} if the unmodifiable flag is set on this bean.
	 */
	protected final void assertModifiable() {
		if (unmodifiable)
			throw new UnsupportedOperationException("Bean is read-only");
	}

	@Override /* StatusLine */
	public ProtocolVersion getProtocolVersion() {
		return protocolVersion;
	}

	/**
	 * Sets the protocol version on the status line.
	 *
	 * <p>
	 * If not specified, <js>"HTTP/1.1"</js> will be used.
	 *
	 * @param value The new value.
	 * @return This object.
	 */
	@FluentSetter
	public BasicStatusLine setProtocolVersion(ProtocolVersion value) {
		assertModifiable();
		this.protocolVersion = value;
		return this;
	}

	@Override /* StatusLine */
	public int getStatusCode() {
		return statusCode;
	}

	/**
	 * Sets the status code on the status line.
	 *
	 * <p>
	 * If not specified, <c>0</c> will be used.
	 *
	 * @param value The new value.
	 * @return This object.
	 */
	@FluentSetter
	public BasicStatusLine setStatusCode(int value) {
		assertModifiable();
		this.statusCode = value;
		return this;
	}

	@Override /* StatusLine */
	public String getReasonPhrase() {
		if (reasonPhrase == null) {
			ReasonPhraseCatalog rfc = firstNonNull(reasonPhraseCatalog, EnglishReasonPhraseCatalog.INSTANCE);
			return rfc.getReason(statusCode, locale);
		}
		return reasonPhrase;
	}

	/**
	 * Sets the reason phrase on the status line.
	 *
	 * <p>
	 * If not specified, the reason phrase will be retrieved from the reason phrase catalog
	 * using the locale on this bean.
	 *
	 * @param value The new value.
	 * @return This object.
	 */
	@FluentSetter
	public BasicStatusLine setReasonPhrase(String value) {
		assertModifiable();
		this.reasonPhrase = value;
		return this;
	}

	/**
	 * Sets the reason phrase catalog used to retrieve reason phrases.
	 *
	 * <p>
	 * If not specified, uses {@link EnglishReasonPhraseCatalog}.
	 *
	 * @param value The new value.
	 * @return This object.
	 */
	@FluentSetter
	public BasicStatusLine setReasonPhraseCatalog(ReasonPhraseCatalog value) {
		assertModifiable();
		this.reasonPhraseCatalog = value;
		return this;
	}

	/**
	 * Returns the locale of this status line.
	 *
	 * @return The locale of this status line.
	 */
	public Locale getLocale() {
		return locale;
	}

	/**
	 * Sets the locale used to retrieve reason phrases.
	 *
	 * <p>
	 * If not specified, uses {@link Locale#getDefault()}.
	 *
	 * @param value The new value.
	 * @return This object.
	 */
	@FluentSetter
	public BasicStatusLine setLocale(Locale value) {
		assertModifiable();
		this.locale = value;
		return this;
	}

	@Override /* Object */
	public String toString() {
		return BasicLineFormatter.INSTANCE.formatStatusLine(null, this).toString();
	}

	// <FluentSetters>

	// </FluentSetters>
}