com.sun.jersey.server.impl.model
Class HttpHelper

java.lang.Object
  extended by com.sun.jersey.server.impl.model.HttpHelper

public final class HttpHelper
extends Object

Helper classes for HTTP.

Author:
Paul.Sandoz@Sun.Com

Constructor Summary
HttpHelper()
           
 
Method Summary
static List<AcceptableMediaType> getAccept(HttpRequestContext request)
          Get the list of Media type from the "Accept" of an HTTP request.
static List<AcceptableMediaType> getAccept(HttpRequestContext request, List<QualitySourceMediaType> priorityMediaTypes)
           
static List<AcceptableToken> getAcceptCharset(HttpRequestContext request)
          Get the list of language tag from the "Accept-Charset" of an HTTP request.
static List<AcceptableToken> getAcceptEncoding(HttpRequestContext request)
          Get the list of language tag from the "Accept-Charset" of an HTTP request.
static List<AcceptableLanguageTag> getAcceptLangauge(HttpRequestContext request)
          Deprecated. see getAcceptLanguage(com.sun.jersey.api.core.HttpRequestContext).
static List<AcceptableLanguageTag> getAcceptLanguage(HttpRequestContext request)
          Get the list of language tag from the "Accept-Language" of an HTTP request.
static Locale getContentLanguageAsLocale(HttpRequestContext request)
          Get the content language as a Locale instance.
static MediaType getContentType(HttpRequestContext request)
          Get the content type from the "Content-Type" of an HTTP request.
static MediaType getContentType(Object contentType)
          Get the content type from an Object.
static MediaType getContentType(String contentTypeString)
          Get the content type from a String.
static Set<MatchingEntityTag> getIfMatch(HttpRequestContext request)
           
static Set<MatchingEntityTag> getIfNoneMatch(HttpRequestContext request)
           
static Locale getLanguageTagAsLocale(String language)
           
static boolean produces(MediaType contentType, List<MediaType> accept)
          Ascertain if an entity of a specific Media type is capable of being produced from a list of Media type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HttpHelper

public HttpHelper()
Method Detail

getContentType

public static MediaType getContentType(HttpRequestContext request)
Get the content type from the "Content-Type" of an HTTP request.

Parameters:
request - The HTTP request.
Returns:
The content type. If no "Content-Type is present then null is returned.

getContentType

public static MediaType getContentType(String contentTypeString)
Get the content type from a String.

Parameters:
contentTypeString - the content type as a String.
Returns:
The content type. If no "Content-Type is present then null is returned.

getContentType

public static MediaType getContentType(Object contentType)
Get the content type from an Object.

Parameters:
contentType - the content type as an Object.
Returns:
The content type. If no "Content-Type is present then null is returned.

getContentLanguageAsLocale

public static Locale getContentLanguageAsLocale(HttpRequestContext request)
Get the content language as a Locale instance.

Parameters:
request - The HTTP request.
Returns:
the content lanuage as a locale instance.

getLanguageTagAsLocale

public static Locale getLanguageTagAsLocale(String language)

getIfMatch

public static Set<MatchingEntityTag> getIfMatch(HttpRequestContext request)

getIfNoneMatch

public static Set<MatchingEntityTag> getIfNoneMatch(HttpRequestContext request)

getAccept

public static List<AcceptableMediaType> getAccept(HttpRequestContext request)
Get the list of Media type from the "Accept" of an HTTP request.

Parameters:
request - The HTTP request.
Returns:
The list of MediaType. This list is ordered with the highest quality acceptable Media type occuring first (see MediaTypes#ACCEPT_MEDIA_TYPE_COMPARATOR). If no "Accept" is present then a list with a single item of the Media type "\*\/*" is returned.

getAccept

public static List<AcceptableMediaType> getAccept(HttpRequestContext request,
                                                  List<QualitySourceMediaType> priorityMediaTypes)

getAcceptLangauge

@Deprecated
public static List<AcceptableLanguageTag> getAcceptLangauge(HttpRequestContext request)
Deprecated. see getAcceptLanguage(com.sun.jersey.api.core.HttpRequestContext).

Get the list of language tag from the "Accept-Language" of an HTTP request.

Parameters:
request - The HTTP request.
Returns:
The list of LanguageTag. This list is ordered with the highest quality acceptable language tag occuring first.

getAcceptLanguage

public static List<AcceptableLanguageTag> getAcceptLanguage(HttpRequestContext request)
Get the list of language tag from the "Accept-Language" of an HTTP request.

Parameters:
request - The HTTP request.
Returns:
The list of LanguageTag. This list is ordered with the highest quality acceptable language tag occuring first.

getAcceptCharset

public static List<AcceptableToken> getAcceptCharset(HttpRequestContext request)
Get the list of language tag from the "Accept-Charset" of an HTTP request.

Parameters:
request - The HTTP request.
Returns:
The list of AcceptableToken. This list is ordered with the highest quality acceptable charset occuring first.

getAcceptEncoding

public static List<AcceptableToken> getAcceptEncoding(HttpRequestContext request)
Get the list of language tag from the "Accept-Charset" of an HTTP request.

Parameters:
request - The HTTP request.
Returns:
The list of AcceptableToken. This list is ordered with the highest quality acceptable charset occuring first.

produces

public static boolean produces(MediaType contentType,
                               List<MediaType> accept)
Ascertain if an entity of a specific Media type is capable of being produced from a list of Media type.

Parameters:
contentType - The Media type.
accept - The list of Media types of entities that may be produced. This list MUST be ordered with the highest quality acceptable Media type occuring first (see MediaTypes#ACCEPT_MEDIA_TYPE_COMPARATOR).
Returns:
true if the Media type can be produced, otherwise false.


Copyright © 2013 Oracle Corporation. All Rights Reserved.