Package net.shibboleth.idp.installer

Interface CurrentInstallState

All Superinterfaces:

Component, InitializableComponent

All Known Implementing Classes:

CurrentInstallStateImpl

public interface CurrentInstallState
extends InitializableComponent

Tells the installers about the current install state.

Field Summary

Fields

Modifier and Type	Field	Description
static String	V3_VERSION	What to return if this is V3.

Method Summary

Modifier and Type	Method	Description
Properties	getCurrentlyInstalledProperties()	Get the properties associated with the current configuration.
default Collection<String>	getEnabledModules()	Which modules (by ID) are enabled for this release.
default 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?
default boolean	isSystemPresent()	If this is an upgrade were there files in %{idp.home}system? If so then we need to copy the files in.

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

initialize, isInitialized

Field Detail

V3_VERSION

static final String V3_VERSION

What to return if this is V3.

See Also:

Constant Field Values

Method Detail

getInstalledVersion

@Nullable
String getInstalledVersion()
                    throws org.apache.tools.ant.BuildException

What is the installer version.

Returns:

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

Throws:

org.apache.tools.ant.BuildException - if we find an inconsistency

isIdPPropertiesPresent

boolean isIdPPropertiesPresent()

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

Returns:

if it was.

isLDAPPropertiesPresent

boolean isLDAPPropertiesPresent()

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

Returns:

if it was.

getCurrentlyInstalledProperties

@Nullable
Properties getCurrentlyInstalledProperties()

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

Returns:

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

getPathsToBeDeleted

@Nonnull
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.

Returns:

the list of paths.

isSystemPresent

default 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

Returns:

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

getEnabledModules

@Nonnull
default Collection<String> getEnabledModules()

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

Returns:

those modules enabled.

getInstalledPluginsLoader

default ClassLoader getInstalledPluginsLoader()

Build a classpath loader which adds all the plugins in.

Returns:

a classloader