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.core.io.marshallers.json.enrichers;
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;
026import java.util.Map;
027
028import org.nuxeo.ecm.core.api.DocumentModel;
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 custom key/value information as json attachment.
037 * <p>
038 * Enable if parameter enrichers-document=contextualParameters.
039 * <p>
040 * Format is:
041 *
042 * <pre>
043 * {
044 *   "entity-type":"document",
045 *   ...
046 *   "contextParameters": {
047 *     "KEY": "VALUE" &lt;- key/value pairs come from context parameter "contextualParameters" - a Map&lt;String, String&gt; is expected.
048 *   }
049 * }
050 * </pre>
051 *
052 * @since 7.2
053 */
054@Setup(mode = SINGLETON, priority = REFERENCE)
055public class ContextualParametersJsonEnricher extends AbstractJsonEnricher<DocumentModel> {
056
057    public static final String NAME = "contextualParameters";
058
059    public ContextualParametersJsonEnricher() {
060        super(NAME);
061    }
062
063    @Override
064    public void write(JsonGenerator jg, DocumentModel enriched) throws IOException {
065        Map<String, String> contextParameters = ctx.getParameter(NAME);
066        if (contextParameters != null && !contextParameters.isEmpty()) {
067            for (Map.Entry<String, String> parameter : contextParameters.entrySet()) {
068                jg.writeStringField(parameter.getKey(), parameter.getValue());
069            }
070        }
071    }
072
073}