Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h1>Sample userInputSpec.xml</h1>

<p>Here's an example 3 panel userInputSpec.xml file. You specify the use of this XML document inside your install definition in the resource section like this (assuming your ant build.xml uses a property called build.dir):</p>

<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;userInput>
  &lt;!-- Install -->
    &lt;panel order="0">
        &lt;createForPack name="Main Application" />
        &lt;field type="title" txt="Import Keystores" bold="true" size="1" />
        &lt;field type="divider" align="top"/>
        &lt;!-- Keystore -->
        &lt;field type="staticText" align="left" txt="Existing SSL keystore to import:"/>
        &lt;field type="file" align="left" variable="existing.ssl.keystore">
          &lt;spec txt="" size="25" set=""/>
        &lt;/field>
        &lt;field type="space"/>
        &lt;!-- Truststore -->
        &lt;field type="staticText" align="left" txt="Existing SSL truststore to import:"/>
        &lt;field type="file" align="left" variable="existing.ssl.truststore">
          &lt;spec txt="" size="25" set=""/>
        &lt;/field>
        &lt;field type="space"/>
        &lt;!-- Signing Keystore -->
        &lt;field type="staticText" align="left" txt="Existing signing keystore to import:"/>
        &lt;field type="file" align="left" variable="existing.signing.keystore">
          &lt;spec txt="" size="25" set=""/>
        &lt;/field>
        &lt;field type="space"/>
        &lt;field type="divider" align="bottom"/>
    &lt;/panel> 
    &lt;panel order="1">
      &lt;!-- Validate access to keystores with information from last panel -->
        &lt;createForPack name="Main Application" />
        &lt;field type="title" txt="SSL Keystore Settings" bold="true" size="1" />
        &lt;field type="divider" align="bottom"/>
        &lt;!-- Skip validation in case customer has something wrong they want to fix later -->
        &lt;field type="check" align="left" variable="skip.keystore.validation">
          &lt;spec txt=" Skip keystore password validation (not recommended)" size="25" true="true" false="false" set="false"/>
        &lt;/field>
        &lt;field type="divider" align="top"/>
        &lt;!-- Keystore -->
        &lt;field type="combo" variable="existing.ssl.keystore.type">
          &lt;spec txt="Keystore type:" id="existing.ssl.keystore.type">
            &lt;choice txt="JKS" value="JKS" set="true"/>
            &lt;!--
            &lt;choice txt="PKCS12" value="PKCS12"/>
            -->
          &lt;/spec>
        &lt;/field>
        &lt;field type="space"/>
        &lt;field type="text" align="left" variable="keystore.key.alias">
            &lt;spec txt="Keystore Key Alias:" size="25" set="alias-1"/>
        &lt;/field>
        &lt;field type="password" align="left" variable="keystore.password">
          &lt;spec>
            &lt;pwd txt="Keystore Password:" size="25" set=""/>
            &lt;pwd txt="Retype Password:" size="25" set=""/>
          &lt;/spec>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordEqualityValidator" txt="Both keystore passwords must match." id="key for the error text"/>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordKeystoreValidator" txt="Could not validate keystore with password and alias provided." id="key for the error text">
            &lt;param name="keystoreFile" value="${existing.ssl.keystore}"/>
            &lt;param name="keystoreType" value="${existing.ssl.keystore.type}"/>
            &lt;param name="keystoreAlias" value="${keystore.key.alias}"/>
            &lt;param name="skipValidation" value="${skip.keystore.validation}"/>
          &lt;/validator>
        &lt;/field>
        &lt;field type="space"/>
        &lt;!-- Truststore -->
        &lt;field type="combo" variable="existing.ssl.truststore.type">
          &lt;spec txt="Truststore type:" id="existing.ssl.truststore.type">
            &lt;choice txt="JKS" value="JKS" set="true"/>
            &lt;!--
            &lt;choice txt="PKCS12" value="PKCS12"/>
            -->
          &lt;/spec>
        &lt;/field>
        &lt;field type="space"/>
        &lt;field type="password" align="left" variable="truststore.password">
          &lt;spec>
            &lt;pwd txt="Truststore Password:" size="25" set=""/>
            &lt;pwd txt="Retype Password:" size="25" set=""/>
          &lt;/spec>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordEqualityValidator" txt="Both truststore passwords must match." id="key for the error text"/>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordKeystoreValidator" txt="Could not validate keystore with password and alias provided." id="key for the error text">
            &lt;param name="keystoreFile" value="${existing.ssl.truststore}"/>
            &lt;param name="keystoreType" value="${existing.ssl.truststore.type}"/>
            &lt;param name="skipValidation" value="${skip.keystore.validation}"/>
          &lt;/validator>
        &lt;/field>
        &lt;field type="divider" align="bottom"/>
    &lt;/panel> 
    &lt;panel order="2">
      &lt;!-- Validate access to signing keystore with information from last panel -->
        &lt;createForPack name="Main Application" />
        &lt;field type="title" txt="Signing Keystore Settings" bold="true" size="1" />
        &lt;field type="divider" align="bottom"/>
        &lt;!-- Skip validation in case customer has something wrong they want to fix later -->
        &lt;field type="check" align="left" variable="skip.keystore.validation">
          &lt;spec txt=" Skip keystore password validation (not recommended)" size="20" true="true" false="false" set="false"/>
        &lt;/field>
        &lt;field type="divider" align="top"/>
        &lt;!-- Keystore -->
        &lt;field type="combo" variable="existing.signing.keystore.type">
          &lt;spec txt="Keystore type:" id="existing.signing.keystore.type">
            &lt;choice txt="JKS" value="JKS" set="true"/>
            &lt;!--
            &lt;choice txt="PKCS12" value="PKCS12"/>
            -->
          &lt;/spec>
        &lt;/field>
        &lt;field type="space"/>
        &lt;field type="password" align="left" variable="signing.keystore.password">
          &lt;spec>
            &lt;pwd txt="Keystore Password:" size="20" set=""/>
            &lt;pwd txt="Retype Password:" size="20" set=""/>
          &lt;/spec>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordEqualityValidator" txt="Both signing keystore passwords must match." id="key for the error text"/>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordKeystoreValidator" txt="Could not access keystore with password provided." id="key for the error text">
            &lt;param name="keystoreFile" value="${existing.signing.keystore}"/>
            &lt;param name="keystoreType" value="${existing.signing.keystore.type}"/>
            &lt;param name="skipValidation" value="${skip.keystore.validation}"/>
          &lt;/validator>
        &lt;/field>
        &lt;field type="space"/>
        &lt;!-- Signing Key 1 -->
        &lt;field type="text" align="left" variable="first.signing.keystore.key.alias">
            &lt;spec txt="First Signing Alias:" size="20" set="alias-1"/>
        &lt;/field>
        &lt;field type="password" align="left" variable="first.signing.password">
          &lt;spec>
            &lt;pwd txt="First Signing Password:" size="20" set=""/>
            &lt;pwd txt="Retype Password:" size="20" set=""/>
          &lt;/spec>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordEqualityValidator" txt="Both first signing key passwords must match." id="key for the error text"/>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordKeystoreValidator" txt="Could not validate keystore with password and first signing alias provided." id="key for the error text">
            &lt;param name="keystoreFile" value="${existing.signing.keystore}"/>
            &lt;param name="keystoreType" value="${existing.signing.keystore.type}"/>
            &lt;param name="keystorePassword" value="${signing.keystore.password}"/>
            &lt;param name="keystoreAlias" value="${first.signing.keystore.key.alias}"/>
            &lt;param name="skipValidation" value="${skip.keystore.validation}"/>
          &lt;/validator>
        &lt;/field>
        &lt;field type="space"/>
        &lt;!-- Signing Key 2 -->
        &lt;field type="text" align="left" variable="second.signing.keystore.key.alias">
            &lt;spec txt="Second Signing Alias:" size="20" set="crate-cmd-alias"/>
        &lt;/field>
        &lt;field type="password" align="left" variable="second.signing.password">
          &lt;spec>
            &lt;pwd txt="Second Signing Password:" size="20" set=""/>
            &lt;pwd txt="Retype Password:" size="20" set=""/>
          &lt;/spec>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordEqualityValidator" txt="Both second signing key passwords must match." id="key for the error text"/>
          &lt;validator class="com.izforge.izpack.panels.userinput.validator.PasswordKeystoreValidator" txt="Could not validate keystore with password and second signing alias provided." id="key for the error text">
            &lt;param name="keystoreFile" value="${existing.signing.keystore}"/>
            &lt;param name="keystoreType" value="${existing.signing.keystore.type}"/>
            &lt;param name="keystorePassword" value="${signing.keystore.password}"/>
            &lt;param name="keystoreAlias" value="${second.signing.keystore.key.alias}"/>
            &lt;param name="skipValidation" value="${skip.keystore.validation}"/>
          &lt;/validator>
        &lt;/field>
        &lt;field type="divider" align="bottom"/>
    &lt;/panel> 
&lt;/userInput></pre></td></tr></table>