Package io.atlasmap.core

Class ADMArchiveHandler

java.lang.Object

io.atlasmap.core.ADMArchiveHandler

public class ADMArchiveHandler
extends Object

The API for handling ADM archive. It encapsulates ADM archive structure and format and isolate file/stream I/O from other part. ADM archive is a zipped archive file or its exploded directory which contains

• Mapping Definition file (atlasmapping-UI.n.json)
• Gzipped digest file which contains all non-Java document metadata and mapping definition in a single JSON file (adm-catalog-files-n.gz)
• Java libraries (jar files in lib/ directory)

load(Path) export(OutputStream)

This handler follows lazy loading strategy as much as possible, i.e. defer to serialize/deserialize until it is really required. Also note that at this moment Java library directory is not managed by this class. Only when it imports/exports ADM archive file, library jars are extracted/bundled if isIgnoreLibrary() is set to false.

TODO https://github.com/atlasmap/atlasmap/issues/1476 A gzipped digest file have to be splitted into individual schemas and a catalog file.

Constructor Summary

Constructors

Constructor	Description
ADMArchiveHandler()
ADMArchiveHandler(ClassLoader loader)

Method Summary

Modifier and Type	Method	Description
void	clear()
AtlasMapping	cloneMappingDefinition()
void	export(OutputStream out)	Export into an ADM archive.
DataSourceMetadata	getDataSourceMetadata(boolean isSource, String documentId)
DataSourceMetadata	getDataSourceMetadata(DataSourceKey key)
Map<DataSourceKey,DataSourceMetadata>	getDataSourceMetadataMap()
byte[]	getGzippedADMDigestBytes()
String	getGzippedADMDigestFileName()
AtlasMapping	getMappingDefinition()
byte[]	getMappingDefinitionBytes()
String	getMappingDefinitionFileName()
boolean	isIgnoreLibrary()
void	load(AtlasContextFactory.Format format, InputStream in)	Load an ADM archive or mapping definition from stream.
void	load(InputStream in)	Load an ADM archive from stream.
void	load(Path path)	Load an ADM archive file, an exploded directory or mapping definition JSON file.
void	persist()	Persist ADM archive into a directory.
void	setGzippedADMDigest(InputStream is)
void	setIgnoreLibrary(boolean ignoreLib)
void	setLibraryDirectory(Path dir)
void	setMappingDefinition(AtlasMapping mapping)
void	setMappingDefinitionBytes(InputStream is)
void	setMappingDefinitionId(String id)
void	setPersistDirectory(Path dir)

Methods inherited from class java.lang.Object

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

Constructor Details

ADMArchiveHandler

public ADMArchiveHandler()

ADMArchiveHandler

public ADMArchiveHandler(ClassLoader loader)

Method Details

load

public void load(Path path)
          throws AtlasException

Load an ADM archive file, an exploded directory or mapping definition JSON file.

Parameters:

path - java.nio.file.Path of the ADM archive file or an exploded directory

Throws:

AtlasException - If it fails to load

load

public void load(InputStream in)
          throws AtlasException

Load an ADM archive from stream.

Parameters:

in - InputStream to read an ADM Archive

Throws:

AtlasException - If it fails to load

load

public void load(AtlasContextFactory.Format format,
 InputStream in)
          throws AtlasException

Load an ADM archive or mapping definition from stream.

Parameters:

format - AtlasContextFactory.Format to indicate stream format

in - InputStream to read an ADM Archive

Throws:

AtlasException - If it fails to load

export

public void export(OutputStream out)
            throws AtlasException

Export into an ADM archive.

Parameters:

out - OutputStream to write an ADM archive

Throws:

AtlasException - If it fails to export

persist

public void persist()
             throws AtlasException

Persist ADM archive into a directory.

Throws:

AtlasException - If it fails to persist

getMappingDefinition

public AtlasMapping getMappingDefinition()

setMappingDefinition

public void setMappingDefinition(AtlasMapping mapping)

setMappingDefinitionBytes

public void setMappingDefinitionBytes(InputStream is)
                               throws AtlasException

Throws:

AtlasException

getMappingDefinitionBytes

public byte[] getMappingDefinitionBytes()
                                 throws AtlasException

Throws:

AtlasException

setGzippedADMDigest

public void setGzippedADMDigest(InputStream is)
                         throws AtlasException

Throws:

AtlasException

getGzippedADMDigestBytes

public byte[] getGzippedADMDigestBytes()

getDataSourceMetadata

public DataSourceMetadata getDataSourceMetadata(boolean isSource,
 String documentId)
                                         throws AtlasException

Throws:

AtlasException

getDataSourceMetadata

public DataSourceMetadata getDataSourceMetadata(DataSourceKey key)
                                         throws AtlasException

Throws:

AtlasException

getDataSourceMetadataMap

public Map<DataSourceKey,DataSourceMetadata> getDataSourceMetadataMap()
                                                               throws AtlasException

Throws:

AtlasException

cloneMappingDefinition

public AtlasMapping cloneMappingDefinition()
                                    throws AtlasException

Throws:

AtlasException

clear

public void clear()

setIgnoreLibrary

public void setIgnoreLibrary(boolean ignoreLib)

isIgnoreLibrary

public boolean isIgnoreLibrary()

setPersistDirectory

public void setPersistDirectory(Path dir)
                         throws AtlasException

Throws:

AtlasException

setLibraryDirectory

public void setLibraryDirectory(Path dir)
                         throws AtlasException

Throws:

AtlasException

setMappingDefinitionId

public void setMappingDefinitionId(String id)

getGzippedADMDigestFileName

public String getGzippedADMDigestFileName()

getMappingDefinitionFileName

public String getMappingDefinitionFileName()