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