|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.ws.rest.spi.container.AbstractContainerRequest
public abstract class AbstractContainerRequest
An abstract implementation of ContainerRequest
.
Specific containers may extend this class and instances may be passed to
the runtime using the method WebApplication.handleRequest(com.sun.ws.rest.spi.container.ContainerRequest, com.sun.ws.rest.spi.container.ContainerResponse)
.
The following are required by a concrete implementation when constructed or before the instance is passed to the runtime.
getRequestHeaders()
and copying the container specific headers
to the returned MultivaluedMap
instance.
Field Summary | |
---|---|
protected java.net.URI |
baseUri
The base URI of the request. |
protected java.net.URI |
completeUri
The complete URI of a request, including the query and fragment components (if any). |
Fields inherited from interface javax.ws.rs.core.SecurityContext |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary | |
---|---|
protected |
AbstractContainerRequest(MessageBodyContext bodyContext,
java.lang.String method,
java.io.InputStream entity)
|
Method Summary | ||
---|---|---|
javax.ws.rs.core.Response.ResponseBuilder |
evaluatePreconditions(java.util.Date lastModified)
|
|
javax.ws.rs.core.Response.ResponseBuilder |
evaluatePreconditions(java.util.Date lastModified,
javax.ws.rs.core.EntityTag eTag)
|
|
javax.ws.rs.core.Response.ResponseBuilder |
evaluatePreconditions(javax.ws.rs.core.EntityTag eTag)
|
|
java.net.URI |
getAbsolutePath()
Get the absolute path URI of the request. |
|
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. |
|
java.util.List<javax.ws.rs.core.MediaType> |
getAcceptableMediaTypes()
|
|
java.lang.String |
getAuthenticationScheme()
|
|
java.net.URI |
getBaseUri()
Get the base URI of the request. |
|
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> |
getCookieNameValueMap()
Get the cookie name value map. |
|
java.util.Map<java.lang.String,javax.ws.rs.core.Cookie> |
getCookies()
|
|
|
getEntity(java.lang.Class<T> type)
Get the request entity, returns null if the request does not contain an entity body. |
|
|
getEntity(java.lang.Class<T> type,
java.lang.reflect.Type genericType,
java.lang.annotation.Annotation[] as)
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 |
|
java.lang.String |
getLanguage()
|
|
javax.ws.rs.core.MediaType |
getMediaType()
|
|
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> |
getRequestHeaders()
|
|
java.net.URI |
getRequestUri()
Get the (complete) request URI. |
|
java.security.Principal |
getUserPrincipal()
|
|
boolean |
isSecure()
|
|
boolean |
isUserInRole(java.lang.String role)
|
|
javax.ws.rs.core.Variant |
selectVariant(java.util.List<javax.ws.rs.core.Variant> variants)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.net.URI baseUri
The scheme, user info, host and port components must be equivalent to the same componnents of the complete URI. The base URI must not contain the query and fragment components. The encoded path component of the complete URI must start with the encoded path component of the base URI. The encoded path component must end in a '/' character.
protected java.net.URI completeUri
Constructor Detail |
---|
protected AbstractContainerRequest(MessageBodyContext bodyContext, java.lang.String method, java.io.InputStream entity)
bodyContext
- the message body contextmethod
- the HTTP methodentity
- the InputStream of the request entityMethod Detail |
---|
public java.net.URI getBaseUri()
HttpRequestContext
getBaseUri
in interface HttpRequestContext
public java.net.URI getRequestUri()
HttpRequestContext
getRequestUri
in interface HttpRequestContext
public java.net.URI getAbsolutePath()
HttpRequestContext
getAbsolutePath
in interface HttpRequestContext
public java.lang.String getHeaderValue(java.lang.String name)
HttpRequestContext
getHeaderValue
in interface HttpRequestContext
name
- the HTTP header
public <T> T getEntity(java.lang.Class<T> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] as)
HttpRequestContext
getEntity
in interface HttpRequestContext
type
- the type of entityas
- the annoations associated with the type
public <T> T getEntity(java.lang.Class<T> type)
HttpRequestContext
getEntity
in interface HttpRequestContext
type
- the type of entity
public java.lang.String getHttpMethod()
HttpRequestContext
getHttpMethod
in interface HttpRequestContext
public javax.ws.rs.core.MediaType getAcceptableMediaType(java.util.List<javax.ws.rs.core.MediaType> mediaTypes)
HttpRequestContext
getAcceptableMediaType
in interface HttpRequestContext
mediaTypes
- the list of media types
public javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> getCookieNameValueMap()
HttpRequestContext
getCookieNameValueMap
in interface HttpRequestContext
public javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> getRequestHeaders()
getRequestHeaders
in interface javax.ws.rs.core.HttpHeaders
public java.util.List<javax.ws.rs.core.MediaType> getAcceptableMediaTypes()
getAcceptableMediaTypes
in interface javax.ws.rs.core.HttpHeaders
public javax.ws.rs.core.MediaType getMediaType()
getMediaType
in interface javax.ws.rs.core.HttpHeaders
public java.lang.String getLanguage()
getLanguage
in interface javax.ws.rs.core.HttpHeaders
public java.util.Map<java.lang.String,javax.ws.rs.core.Cookie> getCookies()
getCookies
in interface javax.ws.rs.core.HttpHeaders
public javax.ws.rs.core.Variant selectVariant(java.util.List<javax.ws.rs.core.Variant> variants)
selectVariant
in interface javax.ws.rs.core.Request
public javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions(javax.ws.rs.core.EntityTag eTag)
evaluatePreconditions
in interface javax.ws.rs.core.Request
public javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions(java.util.Date lastModified)
evaluatePreconditions
in interface javax.ws.rs.core.Request
public javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions(java.util.Date lastModified, javax.ws.rs.core.EntityTag eTag)
evaluatePreconditions
in interface javax.ws.rs.core.Request
public java.security.Principal getUserPrincipal()
getUserPrincipal
in interface javax.ws.rs.core.SecurityContext
public boolean isUserInRole(java.lang.String role)
isUserInRole
in interface javax.ws.rs.core.SecurityContext
public boolean isSecure()
isSecure
in interface javax.ws.rs.core.SecurityContext
public java.lang.String getAuthenticationScheme()
getAuthenticationScheme
in interface javax.ws.rs.core.SecurityContext
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |