com.vordel.api.deployment.model

Class EnvironmentArchive

java.lang.Object

com.vordel.api.deployment.model.Archive

com.vordel.api.deployment.model.EnvironmentArchive

public class EnvironmentArchive
extends Archive

This class represents a Environment Archive (.env file).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_EXTENSION

Fields inherited from class com.vordel.api.deployment.model.Archive

CHANGEDBY_PROPERTY, CONFIGS, data, DESCRIPTION_DEFAULT_PROPERTY, ENV_SETTINGS_STORE, ENVIRONMENT_MANIFEST_FILE, environmentStoreTypes, ID_DEFAULT_PROPERTY, MANIFEST_DIR, MANIFEST_FILE, NAME_DEFAULT_PROPERTY, POLICY_MANIFEST_FILE, policyStoreTypes, rootProperties, TIMESTAMP_DEFAULT_PROPERTY, VERSION_DEFAULT_PROPERTY, VERSIONCOMMENT_DEFAULT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
EnvironmentArchive()
EnvironmentArchive(DeploymentArchive deploymentArchive) Create a Environment Archive from a Deployment Archive.
EnvironmentArchive(java.io.File archiveDirOrArchiveFile) Generate the EnvironmentArchive off a file or directory on disk.
EnvironmentArchive(java.io.File archiveDirOrArchiveFile, boolean createFromFedExtractDir) Generate the EnvironmentArchive off a file or directory on disk.
EnvironmentArchive(java.io.File entityStoreDir, java.util.Map<java.lang.String,java.lang.String> environmentRootProperties) Create the environment archive from:- a directory that contains the entity store files for the environment archive in-memory map of root properties
EnvironmentArchive(java.io.InputStream is) Create archive from stream.
EnvironmentArchive(java.lang.String archiveDirOrArchiveFilename) Generate the EnvironmentArchive off a file or directory on disk.
EnvironmentArchive(java.lang.String archiveDirOrArchiveFilename, boolean createFromFedExtractDir) Generate the EnvironmentArchive off a file or directory on disk.
EnvironmentArchive(java.lang.String entityStoreDirname, java.util.Map<java.lang.String,java.lang.String> environmentRootProperties) Create the environment archive from:- a directory that contains the entity store files for the environment archive in-memory map of root properties
EnvironmentArchive(java.net.URL url) Generate the EnvironmentArchive from a URL e.g.

Method Summary

Methods

Modifier and Type	Method and Description
com.vordel.es.fed.FederatedEntityStore	getEntityStore() Not supported for EnvironmentArchive.
java.lang.String	getFileExtension() Get the file extension for the archive, i.e.
protected void	refreshArchiveData(java.util.Map<java.lang.String,byte[]> idDirContents) This function takes the in-memory data and resets the archive data.

Methods inherited from class com.vordel.api.deployment.model.Archive

addBytesToArchive, addEntityStoreFilesFromDirToArchive, addEntityStoreFilesFromDirToArchive, addEntityStoreFilesToArchive, addEntityStoreFilesToArchive, addFileToArchive, addManifestToArchive, addStoreMD5, copyManifestToProperties, copyRootPropertiesAndSetNewDefaultProps, createNewManifest, extractContentToDir, extractContentToDir, extractContentToDir, generateRootProperties, getConfigurationAssemblyFile, getData, getDefaultProperties, getDefaultProperties, getDirectoryContentsFromArchive, getEmptyDefaultProperties, getFileContentsFromArchive, getId, getManifestFromArchive, getMergedStoreManager, getReadOnlyProperties, getRootManifestFromArchive, getRootProperties, isReadOnlyProperty, loadArchiveDataFromFile, loadArchiveDataFromStream, loadEnvironmentManifestFromDir, loadPolicyManifestFromDir, loadRootManifestFromDir, refreshArchiveData, setData, setRootProperties, updateRootProperties, writeToArchiveFile, writeToArchiveFile

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EXTENSION

public static final java.lang.String FILE_EXTENSION

See Also:

Constant Field Values

Constructor Detail

EnvironmentArchive

public EnvironmentArchive()

EnvironmentArchive

public EnvironmentArchive(java.net.URL url)
                   throws java.io.IOException

