com.flowcentraltech.flowcentral.configuration.xml.util.ConfigurationUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flowcentral-configuration Show documentation
Flowcentral Configuration Module
The newest version!
/*
 * Copyright 2021-2024 FlowCentral Technologies Limited.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.flowcentraltech.flowcentral.configuration.xml.util;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;

import com.flowcentraltech.flowcentral.configuration.xml.AppConfig;
import com.flowcentraltech.flowcentral.configuration.xml.BaseConfig;
import com.flowcentraltech.flowcentral.configuration.xml.ModuleConfig;
import com.flowcentraltech.flowcentral.configuration.xml.NotifTemplateConfig;
import com.flowcentraltech.flowcentral.configuration.xml.ReportConfig;
import com.flowcentraltech.flowcentral.configuration.xml.SnapshotConfig;
import com.flowcentraltech.flowcentral.configuration.xml.WfConfig;
import com.flowcentraltech.flowcentral.configuration.xml.WfWizardConfig;
import com.tcdng.unify.core.UnifyError;
import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.util.IOUtils;
import com.tcdng.unify.core.util.XmlConfigUtils;

/**
 * Configuration utilities.
 * 
 * @author FlowCentral Technologies Limited
 * @since 1.0
 */
public final class ConfigurationUtils {

    private ConfigurationUtils() {

    }

    public static  T readConfig(Class configClass, String fileResource, String workingPath)
            throws UnifyException {
        InputStream inputStream = null;
        try {
            inputStream = IOUtils.openFileResourceInputStream(fileResource, workingPath);
            return XmlConfigUtils.readXmlConfig(configClass, inputStream);
        } finally {
            IOUtils.close(inputStream);
        }
    }

    public static  T readConfig(Class configClass, InputStream inputStream)
            throws UnifyException {
        try {
            return XmlConfigUtils.readXmlConfig(configClass, inputStream);
        } finally {
            IOUtils.close(inputStream);
        }
    }

    public static void writeConfig(BaseConfig config, OutputStream outputStream) throws UnifyException {
        XmlConfigUtils.writeXmlConfig(config, outputStream);
    }

    public static void writeConfigNoEscape(BaseConfig config, OutputStream outputStream) throws UnifyException {
        XmlConfigUtils.writeXmlConfigNoEscape(config, outputStream);
    }

    public static String readString(String fileResource, String workingPath) throws UnifyException {
        return IOUtils.readAllLines(fileResource, workingPath);
    }

    public static SnapshotConfig getSnapshotConfig(byte[] snapshot) throws UnifyException {
        SnapshotConfig snapshotConfig = null;
        File tempFile = null;
        FileOutputStream fos = null;
        InputStream ios = null;
        ZipFile zipFile = null;
        try {
            tempFile = File.createTempFile("flowsnapshot", ".zip");
            fos = new FileOutputStream(tempFile);
            IOUtils.writeAll(fos, snapshot);
            IOUtils.close(fos);

            zipFile = new ZipFile(tempFile);
            ZipEntry zipEntry = zipFile.getEntry("snapshot.xml");
            if (zipEntry != null) {
                ios = zipFile.getInputStream(zipEntry);
                snapshotConfig = ConfigurationUtils.readConfig(SnapshotConfig.class, ios);
            }
        } catch (UnifyException e) {
            throw e;
        } catch (Exception e) {
        } finally {
            if (ios != null) {
                IOUtils.close(ios);
            }
            
            if (zipFile != null) {
                try {
                    zipFile.close();
                } catch (IOException e) {
                }
            }

            if (fos != null) {
                IOUtils.close(fos);
            }

            if (tempFile != null) {
                tempFile.delete();
            }
        }
        
        return snapshotConfig;
    }
    
    public static List readStringList(String fileResource, String workingPath) throws UnifyException {
        return IOUtils.readFileResourceLines(fileResource, workingPath);
    }

    public static List validateModuleConfig(ModuleConfig moduleConfig) {
        // TODO
        return null;
    }

    public static List validateApplicationConfig(AppConfig applicationConfig) {
        // TODO
        return null;
    }

    public static List validateReportConfig(ReportConfig reportConfig) {
        // TODO Auto-generated method stub
        return null;
    }

    public static List validateNotifTemplateConfig(NotifTemplateConfig notifTemplateConfig) {
        // TODO Auto-generated method stub
        return null;
    }

    public static List validateWfConfig(WfConfig wfConfig) {
        // TODO Auto-generated method stub
        return null;
    }

    public static List validateWfWizardConfig(WfWizardConfig wfWizardConfig) {
        // TODO Auto-generated method stub
        return null;
    }

}