com.softwareag.mdm.service
Class Archive

java.lang.Object
  com.softwareag.mdm.service.Archive

public abstract class Archive

extends Object

An instance of this class references an webMethods MDM archive.

An archive represents a set of contents that are in a repository. It is used for propagating contents of one repository to another.

The implementations of this class are light-weight references to their underlying resource. For example, they do not open themselves a file stream if a file is provided.

The webMethods MDM archive must have been generated by an internal export procedure.

See Also:

ProcedureContext.doExportArchive(Archive), ProcedureContext.doImportArchive(Archive)

Field Summary

static String	HEADER_DOCUMENT_NAME Usual name of run header XML document.
static String	HEADER_TEMP_DOCUMENT_NAME Temporary name of run header XML document, used as the file is being written.

Constructor Summary

Archive()

Method Summary

abstract InputStream	computeInputStream()
static Archive	forDirectory(File baseDirectory) Returns a reference to an archive in its expanded directory tree structure form.
static Archive	forFile(File fileToImport) Returns a reference to an archive zip file.
static Archive	forStream(String locationInfoOrNull, InputStream aStream) Returns a reference to an archive zip stream.
abstract String	getLocationInfo() Returns a user-readable information about the location of the archive
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HEADER_DOCUMENT_NAME

public static final String HEADER_DOCUMENT_NAME

Usual name of run header XML document.

See Also:

Constant Field Values

HEADER_TEMP_DOCUMENT_NAME

public static final String HEADER_TEMP_DOCUMENT_NAME

Temporary name of run header XML document, used as the file is being written.

See Also:

Constant Field Values

Constructor Detail

Archive

public Archive()

Method Detail

forFile

public static Archive forFile(File fileToImport)

Returns a reference to an archive zip file.

forStream

public static Archive forStream(String locationInfoOrNull,
                                InputStream aStream)

Returns a reference to an archive zip stream.

forDirectory

public static Archive forDirectory(File baseDirectory)

Returns a reference to an archive in its expanded directory tree structure form.

toString

public String toString()

computeInputStream

public abstract InputStream computeInputStream()
                                        throws FileNotFoundException

Throws:

FileNotFoundException

getLocationInfo

public abstract String getLocationInfo()

Returns a user-readable information about the location of the archive