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;
026import java.util.List;
027
028import org.nuxeo.ecm.core.api.DocumentModel;
029import org.nuxeo.ecm.core.api.impl.DocumentModelListImpl;
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
034import com.fasterxml.jackson.core.JsonGenerator;
035
036/**
037 * Enrich {@link DocumentModel} Json.
038 * <p>
039 * Add document breadcrumb (list of all parents document) as json attachment.
040 * <p>
041 * Enable if parameter enrichers-document=breadcrumb is present.
042 * <p>
043 * Format is:
044 *
045 * <pre>
046 * {
047 *   "entity-type":"document",
048 *   ...
049 *   "contextParameters": {
050 *     "breadcrumb": { see {@link DocumentModelListJsonWriter} for format }
051 *   }
052 * }
053 * </pre>
054 *
055 * @since 7.2
056 */
057@Setup(mode = SINGLETON, priority = REFERENCE)
058public class BreadcrumbJsonEnricher extends AbstractJsonEnricher<DocumentModel> {
059
060    public static final String NAME = "breadcrumb";
061
062    public BreadcrumbJsonEnricher() {
063        super(NAME);
064    }
065
066    @Override
067    public void write(JsonGenerator jg, DocumentModel document) throws IOException {
068        List<DocumentModel> parentDocuments = null;
069        try (SessionWrapper wrapper = ctx.getSession(document)) {
070            parentDocuments = wrapper.getSession().getParentDocuments(document.getRef());
071        }
072        DocumentModelListImpl documentList = new DocumentModelListImpl(parentDocuments);
073        jg.writeFieldName(NAME);
074        writeEntity(documentList, jg);
075    }
076
077}