com.alibaba.fastjson.support.jaxrs

Class FastJsonProvider

java.lang.Object

com.alibaba.fastjson.support.jaxrs.FastJsonProvider

All Implemented Interfaces:

javax.ws.rs.ext.MessageBodyReader<java.lang.Object>, javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

@Provider
 @Consumes(value="*/*")
 @Produces(value="*/*")
public class FastJsonProvider
extends java.lang.Object
implements javax.ws.rs.ext.MessageBodyReader<java.lang.Object>, javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

Fastjson for JAX-RS Provider.

Since:

1.2.9

See Also:

MessageBodyReader, MessageBodyWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.charset.Charset	charset Deprecated.
private java.lang.Class<?>[]	clazzes allow serialize/deserialize types in clazzes
protected java.lang.String	dateFormat Deprecated.
static java.lang.Class<?>[]	DEFAULT_UNREADABLES These are classes that we never use for reading (never try to deserialize instances of these types).
static java.lang.Class<?>[]	DEFAULT_UNWRITABLES These are classes that we never use for writing (never try to serialize instances of these types).
private FastJsonConfig	fastJsonConfig with fastJson config
protected SerializerFeature[]	features Deprecated.
protected SerializeFilter[]	filters Deprecated.
private boolean	pretty whether set PrettyFormat while exec WriteTo()
protected javax.ws.rs.ext.Providers	providers Injectable context object used to locate configured instance of FastJsonConfig to use for actual serialization.

Constructor Summary

Constructors

Constructor and Description
FastJsonProvider() Can serialize/deserialize all types.
FastJsonProvider(java.lang.Class<?>[] clazzes) Only serialize/deserialize all types in clazzes.
FastJsonProvider(java.lang.String charset) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.nio.charset.Charset	getCharset() Deprecated.
java.lang.String	getDateFormat() Deprecated.
FastJsonConfig	getFastJsonConfig()
SerializerFeature[]	getFeatures() Deprecated.
SerializeFilter[]	getFilters() Deprecated.
long	getSize(java.lang.Object t, java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to figure out serialized length of given value.
protected boolean	hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType) Check media type like "application/json".
protected boolean	isAssignableFrom(java.lang.Class<?> type, java.lang.Class<?>[] classes) Check some are interface/abstract classes to exclude.
boolean	isReadable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to check whether values of given type (and media type) can be deserialized by this provider.
protected boolean	isValidType(java.lang.Class<?> type, java.lang.annotation.Annotation[] classAnnotations) Check whether a class can be serialized or deserialized.
boolean	isWriteable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Method that JAX-RS container calls to try to check whether given value (of specified type) can be serialized by this provider.
protected FastJsonConfig	locateConfigProvider(java.lang.Class<?> type, javax.ws.rs.core.MediaType mediaType) Helper method that is called if no config has been explicitly configured.
java.lang.Object	readFrom(java.lang.Class<java.lang.Object> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> httpHeaders, java.io.InputStream entityStream) Method that JAX-RS container calls to deserialize given value.
void	setCharset(java.nio.charset.Charset charset) Deprecated.
void	setDateFormat(java.lang.String dateFormat) Deprecated.
void	setFastJsonConfig(FastJsonConfig fastJsonConfig)
void	setFeatures(SerializerFeature... features) Deprecated.
void	setFilters(SerializeFilter... filters) Deprecated.
FastJsonProvider	setPretty(boolean p) Set pretty format
(package private) static int	writeJSONStringWithFastJsonConfig(java.io.OutputStream os, java.nio.charset.Charset charset, java.lang.Object object, SerializeConfig config, SerializeFilter[] filters, java.lang.String dateFormat, int defaultFeatures, SerializerFeature... features)
void	writeTo(java.lang.Object obj, java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.Object> httpHeaders, java.io.OutputStream entityStream) Method that JAX-RS container calls to serialize given value.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_UNREADABLES

public static final java.lang.Class<?>[] DEFAULT_UNREADABLES

These are classes that we never use for reading (never try to deserialize instances of these types).

DEFAULT_UNWRITABLES

public static final java.lang.Class<?>[] DEFAULT_UNWRITABLES

These are classes that we never use for writing (never try to serialize instances of these types).

charset

@Deprecated
protected java.nio.charset.Charset charset

Deprecated.

features

@Deprecated
protected SerializerFeature[] features

Deprecated.

filters

@Deprecated
protected SerializeFilter[] filters

Deprecated.

dateFormat

@Deprecated
protected java.lang.String dateFormat

Deprecated.

providers

@Context
protected javax.ws.rs.ext.Providers providers

Injectable context object used to locate configured instance of FastJsonConfig to use for actual serialization.

fastJsonConfig

private FastJsonConfig fastJsonConfig

with fastJson config

clazzes

private java.lang.Class<?>[] clazzes

allow serialize/deserialize types in clazzes

pretty

private boolean pretty

whether set PrettyFormat while exec WriteTo()

Constructor Detail

