org.jboss.resteasy.plugins.providers

Class ServerFormUrlEncodedProvider

java.lang.Object

org.jboss.resteasy.plugins.providers.FormUrlEncodedProvider

org.jboss.resteasy.plugins.providers.ServerFormUrlEncodedProvider

All Implemented Interfaces:

MessageBodyReader<MultivaluedMap>, MessageBodyWriter<MultivaluedMap>

@Produces(value="application/x-www-form-urlencoded")
@Consumes(value="application/x-www-form-urlencoded")
@ConstrainedTo(value=SERVER)
public class ServerFormUrlEncodedProvider
extends FormUrlEncodedProvider

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	useContainerParams

Constructor Summary

Constructors

Constructor and Description
ServerFormUrlEncodedProvider(boolean useContainerParams)

Method Summary

Methods

Modifier and Type	Method and Description
MultivaluedMap	readFrom(Class<MultivaluedMap> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,String> httpHeaders, InputStream entityStream) Read a type from the InputStream.

Methods inherited from class org.jboss.resteasy.plugins.providers.FormUrlEncodedProvider

getSize, isReadable, isWriteable, parseForm, writeTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

useContainerParams

protected boolean useContainerParams

Constructor Detail

ServerFormUrlEncodedProvider

public ServerFormUrlEncodedProvider(boolean useContainerParams)

Method Detail

readFrom

public MultivaluedMap readFrom(Class<MultivaluedMap> type,
                      Type genericType,
                      Annotation[] annotations,
                      MediaType mediaType,
                      MultivaluedMap<String,String> httpHeaders,
                      InputStream entityStream)
                        throws IOException

Description copied from interface: MessageBodyReader

Read a type from the InputStream.

In case the entity input stream is empty, the reader is expected to either return a Java representation of a zero-length entity or throw a NoContentException in case no zero-length entity representation is defined for the supported Java type. A NoContentException, if thrown by a message body reader while reading a server request entity, is automatically translated by JAX-RS server runtime into a BadRequestException wrapping the original NoContentException and rethrown for a standard processing by the registered exception mappers.

Specified by:

readFrom in interface MessageBodyReader<MultivaluedMap>

Overrides:

readFrom in class FormUrlEncodedProvider

Parameters:

type - the type that is to be read from the entity stream.

genericType - the type of instance to be produced. E.g. if the message body is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Method.getGenericParameterTypes.

annotations - an array of the annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Method.getParameterAnnotations.

mediaType - the media type of the HTTP entity.

httpHeaders - the read-only HTTP headers associated with HTTP entity.

entityStream - the InputStream of the HTTP entity. The caller is responsible for ensuring that the input stream ends when the entity has been consumed. The implementation should not close the input stream.

Returns:

the type that was read from the stream. In case the entity input stream is empty, the reader is expected to either return an instance representing a zero-length entity or throw a NoContentException in case no zero-length entity representation is defined for the supported Java type.

Throws:

IOException - if an IO error arises. In case the entity input stream is empty and the reader is not able to produce a Java representation for a zero-length entity, NoContentException is expected to be thrown.