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.thumbnail.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;
030
031import com.fasterxml.jackson.core.JsonGenerator;
032
033/**
034 * Enrich {@link DocumentModel} Json.
035 * <p>
036 * Add {@link DocumentModel}'s thumbnail url as json attachment.
037 * </p>
038 * <p>
039 * Enable if parameter enrichers-document=thumbnail is present.
040 * </p>
041 * <p>
042 * Format is:
043 *
044 * <pre>
045 * {@code
046 * {
047 *   "entity-type":"document",
048 *   ...
049 *   "contextParameters": {
050 *     "thumbnail": {
051 *       "url": "THUMBNAIL_URL"
052 *     },
053 *   }
054 * }
055 * </pre>
056 * </p>
057 *
058 * @since 7.2
059 */
060@Setup(mode = SINGLETON, priority = REFERENCE)
061public class ThumbnailJsonEnricher extends AbstractJsonEnricher<DocumentModel> {
062
063    public static final String NAME = "thumbnail";
064
065    public static final String THUMBNAIL_URL_LABEL = "url";
066
067    public static final String THUMBNAIL_URL_PATTERN = "%s/api/v1/repo/%s/id/%s/@rendition/thumbnail";
068
069    public ThumbnailJsonEnricher() {
070        super(NAME);
071    }
072
073    @Override
074    public void write(JsonGenerator jg, DocumentModel document) throws IOException {
075        jg.writeFieldName(NAME);
076        jg.writeStartObject();
077        jg.writeStringField(THUMBNAIL_URL_LABEL,
078                String.format(THUMBNAIL_URL_PATTERN, ctx.getBaseUrl().replaceAll("/$", ""),
079                        document.getRepositoryName(), document.getId()));
080        jg.writeEndObject();
081
082    }
083}