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