com.vordel.api.deployment.model

Class DeploymentArchive

java.lang.Object

com.vordel.api.deployment.model.Archive

com.vordel.api.deployment.model.DeploymentArchive

public class DeploymentArchive
extends Archive

This class represents a Deployment Archive (.fed 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
DeploymentArchive()
DeploymentArchive(com.vordel.es.fed.FederatedEntityStore fedStore, java.util.Map<java.lang.String,java.lang.String> policyProperties, java.util.Map<java.lang.String,java.lang.String> environmentProperties) Construct a deployment archive from an entity store.
DeploymentArchive(java.io.File archiveDirOrArchiveFile) Generate the DeploymentArchive from a file or directory on disk.
DeploymentArchive(java.io.File archiveDirOrArchiveFile, boolean generateNewArchiveId) Generate the DeploymentArchive from a file or directory on disk.
DeploymentArchive(java.io.File entityStoreDir, java.util.Map<java.lang.String,java.lang.String> policyProperties, java.util.Map<java.lang.String,java.lang.String> environmentProperties) Create the archive from:- a directory that contains the entity store in-memory map of policy properties in-memory map of env properties
DeploymentArchive(java.io.InputStream is) Create archive from stream.
DeploymentArchive(PolicyArchive policyArchive, EnvironmentArchive environmentArchive) Create the archive from a PolicyArchive and a DeploymentArchive.
DeploymentArchive(PolicyArchive policyArchive, EnvironmentArchive environmentArchive, boolean checkForUnresolved) Create the archive from a PolicyArchive and a DeploymentArchive.
DeploymentArchive(java.lang.String archiveDirOrArchiveFilename) Generate the DeploymentArchive from a file or directory on disk.
DeploymentArchive(java.lang.String entityStoreDirname, java.util.Map<java.lang.String,java.lang.String> policyProperties, java.util.Map<java.lang.String,java.lang.String> environmentProperties) Create the archive from: a directory that contains the entity store in-memory map of policy properties in-memory map of env properties
DeploymentArchive(java.net.URL url) Generate the DeploymentArchive from a URL file:/c:/temp/archive.fed.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,EntityStore>	getComponentEntityStores(java.lang.String outputDirname) Extract archive contents to disk, and return 5 component stores contained in archive.
java.util.Map<java.lang.String,java.lang.String>	getEnvironmentProperties() Get environment properties.
java.lang.String	getFileExtension() Get the file extension for the archive, i.e.
java.util.Map<java.lang.String,java.lang.String>	getPolicyProperties() Get policy properties
com.vordel.es.fed.assembly.StoreManager	getStoreManager() Get a StoreManager from archive contents.
java.util.Set<PortableESPK>	getUnresolvedReferences() Get a list of unresolved references in the entity store in the archive.
protected void	refreshArchiveData(java.util.Map<java.lang.String,byte[]> idDirContents) This function takes the in-memory data and resets the archive data.
void	setEnvironmentProperties(java.util.Map<java.lang.String,java.lang.String> props) Set environment properties Do *not* use this method to update the policy properties in the archive binary data, use updateEnvironmentProperties() instead.
void	setPolicyProperties(java.util.Map<java.lang.String,java.lang.String> props) Set policy properties.
void	updateConfiguration(com.vordel.es.fed.FederatedEntityStore fedStore) Update the FederatedEntityStore and the underlying binary archive data.
void	updateEnvironmentProperties(java.util.Map<java.lang.String,java.lang.String> props) Update the environment properties and the underlying binary archive data.
void	updatePolicyProperties(java.util.Map<java.lang.String,java.lang.String> props) Update the policy properties and the underlying binary 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, getEntityStore, 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

DeploymentArchive

public DeploymentArchive()

DeploymentArchive

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

Generate the DeploymentArchive from a URL file:/c:/temp/archive.fed.

Parameters:

url - The url

Throws:

java.io.IOException

DeploymentArchive

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

Generate the DeploymentArchive from a file or directory on disk.

Parameters:

archiveDirOrArchiveFile - The file or directory with fed file contents on disk

Throws:

java.io.IOException

DeploymentArchive

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

Generate the DeploymentArchive from a file or directory on disk.

Parameters:

archiveDirOrArchiveFile - The file or directory with fed file contents on disk

Throws:

java.io.IOException

DeploymentArchive

public DeploymentArchive(java.io.File archiveDirOrArchiveFile,
                 boolean generateNewArchiveId)
                  throws java.io.IOException

Generate the DeploymentArchive from a file or directory on disk.

Parameters:

archiveDirOrArchiveFile - The file or directory with fed file contents on disk

generateNewArchiveId - If true, and we are loading from a directory, then generate a new id for the archive, i.e. do not use the id in the manifest.mf on disk.

Throws:

java.io.IOException

DeploymentArchive

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

Create archive from stream.

Parameters:

is - The stream

Throws:

java.io.IOException

DeploymentArchive

public DeploymentArchive(PolicyArchive policyArchive,
                 EnvironmentArchive environmentArchive)
                  throws java.io.IOException,
                         EntityStoreException

Create the archive from a PolicyArchive and a DeploymentArchive.

Parameters:

policyArchive - The Policy Archive

environmentArchive - The Environment Archive

Throws:

java.io.IOException

EntityStoreException

DeploymentArchive

public DeploymentArchive(PolicyArchive policyArchive,
                 EnvironmentArchive environmentArchive,
                 boolean checkForUnresolved)
                  throws java.io.IOException,
                         EntityStoreException

Create the archive from a PolicyArchive and a DeploymentArchive.

Parameters:

policyArchive - The Policy Archive

environmentArchive - The Environment Archive

checkForUnresolved - True if you wish to check for unresolved references and throw an exception if there are any.

Throws:

java.io.IOException

EntityStoreException

DeploymentArchive

public DeploymentArchive(java.lang.String entityStoreDirname,
                 java.util.Map<java.lang.String,java.lang.String> policyProperties,
                 java.util.Map<java.lang.String,java.lang.String> environmentProperties)
                  throws java.io.IOException

Create the archive from:

• a directory that contains the entity store
• in-memory map of policy properties
• in-memory map of env properties

Parameters:

entityStoreDirname - Directory name containing entity store files

policyProperties - Map of policy properties

environmentProperties - Map of environment properties

Throws:

java.io.IOException

DeploymentArchive

public DeploymentArchive(java.io.File entityStoreDir,
                 java.util.Map<java.lang.String,java.lang.String> policyProperties,
                 java.util.Map<java.lang.String,java.lang.String> environmentProperties)
                  throws java.io.IOException

Create the archive from:-

• a directory that contains the entity store
• in-memory map of policy properties
• in-memory map of env properties

Parameters:

entityStoreDirname - Directory containing entity store files

policyProperties - Map of policy properties

environmentProperties - Map of environment properties

Throws:

java.io.IOException

DeploymentArchive

public DeploymentArchive(com.vordel.es.fed.FederatedEntityStore fedStore,
                 java.util.Map<java.lang.String,java.lang.String> policyProperties,
                 java.util.Map<java.lang.String,java.lang.String> environmentProperties)
                  throws java.io.IOException,
                         EntityStoreException

Construct a deployment archive from an entity store.

Parameters:

fedStore - The entity store

policyProperties - Map of policy properties

environmentProperties - Map of environment properties

Throws:

java.io.IOException

EntityStoreException

Method Detail

getUnresolvedReferences

public java.util.Set<PortableESPK> getUnresolvedReferences()
                                                    throws EntityStoreException,
                                                           java.io.IOException

Get a list of unresolved references in the entity store in the archive.

Returns:

A set of unresolved references, will have size of 0 if no unresolved references.

Throws:

EntityStoreException

java.io.IOException

updatePolicyProperties

public void updatePolicyProperties(java.util.Map<java.lang.String,java.lang.String> props)
                            throws java.io.IOException

Update the policy properties and the underlying binary archive data.

Parameters:

props -

Throws:

java.io.IOException

updateEnvironmentProperties

public void updateEnvironmentProperties(java.util.Map<java.lang.String,java.lang.String> props)
                                 throws java.io.IOException

Update the environment properties and the underlying binary archive data.

Parameters:

props -

Throws:

java.io.IOException

updateConfiguration

public void updateConfiguration(com.vordel.es.fed.FederatedEntityStore fedStore)
                         throws java.io.IOException,
                                EntityStoreException

Update the FederatedEntityStore and the underlying binary archive data.

Parameters:

fedStore -

Throws:

java.io.IOException

EntityStoreException

refreshArchiveData

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

Description copied from class: Archive

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

Specified by:

refreshArchiveData in class Archive

Throws:

java.io.IOException

getPolicyProperties

public java.util.Map<java.lang.String,java.lang.String> getPolicyProperties()

Get policy properties

Returns:

Map of policy properties

setPolicyProperties

public void setPolicyProperties(java.util.Map<java.lang.String,java.lang.String> props)

Set policy properties. Do *not* use this method to update the env properties in the archive binary data, use updatePolicyProperties() instead.

Parameters:

props -

getEnvironmentProperties

public java.util.Map<java.lang.String,java.lang.String> getEnvironmentProperties()

Get environment properties.

Returns:

Map of environment properties

setEnvironmentProperties

public void setEnvironmentProperties(java.util.Map<java.lang.String,java.lang.String> props)

Set environment properties Do *not* use this method to update the policy properties in the archive binary data, use updateEnvironmentProperties() instead.

Parameters:

props -

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.

getComponentEntityStores

public java.util.Map<java.lang.String,EntityStore> getComponentEntityStores(java.lang.String outputDirname)
                                                                     throws java.io.IOException,
                                                                            EntityStoreException

Extract archive contents to disk, and return 5 component stores contained in archive.

Parameters:

outputDirname - The name of the directory to extract the archive to

Returns:

Map of store type to store

Throws:

java.io.IOException

EntityStoreException

getStoreManager

public com.vordel.es.fed.assembly.StoreManager getStoreManager()
                                                        throws java.io.IOException

Get a StoreManager from archive contents.

Returns:

Throws:

java.io.IOException