org.ow2.authzforce.webapp

Class JsonJaxrsProvider<T>

java.lang.Object

org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

org.apache.cxf.jaxrs.provider.AbstractJAXBProvider<T>

org.apache.cxf.jaxrs.provider.json.JSONProvider<T>

org.ow2.authzforce.webapp.JsonJaxrsProvider<T>

All Implemented Interfaces:

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

public final class JsonJaxrsProvider<T>
extends org.apache.cxf.jaxrs.provider.json.JSONProvider<T>

Fix for CXF issue: JSONProvider does not enforce JAX-RS (JSON in this case) depth control properties org.apache.cxf.stax.* (only innerElementCountThreshold is enforced and only affects JSONObject key-value pairs, not JSONArray elements!), as of CXF 3.1.8. This fix is adapted from protected method getStreamReader() of JAXBElementProvider

FIXME: report this issue

This implementation like parent JSONProvider is not as efficient as it should be, because JSON parsing is done after the whole JSON payload has been parsed into a String by AbstractXMLInputFactory#readAll() methods

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cxf.jaxrs.provider.AbstractJAXBProvider

org.apache.cxf.jaxrs.provider.AbstractJAXBProvider.CollectionWrapper, org.apache.cxf.jaxrs.provider.AbstractJAXBProvider.JAXBCollectionWrapperReader

Field Summary

Fields inherited from class org.apache.cxf.jaxrs.provider.AbstractJAXBProvider

classContexts, collectionContextClasses, inAppendMap, inDropElements, inElementsMap, jaxbElementClassMap, marshalAsJaxbElement, NS_MAPPER_PROPERTY_RI, NS_MAPPER_PROPERTY_RI_INT, outAppendMap, outDropElements, outElementsMap, packageContexts, unmarshalAsJaxbElement, xmlTypeAsJaxbElementOnly

Fields inherited from class org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

BUNDLE, LOG

Constructor Summary

Constructors

Constructor and Description
JsonJaxrsProvider()

Method Summary

Modifier and Type	Method and Description
protected XMLStreamReader	createDepthReaderIfNeeded(XMLStreamReader reader, InputStream is) Reason for override: super.createDepthReaderIfNeeded() fails if getDepthProperties() != null because the reader (XMLStreamReader) is not compatible with internal call to StaxUtils.configureReader(reader, message): it is not expected type org.codehaus.stax2.XMLStreamReader2 (therefore ClassCastException);
protected XMLStreamReader	createReader(Class<?> type, InputStream is, String enc) Reason for override: prevent use of depthProperties with badgerfish convention (not supported).
void	setConvention(String value)
void	setMaxStringLength(int value) Set maximum string length in JSON payload;
void	setNamespaceMap(Map<String,String> namespaceMap)
void	setNamespaceSeparator(String namespaceSeparator)
void	setPrimitiveArrayKeys(List<String> primitiveArrayKeys)

Methods inherited from class org.apache.cxf.jaxrs.provider.json.JSONProvider

copyReaderToWriter, createReader, createWriter, getArrayKeys, getBooleanJsonProperty, getDepthProperties, getInputStream, getRootName, isReadable, isRootArray, isWriteable, marshal, marshal, marshalCollection, marshalCollectionMember, readFrom, setArrayKeys, setAttributesToElements, setConsumeMediaTypes, setConvertTypesToStrings, setDropCollectionWrapperElement, setDropElementsInXmlStream, setDropRootElement, setEnableBuffering, setEscapeForwardSlashesAlways, setIgnoreEmptyArrayValues, setIgnoreMixedContent, setIgnoreNamespaces, setMessageContext, setProduceMediaTypes, setReadXsiType, setSerializeAsArray, setSupportUnwrapped, setTypeConverter, setWrapperMap, setWrapperName, setWriteNullAsString, setWriteXsiType, writeTo

Methods inherited from class org.apache.cxf.jaxrs.provider.AbstractJAXBProvider

