io.inverno.mod.http.server.internal.InternalResponseHeaders Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 Jeremy KUHN
 *
 * 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.
 */
package io.inverno.mod.http.server.internal;

import io.inverno.mod.http.base.OutboundResponseHeaders;
import java.util.List;
import java.util.Map;

/**
 * 
 * Base internal response headers.
 * 
 * 
 * @author Jeremy Kuhn
 * @since 1.0
 */
public interface InternalResponseHeaders extends OutboundResponseHeaders {
	
	/**
	 * 
	 * Defines whether headers have been sent to the client.
	 * 
	 *
	 * @param written true to indicates the headers have been written, false otherwise
	 */
	void setWritten(boolean written);

	/**
	 * 
	 * Returns the content type header field value as a char sequence.
	 * 
	 * 
	 * @return the content type header field value or null
	 */
	CharSequence getContentTypeCharSequence();
	
	/**
	 * 
	 * Returns the value of the header with the specified name as a char sequence.
	 * 
	 * 
	 * @param name the header name
	 * 
	 * @return the header value or null if there's no header with the specified name
	 */
	CharSequence getCharSequence(CharSequence name);
	
	/**
	 * 
	 * Returns the values of all headers with the specified name as char sequences.
	 * 
	 *
	 * @param name a header name
	 *
	 * @return a list of header values or an empty list if there's no header with the specified name
	 */
	List getAllCharSequence(CharSequence name);

	/**
	 * 
	 * Returns all headers.
	 * 
	 * 
	 * @return a list of header entries or an empty list if there's no header
	 */
	List> getAllCharSequence();
}