FastJsonProvider

public FastJsonProvider()

Can serialize/deserialize all types.

FastJsonProvider

public FastJsonProvider(java.lang.Class<?>[] clazzes)

Only serialize/deserialize all types in clazzes.

FastJsonProvider

@Deprecated
public FastJsonProvider(java.lang.String charset)

Deprecated.

Instantiates a new Fast json provider.

Parameters:

charset - the charset

See Also:

FastJsonConfig.setCharset(Charset)

Method Detail

getFastJsonConfig

public FastJsonConfig getFastJsonConfig()

Returns:

the fastJsonConfig.

Since:

1.2.11

setFastJsonConfig

public void setFastJsonConfig(FastJsonConfig fastJsonConfig)

Parameters:

fastJsonConfig - the fastJsonConfig to set.

Since:

1.2.11

setPretty

public FastJsonProvider setPretty(boolean p)

Set pretty format

getCharset

@Deprecated
public java.nio.charset.Charset getCharset()

Deprecated.

Gets charset.

Returns:

the charset

See Also:

FastJsonConfig.getCharset()

setCharset

@Deprecated
public void setCharset(java.nio.charset.Charset charset)

Deprecated.

Sets charset.

Parameters:

charset - the charset

See Also:

FastJsonConfig.setCharset(Charset)

getDateFormat

@Deprecated
public java.lang.String getDateFormat()

Deprecated.

Gets date format.

Returns:

the date format

See Also:

FastJsonConfig.getDateFormat()

setDateFormat

@Deprecated
public void setDateFormat(java.lang.String dateFormat)

Deprecated.

Sets date format.

Parameters:

dateFormat - the date format

See Also:

FastJsonConfig.setDateFormat(String)

getFeatures

@Deprecated
public SerializerFeature[] getFeatures()

Deprecated.

Get features serializer feature [].

Returns:

the serializer feature []

See Also:

FastJsonConfig.getFeatures()

setFeatures

@Deprecated
public void setFeatures(SerializerFeature... features)

Deprecated.

Sets features.

Parameters:

features - the features

See Also:

FastJsonConfig.setFeatures(Feature...)

getFilters

@Deprecated
public SerializeFilter[] getFilters()

Deprecated.

Get filters serialize filter [].

Returns:

the serialize filter []

See Also:

FastJsonConfig.getSerializeFilters()

setFilters

@Deprecated
public void setFilters(SerializeFilter... filters)

Deprecated.

Sets filters.

Parameters:

filters - the filters

See Also:

FastJsonConfig.setSerializeFilters(SerializeFilter...)

isAssignableFrom

protected boolean isAssignableFrom(java.lang.Class<?> type,
                                   java.lang.Class<?>[] classes)

Check some are interface/abstract classes to exclude.

Parameters:

type - the type

classes - the classes

Returns:

the boolean

isValidType

protected boolean isValidType(java.lang.Class<?> type,
                              java.lang.annotation.Annotation[] classAnnotations)

Check whether a class can be serialized or deserialized. It can check based on packages, annotations on entities or explicit classes.

Parameters:

type - class need to check

Returns:

true if valid

hasMatchingMediaType

protected boolean hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)

Check media type like "application/json".

Parameters:

mediaType - media type

Returns:

true if the media type is valid

isWriteable

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

Method that JAX-RS container calls to try to check whether given value (of specified type) can be serialized by this provider.

Specified by:

isWriteable in interface javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

getSize

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

Method that JAX-RS container calls to try to figure out serialized length of given value. always return -1 to denote "not known".

Specified by:

getSize in interface javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

writeTo

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

Method that JAX-RS container calls to serialize given value.

Specified by:

writeTo in interface javax.ws.rs.ext.MessageBodyWriter<java.lang.Object>

Throws:

java.io.IOException

javax.ws.rs.WebApplicationException

writeJSONStringWithFastJsonConfig

static final int writeJSONStringWithFastJsonConfig(java.io.OutputStream os,
                                                   java.nio.charset.Charset charset,
                                                   java.lang.Object object,
                                                   SerializeConfig config,
                                                   SerializeFilter[] filters,
                                                   java.lang.String dateFormat,
                                                   int defaultFeatures,
                                                   SerializerFeature... features)
                                            throws java.io.IOException

Throws:

java.io.IOException

isReadable

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

Method that JAX-RS container calls to try to check whether values of given type (and media type) can be deserialized by this provider.

Specified by:

isReadable in interface javax.ws.rs.ext.MessageBodyReader<java.lang.Object>

readFrom

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

Method that JAX-RS container calls to deserialize given value.

Specified by:

readFrom in interface javax.ws.rs.ext.MessageBodyReader<java.lang.Object>

Throws:

java.io.IOException

javax.ws.rs.WebApplicationException

locateConfigProvider

protected FastJsonConfig locateConfigProvider(java.lang.Class<?> type,
                                              javax.ws.rs.core.MediaType mediaType)

Helper method that is called if no config has been explicitly configured.