Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

<field type="..." variable="...">
    <spec>
        ...
        <processor class="fully.qualified.ProcessorClassName" [backupVariable="..."]>
            <configuration>
                <param name="whatever-param-name" value="..."/>
                <param name="another-param2-name" value="..."/>
                ...

            </configuration>
        </processor>
    </spec>
    <validator class="fully.qualified.ValidatorClassName" txt="..." id="..."/>
</field>

Attributes

  • backupVariable (optional):
    a variable holding the original value entered by the user before processing took place
    This variable is not present before the processor action actually happens.

Built-in processors

Build-in processors are available in IzPack in the package com.izforge.izpack.panels.userinput.processor.

The following processors are available by default in IzPack:

PasswordEncryptionProcessor

This processor encrypts a given password using the Java Cryptography Architecture.

Configuration parameters:

  • encryptionKey (required)
    A string acting a seed for generating a secure random number generator used for encryption. This is also called a secret key.

  • algorithm (required)
    The name of the encryption algorithm to be used.
    The available algorithms depend on your JRE, see this documentation for more information.

PortProcessor

This processor can be add to a simple input field (1 part) or a rule input field of the form host:port (2 parts). It takes in both cases the given value for the port and tries to check whether this port is available either locally (1-part field) or at the given host (2-part rule field).

If the port is not available it automatically increases it by 1 and tries the same again until it finds a free port, which is used as the final, processed value.

This processor takes no configuration parameters.

UnixGroupProcessor

This processor does not use the user input at all, but generates a list of available UNIX groups (scanned from the file /etc/group) as a single string with ':' as the separator character.

UnixUserProcessor

This processor does not use the user input at all, but generates a list of available UNIX users (scanned from the file /etc/passwd) as a single string with ':' as the separator character.

Example

The following example defines a simple password input panel for entering a new password, for example for a database to be created:

...