javax.ws.rs.core.HttpHeaders Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2015 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.ws.rs.core;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Map;
/**
* An injectable interface that provides access to HTTP header information.
* All methods throw {@link java.lang.IllegalStateException} if called outside the
* scope of a request (e.g. from a provider constructor).
*
* @author Paul Sandoz
* @author Marc Hadley
* @see Context
* @since 1.0
*/
public interface HttpHeaders {
/**
* Get the values of a HTTP request header. The returned List is read-only.
* This is a shortcut for {@code getRequestHeaders().get(name)}.
*
* @param name the header name, case insensitive.
* @return a read-only list of header values.
* @throws java.lang.IllegalStateException
* if called outside the scope of a request.
*/
public List getRequestHeader(String name);
/**
* Get a HTTP header as a single string value.
*
* Each single header value is converted to String using a
* {@link javax.ws.rs.ext.RuntimeDelegate.HeaderDelegate} if one is available
* via {@link javax.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class)}
* for the header value class or using its {@code toString} method if a header
* delegate is not available.
*
* @param name the HTTP header.
* @return the HTTP header value. If the HTTP header is not present then
* {@code null} is returned. If the HTTP header is present but has no
* value then the empty string is returned. If the HTTP header is present
* more than once then the values of joined together and separated by a ','
* character.
* @see #getRequestHeader(java.lang.String)
* @since 2.0
*/
public String getHeaderString(String name);
/**
* Get the values of HTTP request headers. The returned Map is case-insensitive
* wrt. keys and is read-only. The method never returns {@code null}.
*
* @return a read-only map of header names and values.
* @throws java.lang.IllegalStateException
* if called outside the scope of a request.
*/
public MultivaluedMap getRequestHeaders();
/**
* Get a list of media types that are acceptable for the response.
*
* If no acceptable media types are specified, a read-only list containing
* a single {@link javax.ws.rs.core.MediaType#WILDCARD_TYPE wildcard media type}
* instance is returned.
*
* @return a read-only list of requested response media types sorted according
* to their q-value, with highest preference first.
* @throws java.lang.IllegalStateException
* if called outside the scope of a request.
*/
public List getAcceptableMediaTypes();
/**
* Get a list of languages that are acceptable for the response.
*
* If no acceptable languages are specified, a read-only list containing
* a single wildcard {@link java.util.Locale} instance (with language field
* set to "{@code *}") is returned.
*
* @return a read-only list of acceptable languages sorted according
* to their q-value, with highest preference first.
* @throws java.lang.IllegalStateException
* if called outside the scope of a request.
*/
public List getAcceptableLanguages();
/**
* Get the media type of the request entity.
*
* @return the media type or {@code null} if there is no request entity.
* @throws java.lang.IllegalStateException
* if called outside the scope of a request.
*/
public MediaType getMediaType();
/**
* Get the language of the request entity.
*
* @return the language of the entity or {@code null} if not specified.
* @throws java.lang.IllegalStateException
* if called outside the scope of a request.
*/
public Locale getLanguage();
/**
* Get any cookies that accompanied the request.
*
* @return a read-only map of cookie name (String) to Cookie.
* @throws java.lang.IllegalStateException
* if called outside the scope of a request
*/
public Map getCookies();
/**
* Get message date.
*
* @return the message date, otherwise {@code null} if not present.
* @since 2.0
*/
public Date getDate();
/**
* Get Content-Length value.
*
* @return Content-Length as integer if present and valid number. In other
* cases returns -1.
* @since 2.0
*/
public int getLength();
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String ACCEPT = "Accept";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String ACCEPT_CHARSET = "Accept-Charset";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String ACCEPT_ENCODING = "Accept-Encoding";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String ACCEPT_LANGUAGE = "Accept-Language";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String ALLOW = "Allow";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String AUTHORIZATION = "Authorization";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String CACHE_CONTROL = "Cache-Control";
/**
* See {@link IETF RFC-2183}.
*/
public static final String CONTENT_DISPOSITION = "Content-Disposition";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String CONTENT_ENCODING = "Content-Encoding";
/**
* See {@link IETF RFC-2392}.
*/
public static final String CONTENT_ID = "Content-ID";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String CONTENT_LANGUAGE = "Content-Language";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String CONTENT_LENGTH = "Content-Length";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String CONTENT_LOCATION = "Content-Location";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String CONTENT_TYPE = "Content-Type";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String DATE = "Date";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String ETAG = "ETag";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String EXPIRES = "Expires";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String HOST = "Host";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String IF_MATCH = "If-Match";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String IF_MODIFIED_SINCE = "If-Modified-Since";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String IF_NONE_MATCH = "If-None-Match";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String IF_UNMODIFIED_SINCE = "If-Unmodified-Since";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String LAST_MODIFIED = "Last-Modified";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String LOCATION = "Location";
/**
* See {@link Web Linking (IETF RFC-5988) documentation}.
*/
public static final String LINK = "Link";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String RETRY_AFTER = "Retry-After";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String USER_AGENT = "User-Agent";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String VARY = "Vary";
/**
* See {@link HTTP/1.1 documentation}.
*/
public static final String WWW_AUTHENTICATE = "WWW-Authenticate";
/**
* See {@link IETF RFC 2109}.
*/
public static final String COOKIE = "Cookie";
/**
* See {@link IETF RFC 2109}.
*/
public static final String SET_COOKIE = "Set-Cookie";
/**
* {@code "Last-Event-ID"} HTTP request header name as defined by
* SSE specification.
*
* @since 2.1
*/
public static final String LAST_EVENT_ID_HEADER = "Last-Event-ID";
}