org.glassfish.admin.rest.provider

Class AbstractStaxProvider<T>

java.lang.Object

org.glassfish.admin.rest.provider.BaseProvider<T>

org.glassfish.admin.rest.provider.AbstractStaxProvider<T>

All Implemented Interfaces:

javax.ws.rs.ext.MessageBodyWriter<T>

Direct Known Subclasses:

CommandModelStaxProvider

public abstract class AbstractStaxProvider<T>
extends BaseProvider<T>

Abstract implementation for entity writers to STaX API. This supports XML and JSON.

Author:

mmares

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractStaxProvider.PrePostFixedWriter

Field Summary

Fields inherited from class org.glassfish.admin.rest.provider.BaseProvider

desiredType, habitat, HEADER_DEBUG, JSONP_CALLBACK, requestHeaders, supportedMediaTypes, uriInfo

Constructor Summary

Constructors

Constructor and Description
AbstractStaxProvider(Class desiredType, javax.ws.rs.core.MediaType... mediaType)

Method Summary

Modifier and Type	Method and Description
String	getContent(T proxy)
protected static XMLStreamWriter	getJsonWriter(OutputStream os, boolean indent)
protected AbstractStaxProvider.PrePostFixedWriter	getWriter(javax.ws.rs.core.MediaType mediaType, OutputStream os, boolean indent) Returns XML StAX API for any media types with "xml" subtype.
protected static XMLStreamWriter	getXmlWriter(OutputStream os, boolean indent)
protected boolean	isGivenTypeWritable(Class<?> type, Type genericType) Overwrite this if you need different test of type compatibility.
protected abstract void	writeContentToStream(T proxy, XMLStreamWriter wr) Marshalling implementation here.
void	writeTo(T proxy, Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) Faster with direct stream writing

Methods inherited from class org.glassfish.admin.rest.provider.BaseProvider

canShowDeprecatedItems, canShowHiddenCommands, getCallBackJSONP, getFormattingIndentLevel, getResourceLinks, getResourceLinks, getSize, getXmlCommandLinks, isDebug, isWriteable

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStaxProvider

public AbstractStaxProvider(Class desiredType,
                            javax.ws.rs.core.MediaType... mediaType)

Method Detail

isGivenTypeWritable

protected boolean isGivenTypeWritable(Class<?> type,
                                      Type genericType)

Description copied from class: BaseProvider

Overwrite this if you need different test of type compatibility. Used from isWritable method.

Overrides:

isGivenTypeWritable in class BaseProvider<T>

getXmlWriter

protected static XMLStreamWriter getXmlWriter(OutputStream os,
                                              boolean indent)
                                       throws XMLStreamException

Throws:

XMLStreamException

getJsonWriter

protected static XMLStreamWriter getJsonWriter(OutputStream os,
                                               boolean indent)
                                        throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getWriter

protected AbstractStaxProvider.PrePostFixedWriter getWriter(javax.ws.rs.core.MediaType mediaType,
                                                            OutputStream os,
                                                            boolean indent)
                                                     throws IOException

Returns XML StAX API for any media types with "xml" subtype. Otherwise returns JSON StAX API

Throws:

IOException

writeContentToStream

protected abstract void writeContentToStream(T proxy,
                                             XMLStreamWriter wr)
                                      throws XMLStreamException

Marshalling implementation here.

Parameters:

proxy - object to marshal

wr - STaX for marshaling

Throws:

XMLStreamException

getContent

public String getContent(T proxy)

Specified by:

getContent in class BaseProvider<T>

writeTo

public void writeTo(T proxy,
                    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

Faster with direct stream writing

Specified by:

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

Overrides:

writeTo in class BaseProvider<T>

Throws:

IOException

javax.ws.rs.WebApplicationException