org.jboss.as.patching.installation

Class InstallationManagerImpl

java.lang.Object

org.jboss.as.patching.installation.InstalledIdentity

org.jboss.as.patching.installation.InstallationManager

org.jboss.as.patching.installation.InstallationManagerImpl

public class InstallationManagerImpl
extends InstallationManager

The installation manager.

Author:

Emanuel Muckenhuber

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.as.patching.installation.InstallationManager

InstallationManager.InstallationModification, InstallationManager.ModificationCompletionCallback, InstallationManager.MutablePatchingTarget

Constructor Summary

Constructors

Constructor and Description
InstallationManagerImpl(InstalledIdentity installedIdentity)

Method Summary

Modifier and Type	Method and Description
void	clearRestartRequired() Clear the the restart required state.
AddOn	getAddOn(String addOnName) Get an add-on by name.
Collection<String>	getAddOnNames() Get a list of available add-on names.
Collection<AddOn>	getAddOns() Get a list of installed add-ons.
List<String>	getAllInstalledPatches() Get a list of all installed patches.
Identity	getIdentity() Get information about the installed identity.
InstalledImage	getInstalledImage() Get the installed image.
Layer	getLayer(String layerName) Get a layer by name.
List<String>	getLayerNames() Get a list of available layer names.
List<Layer>	getLayers() Get a list of installed layers.
protected static org.jboss.as.patching.installation.InstallationModificationImpl.InstallationState	load(InstalledIdentity installedIdentity) Load the installation state based on the identity
InstallationManager.InstallationModification	modifyInstallation(InstallationManager.ModificationCompletionCallback callback) Modify the installation.
boolean	requiresRestart() Check whether the instance requires a restart.
boolean	restartRequired() Require a restart.
protected InstalledIdentity	updateState(String name, org.jboss.as.patching.installation.InstallationModificationImpl modification, org.jboss.as.patching.installation.InstallationModificationImpl.InstallationState state) Update the installed identity using the modified state from the modification.

Methods inherited from class org.jboss.as.patching.installation.InstallationManager

load

Methods inherited from class org.jboss.as.patching.installation.InstalledIdentity

load, load

Methods inherited from class java.lang.Object

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

Constructor Detail

InstallationManagerImpl

public InstallationManagerImpl(InstalledIdentity installedIdentity)

Method Detail

getAllInstalledPatches

public List<String> getAllInstalledPatches()

Description copied from class: InstalledIdentity

Get a list of all installed patches.

Specified by:

getAllInstalledPatches in class InstalledIdentity

Returns:

the list of all installed patches

getIdentity

public Identity getIdentity()

Description copied from class: InstalledIdentity

Get information about the installed identity.

Specified by:

getIdentity in class InstalledIdentity

Returns:

the identity

getLayerNames

public List<String> getLayerNames()

Description copied from class: InstalledIdentity

Get a list of available layer names.

Specified by:

getLayerNames in class InstalledIdentity

Returns:

the available layers

getLayer

public Layer getLayer(String layerName)

Description copied from class: InstalledIdentity

Get a layer by name.

Specified by:

getLayer in class InstalledIdentity

Parameters:

layerName - the layer name

Returns:

the layer, null if there is no matching layer

getLayers

public List<Layer> getLayers()

Description copied from class: InstalledIdentity

Get a list of installed layers.

Specified by:

getLayers in class InstalledIdentity

Returns:

the installed layers

getAddOnNames

public Collection<String> getAddOnNames()

Description copied from class: InstalledIdentity

Get a list of available add-on names.

Specified by:

getAddOnNames in class InstalledIdentity

Returns:

the available add-ons

getAddOn

public AddOn getAddOn(String addOnName)

Description copied from class: InstalledIdentity

Get an add-on by name.

Specified by:

getAddOn in class InstalledIdentity

Parameters:

addOnName - the add-on name

Returns:

the add-on, null if is no matching add-on

getAddOns

public Collection<AddOn> getAddOns()

Description copied from class: InstalledIdentity

Get a list of installed add-ons.

Specified by:

getAddOns in class InstalledIdentity

Returns:

the installed add-ons

getInstalledImage

public InstalledImage getInstalledImage()

Description copied from class: InstalledIdentity

Get the installed image.

Specified by:

getInstalledImage in class InstalledIdentity

Returns:

the installed image

modifyInstallation

public InstallationManager.InstallationModification modifyInstallation(InstallationManager.ModificationCompletionCallback callback)

Description copied from class: InstallationManager

Modify the installation.

Specified by:

modifyInstallation in class InstallationManager

Parameters:

callback - a completed callback

Returns:

the modification

load

protected static org.jboss.as.patching.installation.InstallationModificationImpl.InstallationState load(InstalledIdentity installedIdentity)
                                                                                                 throws IOException

Load the installation state based on the identity

Parameters:

installedIdentity - the installed identity

Returns:

the installation state

Throws:

IOException

updateState

protected InstalledIdentity updateState(String name,
                                        org.jboss.as.patching.installation.InstallationModificationImpl modification,
                                        org.jboss.as.patching.installation.InstallationModificationImpl.InstallationState state)

Update the installed identity using the modified state from the modification.

Parameters:

name - the identity name

modification - the modification

state - the installation state

Returns:

the installed identity

requiresRestart

public boolean requiresRestart()

Description copied from class: InstallationManager

Check whether the instance requires a restart.

Specified by:

requiresRestart in class InstallationManager

Returns:

true if a restart is required, false otherwise

restartRequired

public boolean restartRequired()

Description copied from class: InstallationManager

Require a restart. This will set the patching service to read-only and the server has to be restarted in order to execute the next patch operation.

In case the patch operation does not succeed it needs to clear the reload required state using InstallationManager.clearRestartRequired().

Specified by:

restartRequired in class InstallationManager

Returns:

this will return true

clearRestartRequired

public void clearRestartRequired()

Description copied from class: InstallationManager

Clear the the restart required state.

Specified by:

clearRestartRequired in class InstallationManager