Package com.inductiveautomation.ignition.common.project

Class ProjectFileUtil

java.lang.Object

java.nio.file.spi.FileTypeDetector

com.inductiveautomation.ignition.common.project.ProjectFileUtil

public class ProjectFileUtil
extends FileTypeDetector

A utility class for inspecting, identifying and loading Projects from Files or streams.

Provides utilities for both legacy XML exported projects, as well as 8.0 disk-based project zip exports.

Also registers with the ServiceLoader to act as a FileTypeDetector. See the docs on probeContentType(java.nio.file.Path)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_FILE_TYPE
static final String	ZIP_FILE_TYPE

Constructor Summary

Constructors

Constructor	Description
ProjectFileUtil()

Method Summary

Modifier and Type	Method	Description
static void	exportToZip(ResourceCollectionManifest manifest, List<Resource> resources, OutputStream destination)
static void	exportToZip(ResourceCollectionManifest manifest, List<Resource> resources, OutputStream destination, Encoder encoder)
static ProjectImport	fromInputStream(InputStream s, String projectNameOverwrite)
static Optional<ProjectImport>	fromProjectFile(File projectFile, String projectNameOverride)
static ProjectImport	importFromZip(File projectFile, String projectNameOverwrite)
static ProjectImport	importFromZip(InputStream zipStream, String projectName)
static boolean	isSingleton(Resource r)
static boolean	isXmlProjectFile(File file)	Detect if a file appears to be an xml based project export
static boolean	isZipProjectFile(File file)	Detect if a file appears to be a zip based (8.0+) project export file
String	probeContentType(Path path)	This class is registered with the ServiceLoader to provide itself as a FileTypeDetector, which makes it possible to use Files.probeContentType(someFilePath) and then compare the result to see if it matches the static XML_FILE_TYPE or ZIP_FILE_TYPE, the latter being the format for project exports in 8.0 and higher.
static Resource	sanitizeSingletons(Resource r)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XML_FILE_TYPE

public static final String XML_FILE_TYPE

See Also:

• Constant Field Values

ZIP_FILE_TYPE

public static final String ZIP_FILE_TYPE

See Also:

• Constant Field Values

Constructor Details

ProjectFileUtil

public ProjectFileUtil()

Method Details

exportToZip

public static void exportToZip(ResourceCollectionManifest manifest,
 List<Resource> resources,
 OutputStream destination)
                        throws IOException

Throws:

IOException

exportToZip

public static void exportToZip(ResourceCollectionManifest manifest,
 List<Resource> resources,
 OutputStream destination,
 Encoder encoder)
                        throws IOException

Throws:

IOException

probeContentType

@Nullable
public String probeContentType(@Nonnull
 Path path)
                        throws IOException

This class is registered with the ServiceLoader to provide itself as a FileTypeDetector, which makes it possible to use Files.probeContentType(someFilePath) and then compare the result to see if it matches the static XML_FILE_TYPE or ZIP_FILE_TYPE, the latter being the format for project exports in 8.0 and higher.

Specified by:

probeContentType in class FileTypeDetector

Parameters:

path - path to a file possibly being an Ignition project export in either zip or .proj xml format.

Returns:

the discovered file type, or null if no match was found

Throws:

IOException - on failure to read the path as a buffered input stream

isXmlProjectFile

public static boolean isXmlProjectFile(File file)
                                throws IOException

Detect if a file appears to be an xml based project export

Parameters:

file - a file to detect

Returns:

true if the file is an xml based project export

Throws:

IOException - on failure to read file

isZipProjectFile

public static boolean isZipProjectFile(File file)
                                throws IOException

Detect if a file appears to be a zip based (8.0+) project export file

Parameters:

file - to detect

Returns:

true if the file is believed to be a zip based export

Throws:

IOException - on failure to read file

isSingleton

public static boolean isSingleton(Resource r)

sanitizeSingletons

public static Resource sanitizeSingletons(Resource r)

fromProjectFile

public static Optional<ProjectImport> fromProjectFile(File projectFile,
 String projectNameOverride)
                                               throws IOException,
SAXException,
ResourceCollectionInvalidException

Parameters:

projectFile - the exported project file

projectNameOverride - if the resources in the incoming project should be loaded with a different project name than exists in the file, pass the desired name in as this arg

Returns:

optional containing a runtime project on success, or empty if parsing or creation of the project failed.

Throws:

IOException - on failure to read the file

SAXException - on failure to read/parse xml

ResourceCollectionInvalidException

importFromZip

public static ProjectImport importFromZip(@Nonnull
 File projectFile,
 String projectNameOverwrite)
                                   throws ResourceCollectionInvalidException,
IOException

Throws:

ResourceCollectionInvalidException

IOException

fromInputStream

public static ProjectImport fromInputStream(InputStream s,
 String projectNameOverwrite)
                                     throws IOException,
ResourceCollectionInvalidException,
SAXException

Throws:

IOException

ResourceCollectionInvalidException

SAXException

importFromZip

public static ProjectImport importFromZip(@Nonnull
 InputStream zipStream,
 String projectName)
                                   throws ResourceCollectionInvalidException,
IOException

Throws:

ResourceCollectionInvalidException

IOException