Generate the EnvironmentArchive from a URL e.g. file:/c:/temp/archive.env.

Parameters:

url - The url

Throws:

java.io.IOException

EnvironmentArchive

public EnvironmentArchive(java.lang.String archiveDirOrArchiveFilename)
                   throws java.io.IOException

Generate the EnvironmentArchive off a file or directory on disk.

Parameters:

archiveDirOrArchiveFile - The file or directory with .env file contents on disk

Throws:

java.io.IOException

EnvironmentArchive

public EnvironmentArchive(java.lang.String archiveDirOrArchiveFilename,
                  boolean createFromFedExtractDir)
                   throws java.io.IOException,
                          EntityStoreException

Generate the EnvironmentArchive off a file or directory on disk.

Parameters:

archiveDirOrArchiveFile - The file or directory with .env file contents on disk

createFromFedExtractDir - If true, and we are loading from a directory, the directory must have full .fed file content (not .env file content).

Throws:

java.io.IOException

EntityStoreException

EnvironmentArchive

public EnvironmentArchive(java.io.File archiveDirOrArchiveFile)
                   throws java.io.IOException

Generate the EnvironmentArchive off a file or directory on disk.

Parameters:

archiveDirOrArchiveFile - The file or directory with .env file contents on disk

Throws:

java.io.IOException

EnvironmentArchive

public EnvironmentArchive(java.io.File archiveDirOrArchiveFile,
                  boolean createFromFedExtractDir)
                   throws java.io.IOException

Generate the EnvironmentArchive off a file or directory on disk.

Parameters:

archiveDirOrArchiveFile - The file or directory with .env file contents on disk

createFromFedExtractDir - If true, and we are loading from a directory, the directory must have full .fed file content (not .env file content).

Throws:

java.io.IOException

EnvironmentArchive

public EnvironmentArchive(java.lang.String entityStoreDirname,
                  java.util.Map<java.lang.String,java.lang.String> environmentRootProperties)
                   throws java.io.IOException,
                          EntityStoreException

Create the environment archive from:-

• a directory that contains the entity store files for the environment archive
• in-memory map of root properties

Parameters:

entityStoreDirname - Directory containing entity store files

rootProperties - Map of root properties

Throws:

java.io.IOException

EntityStoreException

EnvironmentArchive

public EnvironmentArchive(java.io.File entityStoreDir,
                  java.util.Map<java.lang.String,java.lang.String> environmentRootProperties)
                   throws java.io.IOException,
                          EntityStoreException

Create the environment archive from:-

• a directory that contains the entity store files for the environment archive
• in-memory map of root properties

Parameters:

entityStoreDir - Directory containing entity store files

environmentRootProperties - Map of root properties

Throws:

java.io.IOException

EntityStoreException

EnvironmentArchive

public EnvironmentArchive(java.io.InputStream is)
                   throws java.io.IOException

Create archive from stream.

Parameters:

is - The stream

Throws:

java.io.IOException

EnvironmentArchive

public EnvironmentArchive(DeploymentArchive deploymentArchive)
                   throws java.io.IOException,
                          EntityStoreException

Create a Environment Archive from a Deployment Archive.

Parameters:

deploymentArchive - The deployment archive

Throws:

IOException, - EntityStoreException

java.io.IOException

EntityStoreException

Method Detail

refreshArchiveData

protected void refreshArchiveData(java.util.Map<java.lang.String,byte[]> idDirContents)
                           throws java.io.IOException

This function takes the in-memory data and resets the archive data.

Specified by:

refreshArchiveData in class Archive

Throws:

java.io.IOException

getEntityStore

public com.vordel.es.fed.FederatedEntityStore getEntityStore()
                                                      throws java.io.IOException,
                                                             EntityStoreException

Not supported for EnvironmentArchive.

Overrides:

getEntityStore in class Archive

Returns:

The in-memory entity store.

Throws:

java.io.IOException

EntityStoreException

getFileExtension

public java.lang.String getFileExtension()

Description copied from class: Archive

Get the file extension for the archive, i.e. .fed, .pol or .env.

Specified by:

getFileExtension in class Archive

Returns:

The file extension.