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.apache.commons.lang3.StringUtils.defaultString;
023import static org.nuxeo.ecm.core.io.registry.reflect.Instantiations.SINGLETON;
024import static org.nuxeo.ecm.core.io.registry.reflect.Priorities.REFERENCE;
025
026import java.io.IOException;
027import java.net.URLEncoder;
028
029import org.nuxeo.ecm.core.api.CoreSession;
030import org.nuxeo.ecm.core.api.DocumentModel;
031import org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher;
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 {@link DocumentModel}'s thumbnail url as json attachment.
040 * <p>
041 * Enable if parameter enrichers-document=thumbnail is present.
042 * <p>
043 * Format is:
044 *
045 * <pre>
046 * {@code
047 * {
048 *   "entity-type":"document",
049 *   ...
050 *   "contextParameters": {
051 *     "thumbnail": {
052 *       "url": "THUMBNAIL_URL"
053 *     },
054 *   }
055 * }
056 * }
057 * </pre>
058 *
059 * @since 7.2
060 */
061@Setup(mode = SINGLETON, priority = REFERENCE)
062public class ThumbnailJsonEnricher extends AbstractJsonEnricher<DocumentModel> {
063
064    public static final String NAME = "thumbnail";
065
066    public static final String THUMBNAIL_URL_LABEL = "url";
067
068    public static final String THUMBNAIL_URL_PATTERN = "%s/api/v1/repo/%s/id/%s/@rendition/thumbnail?"
069            + CoreSession.CHANGE_TOKEN + "=%s";
070
071    public ThumbnailJsonEnricher() {
072        super(NAME);
073    }
074
075    @Override
076    public void write(JsonGenerator jg, DocumentModel document) throws IOException {
077        jg.writeFieldName(NAME);
078        jg.writeStartObject();
079        jg.writeStringField(THUMBNAIL_URL_LABEL,
080                String.format(THUMBNAIL_URL_PATTERN, ctx.getBaseUrl().replaceAll("/$", ""),
081                        document.getRepositoryName(), document.getId(),
082                        URLEncoder.encode(defaultString(document.getChangeToken()), "UTF-8")));
083        jg.writeEndObject();
084
085    }
086}