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 *     Gabriel Barata <gbarata@nuxeo.com>
018 */
019
020package org.nuxeo.ecm.core.io.marshallers.json.enrichers;
021
022import org.nuxeo.ecm.core.api.DocumentModel;
023import org.nuxeo.ecm.core.io.registry.reflect.Setup;
024import org.nuxeo.ecm.core.schema.SchemaManager;
025import org.nuxeo.runtime.api.Framework;
026
027import com.fasterxml.jackson.core.JsonGenerator;
028
029import java.io.IOException;
030import java.util.Collection;
031
032import static org.nuxeo.ecm.core.io.registry.reflect.Instantiations.SINGLETON;
033import static org.nuxeo.ecm.core.io.registry.reflect.Priorities.REFERENCE;
034
035/**
036 * Enrich {@link DocumentModel} JSON object with an array of the document types that can be created under the current
037 * document.
038 *
039 * @since 8.4
040 * @deprecated Since 11.5, use the SubtypesJsonEnricher in org.nuxeo.ecm.platform.types instead.
041 */
042@Deprecated
043@Setup(mode = SINGLETON, priority = REFERENCE)
044public class SubtypesJsonEnricher extends AbstractJsonEnricher<DocumentModel> {
045
046    public static final String NAME = "subtypes";
047
048    public SubtypesJsonEnricher() {
049        super(NAME);
050    }
051
052    @Override
053    public void write(JsonGenerator jg, DocumentModel enriched) throws IOException {
054        SchemaManager schemaManager = Framework.getService(SchemaManager.class);
055        Collection<String> subtypes = enriched.getDocumentType().getAllowedSubtypes();
056        jg.writeFieldName(NAME);
057        jg.writeStartArray();
058        for (String subtype : subtypes) {
059            jg.writeStartObject();
060            jg.writeStringField("type", subtype);
061            jg.writeArrayFieldStart("facets");
062            for (String facet : schemaManager.getDocumentType(subtype).getFacets()) {
063                jg.writeString(facet);
064            }
065            jg.writeEndArray();
066            jg.writeEndObject();
067        }
068        jg.writeEndArray();
069    }
070}