org.apache.juneau.rest.jaxrs

Class BaseProvider

java.lang.Object

org.apache.juneau.rest.jaxrs.BaseProvider

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicProvider

public class BaseProvider
extends Object
implements javax.ws.rs.ext.MessageBodyReader<Object>, javax.ws.rs.ext.MessageBodyWriter<Object>

Base class for defining JAX-RS providers based on Juneau serializers and parsers.

See Also:

• Overview > juneau-rest-server-jaxrs

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseProvider() Constructor.

Method Summary

Modifier and Type	Method and Description
protected ObjectMap	getMethodProperties(Annotation[] a) Returns properties defined on the specified method through the @RestMethod.properties() annotation specified on the method and the JuneauProvider.properties() annotation specified on the provider class.
long	getSize(Object o, Class<?> type, Type gType, Annotation[] a, javax.ws.rs.core.MediaType mediaType)
boolean	isReadable(Class<?> type, Type gType, Annotation[] a, javax.ws.rs.core.MediaType mediaType)
boolean	isWriteable(Class<?> type, Type gType, Annotation[] a, javax.ws.rs.core.MediaType mediaType)
Object	readFrom(Class<Object> type, Type gType, Annotation[] a, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,String> headers, InputStream in)
void	writeTo(Object o, Class<?> type, Type gType, Annotation[] a, javax.ws.rs.core.MediaType mediaType, 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

BaseProvider

protected BaseProvider()

Constructor.

Method Detail

getMethodProperties

protected ObjectMap getMethodProperties(Annotation[] a)

Returns properties defined on the specified method through the @RestMethod.properties() annotation specified on the method and the JuneauProvider.properties() annotation specified on the provider class.

Parameters:

a - All annotations defined on the method.

Returns:

A map of all properties define on the method.

getSize

public long getSize(Object o,
                    Class<?> type,
                    Type gType,
                    Annotation[] a,
                    javax.ws.rs.core.MediaType mediaType)

Specified by:

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

isWriteable

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

Specified by:

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

writeTo

public void writeTo(Object o,
                    Class<?> type,
                    Type gType,
                    Annotation[] a,
                    javax.ws.rs.core.MediaType mediaType,
                    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<Object>

Throws:

IOException

javax.ws.rs.WebApplicationException

isReadable

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

Specified by:

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

readFrom

public Object readFrom(Class<Object> type,
                       Type gType,
                       Annotation[] a,
                       javax.ws.rs.core.MediaType mediaType,
                       javax.ws.rs.core.MultivaluedMap<String,String> headers,
                       InputStream in)
                throws IOException,
                       javax.ws.rs.WebApplicationException

Specified by:

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

Throws:

IOException

javax.ws.rs.WebApplicationException