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 *     <a href="mailto:grenard@nuxeo.com">Guillaume Renard</a>
018 */
019
020package org.nuxeo.ecm.platform.routing.core.io.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.List;
027
028import org.codehaus.jackson.JsonGenerator;
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.ecm.platform.routing.api.DocumentRoute;
034import org.nuxeo.ecm.platform.routing.api.DocumentRoutingService;
035import org.nuxeo.runtime.api.Framework;
036
037/**
038 * Enricher that add the running workflow instances on a document for the current user.
039 *
040 * @since 8.3
041 */
042@Setup(mode = SINGLETON, priority = REFERENCE)
043public class RunningWorkflowJsonEnricher extends AbstractJsonEnricher<DocumentModel> {
044
045    public static final String NAME = "runningWorkflows";
046
047    public RunningWorkflowJsonEnricher() {
048        super(NAME);
049    }
050
051    @Override
052    public void write(JsonGenerator jg, DocumentModel document) throws IOException {
053        jg.writeFieldName(NAME);
054        jg.writeStartArray();
055        try (SessionWrapper wrapper = ctx.getSession(document)) {
056            DocumentRoutingService documentRoutingService = Framework.getService(DocumentRoutingService.class);
057            List<DocumentRoute> documentRoutes = documentRoutingService.getDocumentRelatedWorkflows(document, wrapper.getSession());
058            for (DocumentRoute documentRoute : documentRoutes) {
059                writeEntity(documentRoute, jg);
060            }
061        } finally {
062            jg.writeEndArray();
063        }
064    }
065
066}