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.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 * Enable if parameter enrichers-document=preview is present. 040 * <p> 041 * Format is: 042 * 043 * <pre> 044 * { 045 * "entity-type":"document", 046 * ... 047 * "contextParameters": { 048 * "preview": { 049 * "url": "PREVIEW_URL" 050 * }, 051 * } 052 * } 053 * </pre> 054 * 055 * @since 7.2 056 */ 057@Setup(mode = SINGLETON, priority = REFERENCE) 058public class PreviewJsonEnricher extends AbstractJsonEnricher<DocumentModel> { 059 060 public static final String NAME = "preview"; 061 062 private static final String PREVIEW_URL_LABEL = "url"; 063 064 public PreviewJsonEnricher() { 065 super(NAME); 066 } 067 068 @Override 069 public void write(JsonGenerator jg, DocumentModel document) throws IOException { 070 String relativeUrl = PreviewHelper.getPreviewURL(document); 071 jg.writeFieldName(NAME); 072 jg.writeStartObject(); 073 if (relativeUrl != null && !relativeUrl.isEmpty()) { 074 String url = ctx.getBaseUrl() + PreviewHelper.getPreviewURL(document); 075 jg.writeStringField(PREVIEW_URL_LABEL, url); 076 } else { 077 jg.writeNullField(PREVIEW_URL_LABEL); 078 } 079 jg.writeEndObject(); 080 } 081 082}