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