001/*
002 * (C) Copyright 2014 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 *     Anahide Tchertchian
018 */
019package org.nuxeo.targetplatforms.io;
020
021import java.io.IOException;
022import java.io.OutputStream;
023import java.util.List;
024
025import org.nuxeo.targetplatforms.api.TargetPackage;
026import org.nuxeo.targetplatforms.api.TargetPackageInfo;
027import org.nuxeo.targetplatforms.api.TargetPlatform;
028import org.nuxeo.targetplatforms.api.TargetPlatformInfo;
029import org.nuxeo.targetplatforms.api.TargetPlatformInstance;
030
031import com.fasterxml.jackson.core.JsonFactory;
032import com.fasterxml.jackson.core.JsonGenerator;
033import com.fasterxml.jackson.databind.MapperFeature;
034import com.fasterxml.jackson.databind.ObjectMapper;
035
036/**
037 * JSON exporter for target platforms, packages and related info.
038 *
039 * @since 5.9.3
040 */
041public class JSONExporter {
042
043    public static void exportToJson(TargetPlatform tp, OutputStream out, boolean pretty) throws IOException {
044        exportToJson((Object) tp, out, pretty);
045    }
046
047    public static void exportToJson(List<TargetPlatform> tp, OutputStream out, boolean pretty) throws IOException {
048        exportToJson((Object) tp, out, pretty);
049    }
050
051    public static void exportToJson(TargetPlatformInfo tpi, OutputStream out, boolean pretty) throws IOException {
052        exportToJson((Object) tpi, out, pretty);
053    }
054
055    public static void exportInfosToJson(List<TargetPlatformInfo> tpi, OutputStream out, boolean pretty)
056            throws IOException {
057        exportToJson(tpi, out, pretty);
058    }
059
060    public static void exportToJson(TargetPlatformInstance tpi, OutputStream out, boolean pretty) throws IOException {
061        exportToJson((Object) tpi, out, pretty);
062    }
063
064    public static void exportToJson(TargetPackage tp, OutputStream out, boolean pretty) throws IOException {
065        exportToJson((Object) tp, out, pretty);
066    }
067
068    public static void exportToJson(TargetPackageInfo tpi, OutputStream out, boolean pretty) throws IOException {
069        exportToJson((Object) tpi, out, pretty);
070    }
071
072    protected static JsonFactory createFactory() {
073        JsonFactory factory = new JsonFactory();
074        final ObjectMapper oc = new ObjectMapper(factory);
075        oc.configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY, true);
076        factory.setCodec(oc);
077        return factory;
078    }
079
080    protected static void exportToJson(Object object, OutputStream out, boolean pretty) throws IOException {
081        JsonFactory factory = createFactory();
082        try (JsonGenerator jg = factory.createGenerator(out)) {
083            if (pretty) {
084                jg.useDefaultPrettyPrinter();
085            }
086            jg.writeObject(object);
087        }
088    }
089
090}