com.vordel.api.deployment.model

Class Archive

java.lang.Object

com.vordel.api.deployment.model.Archive

Direct Known Subclasses:

DeploymentArchive, EnvironmentArchive, PolicyArchive

public abstract class Archive
extends java.lang.Object

Base class for Deployment, Policy and Environment Archive classes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANGEDBY_PROPERTY
protected static java.lang.String	CONFIGS
protected byte[]	data The byte data of the archive file.
static java.lang.String	DESCRIPTION_DEFAULT_PROPERTY
static java.lang.String	ENV_SETTINGS_STORE
static java.lang.String	ENVIRONMENT_MANIFEST_FILE
protected static java.util.List<java.lang.String>	environmentStoreTypes
static java.lang.String	ID_DEFAULT_PROPERTY
static java.lang.String	MANIFEST_DIR
static java.lang.String	MANIFEST_FILE
static java.lang.String	NAME_DEFAULT_PROPERTY
static java.lang.String	POLICY_MANIFEST_FILE
protected static java.util.List<java.lang.String>	policyStoreTypes
protected java.util.Map<java.lang.String,java.lang.String>	rootProperties Name-value property pairs
static java.lang.String	TIMESTAMP_DEFAULT_PROPERTY
static java.lang.String	VERSION_DEFAULT_PROPERTY
static java.lang.String	VERSIONCOMMENT_DEFAULT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
Archive()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBytesToArchive(java.lang.String jarEntryfilename, byte[] bytes, java.util.jar.JarOutputStream jarOs) Add byte content to archive.
protected void	addEntityStoreFilesFromDirToArchive(java.io.File entityStoreDir, boolean includePolicy, boolean includeEnvironment, java.util.jar.JarOutputStream jarOs) Add entity store files (e.g.
protected void	addEntityStoreFilesFromDirToArchive(java.io.File entityStoreDir, boolean includePolicy, boolean includeEnvironment, java.util.jar.JarOutputStream jarOs, java.util.List<java.lang.String> excludedStores) Add entity store files (e.g.
protected void	addEntityStoreFilesToArchive(java.util.Map<java.lang.String,byte[]> dirContents, boolean includePolicy, boolean includeEnvironment, java.util.jar.JarOutputStream jarOs) Add entity store files (e.g.
protected void	addEntityStoreFilesToArchive(java.util.Map<java.lang.String,byte[]> dirContents, boolean includePolicy, boolean includeEnvironment, java.util.jar.JarOutputStream jarOs, java.util.List<java.lang.String> excludedStores) Add entity store files (e.g.
protected void	addFileToArchive(java.lang.String jarEntryfilename, java.io.File sourceFile, java.util.jar.JarOutputStream jarOs) Add a file to the archive.
protected void	addManifestToArchive(java.lang.String jarEntryfilename, java.util.jar.Manifest manifest, java.util.jar.JarOutputStream jarOs) Add manifest to archive.
protected void	addStoreMD5(java.lang.String url, byte[] unzippedStoreData, java.util.jar.JarOutputStream jarOs) Add MD5 for a store to the archive.
protected void	copyManifestToProperties(java.util.jar.Manifest manifest, java.util.Map<java.lang.String,java.lang.String> properties) Copy manifest contents to property map.
protected void	copyRootPropertiesAndSetNewDefaultProps(java.util.Map<java.lang.String,java.lang.String> toCopyProperties) Copy a set of properties to the archive's root properties without overwriting any existing root properties.
static java.util.jar.Manifest	createNewManifest(java.util.Map<java.lang.String,java.lang.String> properties) Create a new manifest from a map of properties
java.io.File	extractContentToDir(java.io.File destinationDir) Extract the content of the archive to a directory on disk
java.io.File	extractContentToDir(java.io.File destinationDir, boolean preserveDirStructure) Extract the content of the archive to a directory on disk
java.io.File	extractContentToDir(java.lang.String destinationDirname) Extract the content of the archive to a directory on disk.
protected java.util.Map<java.lang.String,java.lang.String>	generateRootProperties() Generate new root properties, i.e.
protected java.io.File	getConfigurationAssemblyFile(java.io.File destinationDir, boolean preserveDirStructure) Get the configs.xml file in a directory.
byte[]	getData() Get the byte data of the archive file.
static java.util.Collection<java.lang.String>	getDefaultProperties() Get a list of the default system properties names.
static java.util.Map<java.lang.String,java.lang.String>	getDefaultProperties(java.lang.String name, java.lang.String description, java.lang.String version, java.lang.String versionComment) Get a map of default system archive manifest properties populated with values passed into this method.
protected java.util.Map<java.lang.String,byte[]>	getDirectoryContentsFromArchive(java.lang.String dirname) Get the directory contents from the archive.
static java.util.Map<java.lang.String,java.lang.String>	getEmptyDefaultProperties() Get a map of default system archive manifest properties with no values set.
com.vordel.es.fed.FederatedEntityStore	getEntityStore() Get an in-memory entity store for federated entity store data held in archive.
protected byte[]	getFileContentsFromArchive(java.lang.String filename) Get file contents from the archive.
abstract java.lang.String	getFileExtension() Get the file extension for the archive, i.e.
java.lang.String	getId() Get the archive id.
protected java.util.jar.Manifest	getManifestFromArchive(java.lang.String manifestFilename) Get a manifest from the archive.
protected com.vordel.es.fed.assembly.StoreManager	getMergedStoreManager(com.vordel.es.fed.assembly.StoreManager policyStoreManager, com.vordel.es.fed.assembly.StoreManager environmentStoreManager) Used when construct a DeploymentArchive from a PolicyArchive and an EnvironmentArchive to create a merged StoreManager, i.e.
static java.util.Collection<java.lang.String>	getReadOnlyProperties() Get a list of read-only archive manifest properties, i.e.
protected java.util.jar.Manifest	getRootManifestFromArchive() Get the root manifest file from the archive.
java.util.Map<java.lang.String,java.lang.String>	getRootProperties() Get the archive root manifest properties.
static boolean	isReadOnlyProperty(java.lang.String name) Check if a manifest property is read-only or not.
protected byte[]	loadArchiveDataFromFile(java.io.File archiveFile) Load archive data from File.
protected byte[]	loadArchiveDataFromStream(java.io.InputStream is) Load archive data from stream.
protected java.util.jar.Manifest	loadEnvironmentManifestFromDir(java.io.File sourceDir) Load manifest-environment.mf contents from a directory into a Manifest object.
protected java.util.jar.Manifest	loadPolicyManifestFromDir(java.io.File sourceDir) Load manifest-policy.mf contents from a directory into a manifest object.
protected java.util.jar.Manifest	loadRootManifestFromDir(java.io.File sourceDir) Load root manifest.mf contents from a directory into a Manifest object.
protected void	refreshArchiveData() This function takes the in-memory data and resets the archive data.
protected abstract void	refreshArchiveData(java.util.Map<java.lang.String,byte[]> idDirContents) This function takes the in-memory data and resets the archive data.
void	setData(byte[] data) Set the byte data of the archive file.
void	setRootProperties(java.util.Map<java.lang.String,java.lang.String> props) Set the root manifest properties.
void	updateRootProperties(java.util.Map<java.lang.String,java.lang.String> props) Update the root properties and the underlying binary archive data.
java.io.File	writeToArchiveFile(java.io.File output) Write the archive to a file on disk.
java.io.File	writeToArchiveFile(java.lang.String outputDirname) Write the archive to a file on disk.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_DEFAULT_PROPERTY

public static final java.lang.String NAME_DEFAULT_PROPERTY

See Also:

Constant Field Values

DESCRIPTION_DEFAULT_PROPERTY

public static final java.lang.String DESCRIPTION_DEFAULT_PROPERTY

See Also:

Constant Field Values

VERSION_DEFAULT_PROPERTY

public static final java.lang.String VERSION_DEFAULT_PROPERTY

See Also:

Constant Field Values

VERSIONCOMMENT_DEFAULT_PROPERTY

public static final java.lang.String VERSIONCOMMENT_DEFAULT_PROPERTY

See Also:

Constant Field Values

ID_DEFAULT_PROPERTY

public static final java.lang.String ID_DEFAULT_PROPERTY

See Also:

Constant Field Values

TIMESTAMP_DEFAULT_PROPERTY

public static final java.lang.String TIMESTAMP_DEFAULT_PROPERTY

See Also:

Constant Field Values

CHANGEDBY_PROPERTY

public static final java.lang.String CHANGEDBY_PROPERTY

See Also:

Constant Field Values

CONFIGS

protected static final java.lang.String CONFIGS

See Also:

Constant Field Values

MANIFEST_DIR

public static final java.lang.String MANIFEST_DIR

See Also:

Constant Field Values

MANIFEST_FILE

public static final java.lang.String MANIFEST_FILE

See Also:

Constant Field Values

POLICY_MANIFEST_FILE

public static final java.lang.String POLICY_MANIFEST_FILE

See Also:

Constant Field Values

ENVIRONMENT_MANIFEST_FILE

public static final java.lang.String ENVIRONMENT_MANIFEST_FILE

See Also:

Constant Field Values

ENV_SETTINGS_STORE

public static final java.lang.String ENV_SETTINGS_STORE

See Also:

Constant Field Values

policyStoreTypes

protected static java.util.List<java.lang.String> policyStoreTypes

environmentStoreTypes

protected static java.util.List<java.lang.String> environmentStoreTypes

rootProperties

protected java.util.Map<java.lang.String,java.lang.String> rootProperties

Name-value property pairs

data

protected byte[] data

The byte data of the archive file.

Constructor Detail

Archive

public Archive()

Method Detail

getFileExtension

public abstract java.lang.String getFileExtension()

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

Returns:

The file extension.

getId

public java.lang.String getId()

Get the archive id.

Returns:

Id

getData

public byte[] getData()

Get the byte data of the archive file.

Returns:

setData

public void setData(byte[] data)

Set the byte data of the archive file. Used to reconstruct after serialisation.

getRootProperties

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

Get the archive root manifest properties.

Returns:

Map of properties

setRootProperties

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

Set the root manifest properties. Used by Jersey. Do *not* use this method to update the root properties in the archive binary data, use updateRootProperties() instead.

Parameters:

props -

updateRootProperties

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

Update the root properties and the underlying binary archive data.

Parameters:

props -

Throws:

java.io.IOException

writeToArchiveFile

public java.io.File writeToArchiveFile(java.lang.String outputDirname)
                                throws java.io.IOException

Write the archive to a file on disk.

Parameters:

outputDirname - A file or directory name. If this is a directory the file will be named using the archive id, e.g. dir/archive-id.fed.

Returns:

The archive file

Throws:

java.io.IOException

writeToArchiveFile

public java.io.File writeToArchiveFile(java.io.File output)
                                throws java.io.IOException

Write the archive to a file on disk.

Parameters:

output - A file or directory. If this is a directory the file will be named using the archive id, e.g. dir/archive-id.fed.

Returns:

The archive file

Throws:

java.io.IOException

extractContentToDir

public java.io.File extractContentToDir(java.lang.String destinationDirname)
                                 throws java.io.IOException

Extract the content of the archive to a directory on disk.

Parameters:

destinationDirname - The directory to extract to

Returns:

The configs.xml file that has been extracted

Throws:

java.io.IOException

extractContentToDir

public java.io.File extractContentToDir(java.io.File destinationDir)
                                 throws java.io.IOException

Extract the content of the archive to a directory on disk

Parameters:

destinationDir - The directory to extract to

Returns:

The configs.xml file that has been extracted

Throws:

java.io.IOException

extractContentToDir

public java.io.File extractContentToDir(java.io.File destinationDir,
                               boolean preserveDirStructure)
                                 throws java.io.IOException

Extract the content of the archive to a directory on disk

Parameters:

destinationDir - The directory to extract to

preserveDirStructure - Maintain archive directory structure when extract

Returns:

The configs.xml file that has been extracted

Throws:

java.io.IOException

getEntityStore

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

Get an in-memory entity store for federated entity store data held in archive.

Returns:

The in-memory entity store.

Throws:

java.io.IOException

EntityStoreException

createNewManifest

public static java.util.jar.Manifest createNewManifest(java.util.Map<java.lang.String,java.lang.String> properties)

Create a new manifest from a map of properties

Parameters:

properties - The properties

Returns:

The newly created manifest

getReadOnlyProperties

public static java.util.Collection<java.lang.String> getReadOnlyProperties()

Get a list of read-only archive manifest properties, i.e. Id and Timestamp.

Returns:

The list of read-only properties

isReadOnlyProperty

public static boolean isReadOnlyProperty(java.lang.String name)

Check if a manifest property is read-only or not.

Parameters:

name - The name of the property to check

Returns:

True if property is read-only.

getDefaultProperties

public static java.util.Map<java.lang.String,java.lang.String> getDefaultProperties(java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.lang.String version,
                                                                    java.lang.String versionComment)

Get a map of default system archive manifest properties populated with values passed into this method.

Parameters:

name - Value for the default Name property.

description - Value for the default Description property.

version - Value for the default Version property.

versionComment - Value for the default VersionComment property.

Returns:

The map of properties

getEmptyDefaultProperties

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

Get a map of default system archive manifest properties with no values set.

Returns:

The map of properties

getDefaultProperties

public static java.util.Collection<java.lang.String> getDefaultProperties()

Get a list of the default system properties names.

Returns:

List of property names

copyRootPropertiesAndSetNewDefaultProps

protected void copyRootPropertiesAndSetNewDefaultProps(java.util.Map<java.lang.String,java.lang.String> toCopyProperties)

Copy a set of properties to the archive's root properties without overwriting any existing root properties.

Parameters:

toCopyProperties - The properties to copy into the archive's root properties.

loadRootManifestFromDir

protected java.util.jar.Manifest loadRootManifestFromDir(java.io.File sourceDir)
                                                  throws java.io.IOException

Load root manifest.mf contents from a directory into a Manifest object.

Parameters:

sourceDir - Directory to load manifest file from

Returns:

The manifest

Throws:

java.io.IOException

loadPolicyManifestFromDir

protected java.util.jar.Manifest loadPolicyManifestFromDir(java.io.File sourceDir)
                                                    throws java.io.IOException

Load manifest-policy.mf contents from a directory into a manifest object.

Parameters:

sourceDir - Directory to load manifest file from

Returns:

The manifest

Throws:

java.io.IOException

loadEnvironmentManifestFromDir

protected java.util.jar.Manifest loadEnvironmentManifestFromDir(java.io.File sourceDir)
                                                         throws java.io.IOException

Load manifest-environment.mf contents from a directory into a Manifest object.

Parameters:

sourceDir - Directory to load manifest file from

Returns:

The manifest

Throws:

java.io.IOException

generateRootProperties

protected java.util.Map<java.lang.String,java.lang.String> generateRootProperties()

Generate new root properties, i.e. update Id and Timestamp.

Returns:

getMergedStoreManager

protected com.vordel.es.fed.assembly.StoreManager getMergedStoreManager(com.vordel.es.fed.assembly.StoreManager policyStoreManager,
                                                            com.vordel.es.fed.assembly.StoreManager environmentStoreManager)
                                                                 throws EntityStoreException

Used when construct a DeploymentArchive from a PolicyArchive and an EnvironmentArchive to create a merged StoreManager, i.e. configs.xml. The primary, listeners and ext conn stores are taken from the .pol and the users and cert stores are taken from the .env to create the merged configs.xml for the .fed. The env settings store is merged separately.

Parameters:

policyStoreManager - The store manager for configs.xml from the PolicyArchive

environmentStoreManager - The store manager for configs.xml from the EnvironmentArchive

Returns:

Throws:

EntityStoreException

getFileContentsFromArchive

protected byte[] getFileContentsFromArchive(java.lang.String filename)
                                     throws java.io.IOException

Get file contents from the archive.

Parameters:

filename - The name of the file in the archive

Returns:

The file byt content

Throws:

java.io.IOException

getDirectoryContentsFromArchive

protected java.util.Map<java.lang.String,byte[]> getDirectoryContentsFromArchive(java.lang.String dirname)
                                                                          throws java.io.IOException

Get the directory contents from the archive.

Parameters:

dirname - The name of the directory in the archive

Returns:

A map of filename to file bute content

Throws:

java.io.IOException

getRootManifestFromArchive

protected java.util.jar.Manifest getRootManifestFromArchive()
                                                     throws java.io.IOException

Get the root manifest file from the archive.

Returns:

The Manifest

Throws:

java.io.IOException

getManifestFromArchive

protected java.util.jar.Manifest getManifestFromArchive(java.lang.String manifestFilename)
                                                 throws java.io.IOException

Get a manifest from the archive.

Parameters:

manifestFilename - The name of the manifest file.

Returns:

The Manifest

Throws:

java.io.IOException

getConfigurationAssemblyFile

protected java.io.File getConfigurationAssemblyFile(java.io.File destinationDir,
                                        boolean preserveDirStructure)
                                             throws java.io.IOException

Get the configs.xml file in a directory.

Parameters:

destinationDir - The directory the configs.xml resides in.

preserveDirStructure -

Returns:

Throws:

java.io.IOException

copyManifestToProperties

protected void copyManifestToProperties(java.util.jar.Manifest manifest,
                            java.util.Map<java.lang.String,java.lang.String> properties)

Copy manifest contents to property map.

Parameters:

manifest - The manifest.

properties - The properties to copy the manifest details into.,

loadArchiveDataFromFile

protected byte[] loadArchiveDataFromFile(java.io.File archiveFile)
                                  throws java.io.IOException

Load archive data from File.

Parameters:

archiveFile - The archive file.

Returns:

Archive byte data

Throws:

java.io.IOException

loadArchiveDataFromStream

protected byte[] loadArchiveDataFromStream(java.io.InputStream is)
                                    throws java.io.IOException

Load archive data from stream.

Parameters:

is - The stream.

Returns:

Archive byte data.

Throws:

java.io.IOException

addEntityStoreFilesFromDirToArchive

protected void addEntityStoreFilesFromDirToArchive(java.io.File entityStoreDir,
                                       boolean includePolicy,
                                       boolean includeEnvironment,
                                       java.util.jar.JarOutputStream jarOs)
                                            throws java.io.IOException

Add entity store files (e.g. PrimaryStore.xml etc.), contained in a directory to the archive.

Parameters:

entityStoreDir - The directory that contains the entity store files.

includePolicy - Include "policy" entity store files, i.e. Primary, External Connections, and Listeners.

includeEnvironment - Include "environment" entity store files, i.e. Certificates and Users.

jarOs - The archive output stream

Throws:

java.io.IOException

addEntityStoreFilesFromDirToArchive

protected void addEntityStoreFilesFromDirToArchive(java.io.File entityStoreDir,
                                       boolean includePolicy,
                                       boolean includeEnvironment,
                                       java.util.jar.JarOutputStream jarOs,
                                       java.util.List<java.lang.String> excludedStores)
                                            throws java.io.IOException

Add entity store files (e.g. PrimaryStore.xml etc.), contained in a directory to the archive.

Parameters:

entityStoreDir - The directory that contains the entity store files.

includePolicy - Include "policy" entity store files, i.e. Primary, External Connections, and Listeners.

includeEnvironment - Include "environment" entity store files, i.e. Certificates and Users.

jarOs - The archive output stream

excludedStores - Entity store types to exclude when adding to archive. Used to exclude EnvSettingsStore.xml as this is managed differently.

Throws:

java.io.IOException

addEntityStoreFilesToArchive

protected void addEntityStoreFilesToArchive(java.util.Map<java.lang.String,byte[]> dirContents,
                                boolean includePolicy,
                                boolean includeEnvironment,
                                java.util.jar.JarOutputStream jarOs)
                                     throws java.io.IOException

Add entity store files (e.g. PrimaryStore.xml etc.), contained in a map to the archive.

Parameters:

dirContents - The map of entity store files.

includePolicy - Include "policy" entity store files, i.e. Primary, External Connections, and Listeners.

includeEnvironment - Include "environment" entity store files, i.e. Certificates and Users.

jarOs - The archive output stream

Throws:

java.io.IOException

addEntityStoreFilesToArchive

protected void addEntityStoreFilesToArchive(java.util.Map<java.lang.String,byte[]> dirContents,
                                boolean includePolicy,
                                boolean includeEnvironment,
                                java.util.jar.JarOutputStream jarOs,
                                java.util.List<java.lang.String> excludedStores)
                                     throws java.io.IOException

Add entity store files (e.g. PrimaryStore.xml etc.), contained in a map to the archive.

Parameters:

dirContents - The map of entity store files.

includePolicy - Include "policy" entity store files, i.e. Primary, External Connections, and Listeners.

includeEnvironment - Include "environment" entity store files, i.e. Certificates and Users.

jarOs - The archive output stream

excludedStores - Entity store types to exclude when adding to archive. Used to exclude EnvSettingsStore.xml as this is managed differently. *

Throws:

java.io.IOException

addFileToArchive

protected void addFileToArchive(java.lang.String jarEntryfilename,
                    java.io.File sourceFile,
                    java.util.jar.JarOutputStream jarOs)
                         throws java.io.IOException

Add a file to the archive.

Parameters:

jarEntryfilename - The name of the entry in the archive

sourceFile - The file to add

jarOs - The archive output stream

Throws:

java.io.IOException

addManifestToArchive

protected void addManifestToArchive(java.lang.String jarEntryfilename,
                        java.util.jar.Manifest manifest,
                        java.util.jar.JarOutputStream jarOs)
                             throws java.io.IOException

Add manifest to archive.

Parameters:

jarEntryfilename - The name of the entry in the archive

manifest - The manifest to add.

jarOs - The archive output stream

Throws:

java.io.IOException

addBytesToArchive

protected void addBytesToArchive(java.lang.String jarEntryfilename,
                     byte[] bytes,
                     java.util.jar.JarOutputStream jarOs)
                          throws java.io.IOException

Add byte content to archive.

Parameters:

jarEntryfilename - The name of the entry in the archive

bytes - The bytes to add to the archive.

jarOs - The archive output stream

Throws:

java.io.IOException

addStoreMD5

protected void addStoreMD5(java.lang.String url,
               byte[] unzippedStoreData,
               java.util.jar.JarOutputStream jarOs)
                    throws java.io.IOException

Add MD5 for a store to the archive.

Parameters:

url - The url of the store file

unzippedStoreData - The store data, not zipped

jarOs - The archive output stream

Throws:

java.io.IOException

refreshArchiveData

protected void refreshArchiveData()
                           throws java.io.IOException

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

Throws:

java.io.IOException

refreshArchiveData

protected abstract 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.

Throws:

java.io.IOException