Package net.shibboleth.idp.installer

Interface InstallerProperties

All Superinterfaces:

Component, InitializableComponent

All Known Implementing Classes:

InstallerPropertiesImpl

public interface InstallerProperties
extends InitializableComponent

Interface to describe simply parameterization and status of the installation.

Field Summary

Fields

Modifier and Type	Field	Description
static Set<String>	DEFAULT_MODULES	Those modules enabled by default.

Method Summary

Modifier and Type	Method	Description
Path	getConfPreOverlay()	Get a directory to use to "pre-overlay" the conf directory.
String	getCredentialsGroup()	Group to set on all files in credentials and conf.
String	getCredentialsKeyFileMode()	Mode to set on all files in credentials.
String	getEntityID()	Get the EntityId for this install.
String	getHostName()	Get the host name for this install.
Path	getIdPMergeProperties()	Get the a file to merge with idp.properties or null.
Path	getInitialEditWeb()	Get a path to use to do the initial edit-webapp populate.
int	getKeySize()	Get the key size for signing, encryption and backchannel.
String	getKeyStorePassword()	Get the password for the keystore for this installation.
Path	getLDAPMergeProperties()	Get the a file to merge with ldap.properties or null.
String	getLDAPPassword()	Get the LDAP password iff one was provided.
default Set<String>	getModulesToEnable()	Get the modules to enable after first install.
String	getScope()	Get the scope for this installation.
String	getSealerAlias()	Get the alias for the sealer key.
String	getSealerPassword()	Get the password for the sealer for this installation.
Path	getSourceDir()	Where is the install coming from?
String	getSubjectAltName()	Get the SubjectAltName for the certificates.
Path	getTargetDir()	Get where we are installing/updating/building the war.
boolean	isNoTidy()	Does the user want us to *not* tidy up.
boolean	isSetGroupAndMode()	Do we set the mode?

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

initialize, isInitialized

Field Detail

DEFAULT_MODULES

static final Set<String> DEFAULT_MODULES

Those modules enabled by default.

Method Detail

getTargetDir

@Nonnull
Path getTargetDir()
           throws org.apache.tools.ant.BuildException

Get where we are installing/updating/building the war.

Returns:

the target directory

Throws:

org.apache.tools.ant.BuildException - if something goes awry.

isNoTidy

boolean isNoTidy()

Does the user want us to *not* tidy up.

Returns:

do we not tidy up?

getCredentialsKeyFileMode

@Nonnull
String getCredentialsKeyFileMode()

Mode to set on all files in credentials.

Returns:

the mode

getCredentialsGroup

@Nullable
String getCredentialsGroup()

Group to set on all files in credentials and conf.

Returns:

the mode or null if none to be set

isSetGroupAndMode

@Nonnull
boolean isSetGroupAndMode()

Do we set the mode?

Returns:

do we the mode

getSourceDir

@Nullable
Path getSourceDir()

Where is the install coming from?

Returns:

the source directory

getEntityID

@Nonnull
String getEntityID()

Get the EntityId for this install.

Returns:

the name.

getHostName

@Nonnull
String getHostName()

Get the host name for this install.

Returns:

the host name.

getScope

@Nonnull
String getScope()

Get the scope for this installation.

Returns:

The scope.

getSubjectAltName

@Nonnull
String getSubjectAltName()

Get the SubjectAltName for the certificates.

Returns:

the SubjectAltName

getKeyStorePassword

@Nonnull
String getKeyStorePassword()

Get the password for the keystore for this installation.

Returns:

the password.

getSealerPassword

@Nonnull
String getSealerPassword()

Get the password for the sealer for this installation.

Returns:

the password.

getSealerAlias

@Nonnull
String getSealerAlias()

Get the alias for the sealer key.

Returns:

the alias

getKeySize

int getKeySize()

Get the key size for signing, encryption and backchannel.

Returns:

the keysize

getIdPMergeProperties

@Nullable
Path getIdPMergeProperties()
                    throws org.apache.tools.ant.BuildException

Get the a file to merge with idp.properties or null.

Returns:

the file or null if it none required.

Throws:

org.apache.tools.ant.BuildException - if badness happens

getLDAPMergeProperties

@Nullable
Path getLDAPMergeProperties()
                     throws org.apache.tools.ant.BuildException

Get the a file to merge with ldap.properties or null.

Returns:

the path or null if it none required.

Throws:

org.apache.tools.ant.BuildException - if badness happens

getLDAPPassword

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

Get the LDAP password iff one was provided. DO NOT PROMPT

Returns:

the password if provided by a properties

Throws:

org.apache.tools.ant.BuildException - if badness happens

getConfPreOverlay

@Nullable
Path getConfPreOverlay()
                throws org.apache.tools.ant.BuildException

Get a directory to use to "pre-overlay" the conf directory. Files will be copied from here if they don't already exist in conf, before the files are copied from the distribution.

Returns:

the path or null if non specified.

Throws:

org.apache.tools.ant.BuildException - if badness happens

getInitialEditWeb

@Nullable
Path getInitialEditWeb()
                throws org.apache.tools.ant.BuildException

Get a path to use to do the initial edit-webapp populate.

Returns:

the path or null if non specified.

Throws:

org.apache.tools.ant.BuildException - if badness happens

getModulesToEnable

@Nonnull
default Set<String> getModulesToEnable()

Get the modules to enable after first install.

Returns:

the modules