package org.jboss.resteasy.spi;

import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MultivaluedMap;
import java.io.InputStream;
import java.net.URI;
import java.util.Enumeration;

Bridge interface between the base Resteasy JAX-RS implementation and the actual HTTP transport (i.e. a servlet container)
Author:Bill Burke
Version:$Revision: 1 $
/** * Bridge interface between the base Resteasy JAX-RS implementation and the actual HTTP transport (i.e. a servlet container) * * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a> * @version $Revision: 1 $ */
public interface HttpRequest { HttpHeaders getHttpHeaders(); MultivaluedMap<String, String> getMutableHeaders(); InputStream getInputStream();
If you are using a servlet container, this will *NOT* override the HttpServletRequest.getInputStream(). It will only override it for the resteasy HttpRequest
Params:
  • stream – input stream
/** * If you are using a servlet container, this will *NOT* override the HttpServletRequest.getInputStream(). * It will only override it for the resteasy HttpRequest * * @param stream input stream */
void setInputStream(InputStream stream);
This method *MUST* always return the same instance.
Returns:uri info
/** * This method *MUST* always return the same instance. * @return uri info */
ResteasyUriInfo getUri(); String getHttpMethod(); void setHttpMethod(String method);
Updates the object returned by getUri().
Params:
  • requestUri – request uri
/** * Updates the object returned by {@link #getUri()}. * @param requestUri request uri */
void setRequestUri(URI requestUri) throws IllegalStateException;
Updates the object returned by getUri().
Params:
  • baseUri – base uri
  • requestUri – request uri
/** * Updates the object returned by {@link #getUri()}. * @param baseUri base uri * @param requestUri request uri */
void setRequestUri(URI baseUri, URI requestUri) throws IllegalStateException;
application/x-www-form-urlencoded parameters

This is here because @FormParam needs it and for when there are servlet filters that eat up the input stream

Returns:null if no parameters, this is encoded map
/** * application/x-www-form-urlencoded parameters * <p> * This is here because @FormParam needs it and for when there are servlet filters that eat up the input stream * * @return null if no parameters, this is encoded map */
MultivaluedMap<String, String> getFormParameters(); MultivaluedMap<String, String> getDecodedFormParameters();
Map of contextual data. Similar to HttpServletRequest attributes
Params:
  • attribute – attribute name
Returns:attribute
/** * Map of contextual data. Similar to HttpServletRequest attributes * @param attribute attribute name * @return attribute */
Object getAttribute(String attribute); void setAttribute(String name, Object value); void removeAttribute(String name); Enumeration<String> getAttributeNames(); ResteasyAsynchronousContext getAsyncContext(); boolean isInitial(); void forward(String path); boolean wasForwarded(); }