canBeReadAsJaxbElement, checkAdapter, clearContexts, configureReaderRestrictions, convertToJaxbElementIfNeeded, createMarshaller, createTransformReaderIfNeeded, createTransformWriterIfNeeded, createUnmarshaller, createUnmarshaller, getActualType, getClassContext, getClassContext, getCollectionContext, getCollectionWrapperQName, getContext, getJAXBContext, getJaxbElementClass, getJaxbQName, getPackageContext, getPackageContext, getSchema, getSchema, getSize, getStreamHandlerFromCurrentMessage, handleExceptionEnd, handleExceptionStart, handleJAXBException, handleXMLStreamException, init, isSkipJaxbChecks, isSupported, isXmlRoot, isXmlType, objectFactoryOrIndexAvailable, setCatalogLocation, setCollectionWrapperMap, setCollectionWrapperName, setContext, setContextProperties, setDepthProperties, setExtraClass, setInAppendElements, setInDropElements, setInTransformElements, setJaxbElementClassMap, setJaxbElementClassNames, setMarshallAsJaxbElement, setMarshallerListener, setMarshallerProp, setNamespaceMapper, setNamespaceMapperPropertyName, setOutAppendElements, setOutDropElements, setOutTransformElements, setSchema, setSchemaHandler, setSchemaHandlers, setSchemaLocations, setSingleJaxbContext, setSkipJaxbChecks, setUnmarshallAsJaxbElement, setUnmarshallerListener, setUnmarshallerProperties, setUseSingleContextForPackages, setValidateBeforeWrite, setValidateInput, setValidateOutput, setValidationHandler, setXmlRootAsJaxbElement, setXmlTypeAsJaxbElementOnly, validateObjectIfNeeded, writeTo

Methods inherited from class org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

getBus, getConsumeMediaTypes, getEnableBuffering, getEnableStreaming, getProduceMediaTypes, isPayloadEmpty, isPayloadEmpty, reportEmptyContentLength, setBus, setEnableStreaming

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonJaxrsProvider

public JsonJaxrsProvider()

Method Detail

setMaxStringLength

public void setMaxStringLength(int value)

Set maximum string length in JSON payload;

Parameters:

value - maximum, ignored iff negative (or zero)

setConvention

public void setConvention(String value)

Overrides:

setConvention in class org.apache.cxf.jaxrs.provider.json.JSONProvider<T>

setNamespaceMap

public void setNamespaceMap(Map<String,String> namespaceMap)

Overrides:

setNamespaceMap in class org.apache.cxf.jaxrs.provider.json.JSONProvider<T>

setPrimitiveArrayKeys

public void setPrimitiveArrayKeys(List<String> primitiveArrayKeys)

Overrides:

setPrimitiveArrayKeys in class org.apache.cxf.jaxrs.provider.json.JSONProvider<T>

setNamespaceSeparator

public void setNamespaceSeparator(String namespaceSeparator)

Overrides:

setNamespaceSeparator in class org.apache.cxf.jaxrs.provider.json.JSONProvider<T>

createDepthReaderIfNeeded

protected XMLStreamReader createDepthReaderIfNeeded(XMLStreamReader reader,
                                                    InputStream is)

Reason for override: super.createDepthReaderIfNeeded() fails if getDepthProperties() != null because the reader (XMLStreamReader) is not compatible with internal call to StaxUtils.configureReader(reader, message): it is not expected type org.codehaus.stax2.XMLStreamReader2 (therefore ClassCastException);

Overrides:

createDepthReaderIfNeeded in class org.apache.cxf.jaxrs.provider.AbstractJAXBProvider<T>

createReader

protected XMLStreamReader createReader(Class<?> type,
                                       InputStream is,
                                       String enc)
                                throws Exception

Reason for override:

1. prevent use of depthProperties with badgerfish convention (not supported). More info: http://cxf.547215.n5.nabble.com/No-JSON-depth-control-with-Badgerfish -td5776211.html
2. Support innerElementLevelThreshold (only innerElementCount is supported by CXF JSONProvider as shown by method JSONUtils$JettisonMappedReaderFactory#createNewJSONTokener() ) and max string length (similar to org.apache.cxf.stax.maxAttributeSize/maxTextLength for XML).

Overrides:

createReader in class org.apache.cxf.jaxrs.provider.json.JSONProvider<T>

Throws:

Exception