FormEncodingProvider (Apache CXF Bundle Jar 2.6.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Apache CXF API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.jaxrs.provider
Class FormEncodingProvider<T>

java.lang.Object
  org.apache.cxf.jaxrs.provider.FormEncodingProvider<T>

All Implemented Interfaces:: javax.ws.rs.ext.MessageBodyReader<T>, javax.ws.rs.ext.MessageBodyWriter<T>

@Provider public class FormEncodingProvider<T>
extends Object
implements javax.ws.rs.ext.MessageBodyReader<T>, javax.ws.rs.ext.MessageBodyWriter<T>
extends Object
implements javax.ws.rs.ext.MessageBodyReader<T>, javax.ws.rs.ext.MessageBodyWriter<T>

Constructor Summary
`FormEncodingProvider()`

Method Summary
`protected javax.ws.rs.core.MultivaluedMap<String,String>`	`createMap(Class<?> clazz)`
`long`	`getSize(T t, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)`
`boolean`	`isReadable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mt)`
`boolean`	`isWriteable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mt)`
`protected boolean`	`keepEncoded(Annotation[] anns)`
`protected void`	`persistParamsOnMessage(javax.ws.rs.core.MultivaluedMap<String,String> params)`
`protected void`	`populateMap(javax.ws.rs.core.MultivaluedMap<String,String> params, Annotation[] anns, InputStream is, javax.ws.rs.core.MediaType mt, boolean decode)` Retrieve map of parameters from the passed in message
`T`	`readFrom(Class<T> clazz, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mt, javax.ws.rs.core.MultivaluedMap<String,String> headers, InputStream is)`
`void`	`setAttachmentDirectory(String dir)`
`void`	`setAttachmentMaxSize(String maxSize)`
`void`	`setAttachmentThreshold(String threshold)`
`void`	`setExpectedEncoded(boolean expect)`
`void`	`setValidator(FormValidator formValidator)`
`protected void`	`validateMap(javax.ws.rs.core.MultivaluedMap<String,String> params)`
`void`	`writeTo(T obj, Class<?> c, Type t, Annotation[] anns, javax.ws.rs.core.MediaType mt, javax.ws.rs.core.MultivaluedMap<String,Object> headers, OutputStream os)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

FormEncodingProvider

public FormEncodingProvider()

Method Detail

setExpectedEncoded

public void setExpectedEncoded(boolean expect)

setAttachmentDirectory

public void setAttachmentDirectory(String dir)

setAttachmentThreshold

public void setAttachmentThreshold(String threshold)

setAttachmentMaxSize

public void setAttachmentMaxSize(String maxSize)

setValidator

public void setValidator(FormValidator formValidator)

isReadable

public boolean isReadable(Class<?> type,
                          Type genericType,
                          Annotation[] annotations,
                          javax.ws.rs.core.MediaType mt)

Specified by:: isReadable in interface javax.ws.rs.ext.MessageBodyReader<T>

readFrom

public T readFrom(Class<T> clazz,
                  Type genericType,
                  Annotation[] annotations,
                  javax.ws.rs.core.MediaType mt,
                  javax.ws.rs.core.MultivaluedMap<String,String> headers,
                  InputStream is)
           throws IOException

Specified by:: readFrom in interface javax.ws.rs.ext.MessageBodyReader<T>

Throws:: IOException

keepEncoded

protected boolean keepEncoded(Annotation[] anns)

persistParamsOnMessage

protected void persistParamsOnMessage(javax.ws.rs.core.MultivaluedMap<String,String> params)

createMap

protected javax.ws.rs.core.MultivaluedMap<String,String> createMap(Class<?> clazz)
                                                            throws Exception

Throws:: Exception

populateMap

protected void populateMap(javax.ws.rs.core.MultivaluedMap<String,String> params,
                           Annotation[] anns,
                           InputStream is,
                           javax.ws.rs.core.MediaType mt,
                           boolean decode)

Retrieve map of parameters from the passed in message

Parameters:: message -

validateMap

protected void validateMap(javax.ws.rs.core.MultivaluedMap<String,String> params)

getSize

public long getSize(T t,
                    Class<?> type,
                    Type genericType,
                    Annotation[] annotations,
                    javax.ws.rs.core.MediaType mediaType)

Specified by:: getSize in interface javax.ws.rs.ext.MessageBodyWriter<T>

isWriteable

public boolean isWriteable(Class<?> type,
                           Type genericType,
                           Annotation[] annotations,
                           javax.ws.rs.core.MediaType mt)

Specified by:: isWriteable in interface javax.ws.rs.ext.MessageBodyWriter<T>

writeTo

public void writeTo(T obj,
                    Class<?> c,
                    Type t,
                    Annotation[] anns,
                    javax.ws.rs.core.MediaType mt,
                    javax.ws.rs.core.MultivaluedMap<String,Object> headers,
                    OutputStream os)
             throws IOException,
                    javax.ws.rs.WebApplicationException

Specified by:: writeTo in interface javax.ws.rs.ext.MessageBodyWriter<T>

Throws:: IOException; javax.ws.rs.WebApplicationException