Package org.wildfly.prospero.api

Class InstallationMetadata

java.lang.Object

org.wildfly.prospero.api.InstallationMetadata

All Implemented Interfaces:

AutoCloseable

public class InstallationMetadata
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GALLEON_INSTALLATION_DIR
static final String	PROVISIONING_FILE_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InstallationMetadata(Path base, org.wildfly.channel.ChannelManifest manifest, ProsperoConfig prosperoConfig, GitStorage gitStorage, Optional<org.wildfly.prospero.metadata.ManifestVersionRecord> currentVersions, org.jboss.galleon.api.config.GalleonProvisioningConfig provisioningConfig)

Method Summary

Modifier and Type	Method	Description
void	close()
Path	exportMetadataBundle(Path location)
org.eclipse.aether.artifact.Artifact	find(org.eclipse.aether.artifact.Artifact gav)
static InstallationMetadata	fromMetadataBundle(Path archiveLocation)	read the metadata from an exported zip containing configuration files
List<org.eclipse.aether.artifact.Artifact>	getArtifacts()
InstallationChanges	getChangesIn(SavedState savedState)
InstallationChanges	getChangesToCurrent(SavedState savedState)
org.jboss.galleon.api.config.GalleonProvisioningConfig	getGalleonProvisioningConfig()
org.wildfly.channel.ChannelManifest	getManifest()
Optional<org.wildfly.prospero.metadata.ManifestVersionRecord>	getManifestVersions()
ProsperoConfig	getProsperoConfig()
org.jboss.galleon.api.config.GalleonProvisioningConfig	getRecordedProvisioningConfig()	galleon configuration used to provision current state of the server.
List<SavedState>	getRevisions()
InstallationMetadata	getSavedState(SavedState savedState)
static InstallationMetadata	loadInstallation(Path base)	load the metadata of an existing installation.
static InstallationMetadata	newInstallation(Path base, org.wildfly.channel.ChannelManifest manifest, ProsperoConfig prosperoConfig, Optional<org.wildfly.prospero.metadata.ManifestVersionRecord> currentVersions)	create an in-memory installation metadata.
void	recordProvision(boolean overrideProsperoConfig)
void	recordProvision(boolean overrideProsperoConfig, boolean gitRecord)
void	setManifest(org.wildfly.channel.ChannelManifest resolvedChannel)
void	updateProsperoConfig(ProsperoConfig config)
void	updateProvisioningConfiguration()	check if the provisioning definition is present.

Methods inherited from class java.lang.Object

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

Field Details

PROVISIONING_FILE_NAME

public static final String PROVISIONING_FILE_NAME

See Also:

• Constant Field Values

GALLEON_INSTALLATION_DIR

public static final String GALLEON_INSTALLATION_DIR

See Also:

• Constant Field Values

Constructor Details

InstallationMetadata

protected InstallationMetadata(Path base,
 org.wildfly.channel.ChannelManifest manifest,
 ProsperoConfig prosperoConfig,
 GitStorage gitStorage,
 Optional<org.wildfly.prospero.metadata.ManifestVersionRecord> currentVersions,
 org.jboss.galleon.api.config.GalleonProvisioningConfig provisioningConfig)
                        throws MetadataException

Throws:

MetadataException

Method Details

loadInstallation

public static InstallationMetadata loadInstallation(Path base)
                                             throws MetadataException

load the metadata of an existing installation. If the history is not available, it will be started.

Parameters:

base -

Returns:

Throws:

MetadataException

newInstallation

public static InstallationMetadata newInstallation(Path base,
 org.wildfly.channel.ChannelManifest manifest,
 ProsperoConfig prosperoConfig,
 Optional<org.wildfly.prospero.metadata.ManifestVersionRecord> currentVersions)
                                            throws MetadataException

create an in-memory installation metadata. No information is recorded until recordProvision(boolean) is called.

Parameters:

base -

manifest -

prosperoConfig -

currentVersions - - manifest versions used to provision the installation

Returns:

Throws:

MetadataException

fromMetadataBundle

public static InstallationMetadata fromMetadataBundle(Path archiveLocation)
                                               throws IOException,
MetadataException

read the metadata from an exported zip containing configuration files

Parameters:

archiveLocation - path to the exported zip

Returns:

Throws:

IOException

MetadataException

exportMetadataBundle

public Path exportMetadataBundle(Path location)
                          throws IOException

Throws:

IOException

getManifest

public org.wildfly.channel.ChannelManifest getManifest()

getGalleonProvisioningConfig

public org.jboss.galleon.api.config.GalleonProvisioningConfig getGalleonProvisioningConfig()

recordProvision

public void recordProvision(boolean overrideProsperoConfig)
                     throws MetadataException

Throws:

MetadataException

recordProvision

public void recordProvision(boolean overrideProsperoConfig,
 boolean gitRecord)
                     throws MetadataException

Throws:

MetadataException

updateProvisioningConfiguration

public void updateProvisioningConfiguration()
                                     throws MetadataException

check if the provisioning definition is present. If not add it to the history

Throws:

MetadataException

getRevisions

public List<SavedState> getRevisions()
                              throws MetadataException

Throws:

MetadataException

getSavedState

public InstallationMetadata getSavedState(SavedState savedState)
                                   throws MetadataException

Throws:

MetadataException

getChangesIn

public InstallationChanges getChangesIn(SavedState savedState)
                                 throws MetadataException

Throws:

MetadataException

getChangesToCurrent

public InstallationChanges getChangesToCurrent(SavedState savedState)
                                        throws MetadataException

Throws:

MetadataException

setManifest

public void setManifest(org.wildfly.channel.ChannelManifest resolvedChannel)

getArtifacts

public List<org.eclipse.aether.artifact.Artifact> getArtifacts()

find

public org.eclipse.aether.artifact.Artifact find(org.eclipse.aether.artifact.Artifact gav)

getProsperoConfig

public ProsperoConfig getProsperoConfig()

updateProsperoConfig

public void updateProsperoConfig(ProsperoConfig config)
                          throws MetadataException

Throws:

MetadataException

getManifestVersions

public Optional<org.wildfly.prospero.metadata.ManifestVersionRecord> getManifestVersions()

close

public void close()

Specified by:

close in interface AutoCloseable

getRecordedProvisioningConfig

public org.jboss.galleon.api.config.GalleonProvisioningConfig getRecordedProvisioningConfig()

galleon configuration used to provision current state of the server.

Returns: