com.sun.ws.rest.api.core
Interface HttpRequestContext

All Superinterfaces:
javax.ws.rs.core.HttpHeaders, javax.ws.rs.core.Request, javax.ws.rs.core.SecurityContext, javax.ws.rs.core.UriInfo
All Known Subinterfaces:
ContainerRequest
All Known Implementing Classes:
AbstractContainerRequest

public interface HttpRequestContext
extends javax.ws.rs.core.HttpHeaders, javax.ws.rs.core.UriInfo, javax.ws.rs.core.Request, javax.ws.rs.core.SecurityContext

An abstraction for a HTTP request


Field Summary
 
Fields inherited from interface javax.ws.rs.core.SecurityContext
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Method Summary
 javax.ws.rs.core.MediaType getAcceptableMediaType(java.util.List<javax.ws.rs.core.MediaType> mediaTypes)
          Select the first media type, from a list of media types, that is most acceptable according to the requested acceptable media types.
<T> T
getEntity(java.lang.Class<T> type)
          Get the request entity, returns null if the request does not contain an entity body.
 java.lang.String getHeaderValue(java.lang.String name)
          Get a HTTP header value.
 java.lang.String getHttpMethod()
          Get the HTTP method name
 
Methods inherited from interface javax.ws.rs.core.HttpHeaders
getAcceptableMediaTypes, getCookies, getLanguage, getMediaType, getRequestHeaders
 
Methods inherited from interface javax.ws.rs.core.UriInfo
getAbsolutePath, getAbsolutePathBuilder, getBaseUri, getBaseUriBuilder, getPath, getPath, getPathSegments, getPathSegments, getQueryParameters, getQueryParameters, getRequestUri, getRequestUriBuilder, getTemplateParameters, getTemplateParameters
 
Methods inherited from interface javax.ws.rs.core.Request
evaluatePreconditions, evaluatePreconditions, evaluatePreconditions, selectVariant
 
Methods inherited from interface javax.ws.rs.core.SecurityContext
getAuthenticationScheme, getUserPrincipal, isSecure, isUserInRole
 

Method Detail

getHeaderValue

java.lang.String getHeaderValue(java.lang.String name)
Get a HTTP header value.

Parameters:
name - the HTTP header
Returns:
the HTTP header value. If the HTTP header is not present then 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.

getAcceptableMediaType

javax.ws.rs.core.MediaType getAcceptableMediaType(java.util.List<javax.ws.rs.core.MediaType> mediaTypes)
Select the first media type, from a list of media types, that is most acceptable according to the requested acceptable media types.

Parameters:
mediaTypes - the list of media types
Returns:
the most acceptable media type, or null if no media type was found to be acceptable.

getEntity

<T> T getEntity(java.lang.Class<T> type)
            throws java.lang.IllegalArgumentException
Get the request entity, returns null if the request does not contain an entity body.

Parameters:
type - the type of entity
Returns:
the request entity or null
Throws:
java.lang.IllegalArgumentException - if the content of the request cannot be mapped to an entity of the requested type

getHttpMethod

java.lang.String getHttpMethod()
Get the HTTP method name

Returns:
the method name as a String