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 <[email protected]>
018 */
019
020package org.nuxeo.ecm.platform.preview.io;
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.nuxeo.ecm.core.api.DocumentModel;
028import org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher;
029import org.nuxeo.ecm.core.io.registry.reflect.Setup;
030import org.nuxeo.ecm.platform.preview.helper.PreviewHelper;
031
032import com.fasterxml.jackson.core.JsonGenerator;
033
034/**
035 * Enrich {@link DocumentModel} Json.
036 * <p>
037 * Add {@link DocumentModel}'s preview url as json attachment.
038 * </p>
039 * <p>
040 * Enable if parameter enrichers-document=preview is present.
041 * </p>
042 * <p>
043 * Format is:
044 *
045 * <pre>
046 * {@code
047 * {
048 *   "entity-type":"document",
049 *   ...
050 *   "contextParameters": {
051 *     "preview": {
052 *       "url": "PREVIEW_URL"
053 *     },
054 *   }
055 * }
056 * </pre>
057 *
058 * </p>
059 *
060 * @since 7.2
061 */
062@Setup(mode = SINGLETON, priority = REFERENCE)
063public class PreviewJsonEnricher extends AbstractJsonEnricher<DocumentModel> {
064
065    public static final String NAME = "preview";
066
067    private static final String PREVIEW_URL_LABEL = "url";
068
069    public PreviewJsonEnricher() {
070        super(NAME);
071    }
072
073    @Override
074    public void write(JsonGenerator jg, DocumentModel document) throws IOException {
075        String relativeUrl = PreviewHelper.getPreviewURL(document);
076        jg.writeFieldName(NAME);
077        jg.writeStartObject();
078        if (relativeUrl != null && !relativeUrl.isEmpty()) {
079            String url = ctx.getBaseUrl() + PreviewHelper.getPreviewURL(document);
080            jg.writeStringField(PREVIEW_URL_LABEL, url);
081        } else {
082            jg.writeNullField(PREVIEW_URL_LABEL);
083        }
084        jg.writeEndObject();
085    }
086
087}