001/*
002 * (C) Copyright 2016 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 *     "Guillaume Renard"
018 */
019
020package org.nuxeo.ecm.collections.core.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.collections.api.FavoritesManager;
029import org.nuxeo.ecm.core.api.DocumentModel;
030import org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher;
031import org.nuxeo.ecm.core.io.registry.context.RenderingContext.SessionWrapper;
032import org.nuxeo.ecm.core.io.registry.reflect.Setup;
033import org.nuxeo.runtime.api.Framework;
034
035/**
036 * Enricher that add a boolean flag whether a document belongs to the current user's favorites.
037 *
038 * @since 8.1
039 */
040@Setup(mode = SINGLETON, priority = REFERENCE)
041public class FavoritesJsonEnricher extends AbstractJsonEnricher<DocumentModel> {
042
043    public static final String NAME = "favorites";
044
045    public static final String IS_FAVORITE = "isFavorite";
046
047    public FavoritesJsonEnricher() {
048        super(NAME);
049    }
050
051    @Override
052    public void write(JsonGenerator jg, DocumentModel document) throws IOException {
053        jg.writeFieldName(NAME);
054        jg.writeStartObject();
055        boolean isFavorite = false;
056        try (SessionWrapper wrapper = ctx.getSession(document)) {
057            isFavorite = Framework.getService(FavoritesManager.class).isFavorite(document, wrapper.getSession());
058        }
059        jg.writeBooleanField(IS_FAVORITE, isFavorite);
060        jg.writeEndObject();
061    }
062
063}