Package net.shibboleth.idp.installer.impl

Class CurrentInstallStateImpl

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.installer.impl.CurrentInstallStateImpl

All Implemented Interfaces:

CurrentInstallState, Component, DestructableComponent, InitializableComponent

public final class CurrentInstallStateImpl
extends AbstractInitializableComponent
implements CurrentInstallState

Tells the installers about the current install state.

Field Summary

Fields

Modifier and Type	Field	Description
private final String[][]	deleteAfterUpgrades	The files we will delete if they created on upgrade.
private Set<String>	enabledModules	The module IDs which are enabled.
private boolean	idpPropertiesPresent	Whether the IdP properties file exists.
private ClassLoader	installedPluginsLoader	The classloader for "us plus the plugins in the target".
private boolean	ldapPropertiesPresent	Whether the LDAP properties file exists.
private final org.slf4j.Logger	log	Class logger.
private String	oldVersion	Old Version.
private List<Path>	pathsToDelete	The files to delete after an upgrade.
private Properties	props	Previous props.
private boolean	systemPresent	Whether system is present.
private final Path	targetDir	Where we are installing to.

Fields inherited from interface net.shibboleth.idp.installer.CurrentInstallState

V3_VERSION

Constructor Summary

Constructors

Constructor	Description
CurrentInstallStateImpl(InstallerProperties installerProps)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
private void	findEnabledModules()	Populate {enabledModules from the current classpath and the new IdP home.
private void	findPreviousVersion()	Work out what the "current" install state is (before we do any more work).
Properties	getCurrentlyInstalledProperties()	Get the properties associated with the current configuration.
Collection<String>	getEnabledModules()	Which modules (by ID) are enabled for this release.
ClassLoader	getInstalledPluginsLoader()	Build a classpath loader which adds all the plugins in.
String	getInstalledVersion()	What is the installer version.
List<Path>	getPathsToBeDeleted()	Return the list of paths of files which were not there prior to the install but which might be created by the installed but to no purpose.
boolean	isIdPPropertiesPresent()	Was idp.properties present in the target file when we started the install?
boolean	isLDAPPropertiesPresent()	Was ldapp.properties present in the target file when we started the install?
boolean	isSystemPresent()	If this is an upgrade were there files in %{idp.home}system? If so then we need to copy the files in.
private void	setupPreviousProps()	Populate {props from idp.properties and other files pointed to by "idp.additionalProperties".

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

targetDir

private final Path targetDir

Where we are installing to.

deleteAfterUpgrades

private final String[][] deleteAfterUpgrades

The files we will delete if they created on upgrade.

enabledModules

private Set<String> enabledModules

The module IDs which are enabled.

idpPropertiesPresent

private boolean idpPropertiesPresent

Whether the IdP properties file exists.

ldapPropertiesPresent

private boolean ldapPropertiesPresent

Whether the LDAP properties file exists.

systemPresent

private boolean systemPresent

Whether system is present.

oldVersion

private String oldVersion

Old Version.

props

private Properties props

Previous props.

pathsToDelete

@NonnullAfterInit
private List<Path> pathsToDelete

The files to delete after an upgrade.

installedPluginsLoader

@Nullable
private ClassLoader installedPluginsLoader

The classloader for "us plus the plugins in the target".

Constructor Details

CurrentInstallStateImpl

public CurrentInstallStateImpl(InstallerProperties installerProps)

Constructor.

Parameters:

installerProps - the installer situation.

Method Details

findPreviousVersion

private void findPreviousVersion()
                          throws ComponentInitializationException

Work out what the "current" install state is (before we do any more work).

Throws:

ComponentInitializationException - if we find a strange state

setupPreviousProps

private void setupPreviousProps()
                         throws ComponentInitializationException

Populate {props from idp.properties and other files pointed to by "idp.additionalProperties".

Throws:

ComponentInitializationException - on various IO issues

findEnabledModules

private void findEnabledModules()

Populate {enabledModules from the current classpath and the new IdP home.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

getInstalledVersion

@Nullable
public String getInstalledVersion()

What is the installer version.

Specified by:

getInstalledVersion in interface CurrentInstallState

Returns:

"3" for a V3 install, null for a new install or the value we wrote during last install.

isIdPPropertiesPresent

public boolean isIdPPropertiesPresent()

Was idp.properties present in the target file when we started the install?

Specified by:

isIdPPropertiesPresent in interface CurrentInstallState

Returns:

if it was.

isLDAPPropertiesPresent

public boolean isLDAPPropertiesPresent()

Was ldapp.properties present in the target file when we started the install?

Specified by:

isLDAPPropertiesPresent in interface CurrentInstallState

Returns:

if it was.

getCurrentlyInstalledProperties

@Nullable
public Properties getCurrentlyInstalledProperties()

Get the properties associated with the current configuration. This comes idp.properties and anything it points to via "idp.additionalProperties".

Specified by:

getCurrentlyInstalledProperties in interface CurrentInstallState

Returns:

the properties, or null if this is a new install.

getPathsToBeDeleted

public List<Path> getPathsToBeDeleted()

Return the list of paths of files which were not there prior to the install but which might be created by the installed but to no purpose.

Specified by:

getPathsToBeDeleted in interface CurrentInstallState

Returns:

the list of paths.

isSystemPresent

public boolean isSystemPresent()

If this is an upgrade were there files in %{idp.home}system? If so then we need to copy the files in. Otherwise not. For new installs this is false

Specified by:

isSystemPresent in interface CurrentInstallState

Returns:

whether the old install has %{idp.home}\system

getEnabledModules

@Nonnull
public Collection<String> getEnabledModules()

Which modules (by ID) are enabled for this release.

Specified by:

getEnabledModules in interface CurrentInstallState

Returns:

those modules enabled.

getInstalledPluginsLoader

public ClassLoader getInstalledPluginsLoader()

Build a classpath loader which adds all the plugins in.

Specified by:

getInstalledPluginsLoader in interface CurrentInstallState

Returns:

a classloader