org.jboss.resteasy.plugins.providers

Class SerializableProvider

java.lang.Object

org.jboss.resteasy.plugins.providers.SerializableProvider

All Implemented Interfaces:

javax.ws.rs.ext.MessageBodyReader<Serializable>, javax.ws.rs.ext.MessageBodyWriter<Serializable>, AsyncMessageBodyWriter<Serializable>

Deprecated.

@Provider
 @Produces(value="application/x-java-serialized-object")
 @Consumes(value="application/x-java-serialized-object")
 @Deprecated
public class SerializableProvider
extends Object
implements javax.ws.rs.ext.MessageBodyReader<Serializable>, AsyncMessageBodyWriter<Serializable>

MessageBodyReader+Writer for serialized java objects.

This Provider has been disabled by default because deserializing java objects from untrusted sources is unsafe. (See http://foxglovesecurity.com/2015/11/06/what-do-weblogic-websphere-jboss-jenkins-opennms-and-your-application-have-in-common-this-vulnerability/ or https://access.redhat.com/security/cve/cve-2015-7501). In case your application uses serialized objects and you trust your remote REST partners, then you may enable this provider:

• Either by providing a file "META-INF/services/javax.ws.rs.ext.Providers" with the fully qualified classname in classpath (See src/main/resources/ for an example. Multiple files in different jars are additive.)
• Or register() this Provider at ResteasyProviderFactory or at the jax-rs client.

Version:

$Revision: 1.1 $ Created Mar 23, 2012

Author:

Ron Sigal

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_SERIALIZABLE Deprecated.
static javax.ws.rs.core.MediaType	APPLICATION_SERIALIZABLE_TYPE Deprecated.

Constructor Summary

Constructors

Constructor and Description
SerializableProvider() Deprecated.

Method Summary

Modifier and Type	Method and Description
CompletionStage<Void>	asyncWriteTo(Serializable t, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, AsyncOutputStream entityStream) Deprecated. Write a type to an HTTP message using async IO.
long	getSize(Serializable t, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Deprecated.
boolean	isReadable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Deprecated.
boolean	isWriteable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Deprecated.
Serializable	readFrom(Class<Serializable> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders, InputStream entityStream) Deprecated.
void	writeTo(Serializable t, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_SERIALIZABLE_TYPE

public static final javax.ws.rs.core.MediaType APPLICATION_SERIALIZABLE_TYPE

Deprecated.

APPLICATION_SERIALIZABLE

public static final String APPLICATION_SERIALIZABLE

Deprecated.

Constructor Detail

SerializableProvider

public SerializableProvider()

Deprecated.

Method Detail

isWriteable

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

Deprecated.

Specified by:

isWriteable in interface javax.ws.rs.ext.MessageBodyWriter<Serializable>

getSize

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

Deprecated.

Specified by:

getSize in interface javax.ws.rs.ext.MessageBodyWriter<Serializable>

writeTo

public void writeTo(Serializable t,
                    Class<?> type,
                    Type genericType,
                    Annotation[] annotations,
                    javax.ws.rs.core.MediaType mediaType,
                    javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders,
                    OutputStream entityStream)
             throws IOException,
                    javax.ws.rs.WebApplicationException

Deprecated.

Specified by:

writeTo in interface javax.ws.rs.ext.MessageBodyWriter<Serializable>

Throws:

IOException

javax.ws.rs.WebApplicationException

asyncWriteTo

public CompletionStage<Void> asyncWriteTo(Serializable t,
                                          Class<?> type,
                                          Type genericType,
                                          Annotation[] annotations,
                                          javax.ws.rs.core.MediaType mediaType,
                                          javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders,
                                          AsyncOutputStream entityStream)

Deprecated.

Description copied from interface: AsyncMessageBodyWriter

Write a type to an HTTP message using async IO. The message header map is mutable but any changes must be made before writing to the async output stream since the headers will be flushed prior to writing the message body.

Specified by:

asyncWriteTo in interface AsyncMessageBodyWriter<Serializable>

Parameters:

t - the instance to write.

type - the class of instance that is to be written.

genericType - the type of instance to be written. GenericEntity provides a way to specify this information at runtime.

annotations - an array of the annotations attached to the message entity instance.

mediaType - the media type of the HTTP entity.

httpHeaders - a mutable map of the HTTP message headers.

entityStream - the AsyncOutputStream for the HTTP entity. The implementation should not close the output stream.

Returns:

a CompletionStage indicating completion

isReadable

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

Deprecated.

Specified by:

isReadable in interface javax.ws.rs.ext.MessageBodyReader<Serializable>

readFrom

public Serializable readFrom(Class<Serializable> type,
                             Type genericType,
                             Annotation[] annotations,
                             javax.ws.rs.core.MediaType mediaType,
                             javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
                             InputStream entityStream)
                      throws IOException,
                             javax.ws.rs.WebApplicationException

Deprecated.

Specified by:

readFrom in interface javax.ws.rs.ext.MessageBodyReader<Serializable>

Throws:

IOException

javax.ws.rs.WebApplicationException