Package org.nuxeo.ecm.automation.jaxrs
Interface JsonAdapter
-
- All Known Implementing Classes:
DefaultJsonAdapter
,TestableJsonAdapter
public interface JsonAdapter
Should be implemented by objects that needs to be returned in response to clients as JSOn objectsImplementors are encouraged to use jackson JSON library since it is the one used by automation.
Also note that the JSON format for an object must follow the following schema:
{ "entity-type": "typeName" "value": { the marshalled object } }
The value is either a scalar value (from primitive types) either a JSON object{ ... }
The type name is the full class name of the serialized object. The primitive types are mapped to a short name as following:- string
- date
- boolean
- long
- double
- null - this is a special type in case the objec is null - but this may never happens (since null objects are returning an empty content)
- Author:
- Bogdan Stefanescu
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
toJSON(OutputStream out)
-
-
-
Method Detail
-
toJSON
void toJSON(OutputStream out) throws IOException
- Throws:
IOException
-
-