001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nicolas Chapurlat <nchapurlat@nuxeo.com>
018 */
019
020package org.nuxeo.ecm.core.io.marshallers.json.enrichers;
021
022import static org.nuxeo.ecm.core.io.registry.reflect.Instantiations.SINGLETON;
023import static org.nuxeo.ecm.core.io.registry.reflect.Priorities.REFERENCE;
024
025import java.io.IOException;
026
027import org.codehaus.jackson.JsonGenerator;
028import org.nuxeo.ecm.core.api.DocumentModel;
029import org.nuxeo.ecm.core.api.DocumentModelList;
030import org.nuxeo.ecm.core.io.marshallers.json.document.DocumentModelListJsonWriter;
031import org.nuxeo.ecm.core.io.registry.context.RenderingContext.SessionWrapper;
032import org.nuxeo.ecm.core.io.registry.reflect.Setup;
033
034/**
035 * Enrich {@link DocumentModel} Json.
036 * <p>
037 * Add document children (list of document) as json attachment.
038 * </p>
039 * <p>
040 * Enable if parameter enrichers-document=children is present.
041 * </p>
042 * <p>
043 * Format is:
044 *
045 * <pre>
046 * {@code
047 * {
048 *   "entity-type":"document",
049 *   ...
050 *   "contextParameters": {
051 *     "children": { see {@link DocumentModelListJsonWriter} for format }
052 *   }
053 * }
054 * </pre>
055 *
056 * </p>
057 *
058 * @since 7.2
059 */
060@Setup(mode = SINGLETON, priority = REFERENCE)
061public class ChildrenJsonEnricher extends AbstractJsonEnricher<DocumentModel> {
062
063    public static final String NAME = "children";
064
065    public ChildrenJsonEnricher() {
066        super(NAME);
067    }
068
069    @Override
070    public void write(JsonGenerator jg, DocumentModel document) throws IOException {
071        DocumentModelList children = null;
072        try (SessionWrapper wrapper = ctx.getSession(document)) {
073            children = wrapper.getSession().getChildren(document.getRef());
074        }
075        jg.writeFieldName(NAME);
076        writeEntity(children, jg);
077    }
078
079}