Class WebPBEConfig

  • All Implemented Interfaces:
    PBECleanablePasswordConfig, PBEConfig
    Direct Known Subclasses:
    WebStringPBEConfig

    public class WebPBEConfig
    extends SimplePBEConfig

    Implementation for PBEConfig which can be used from the Web PBE Config infrastructure (Filter + Servlet) to set the password for an encryptor from the web at initialization time.

    For an encryptor to be assigned a password from the web, it only has to be assigned a WebPBEConfig object, which must be initialized with both a unique name an a validation word. The name will identify the config object (and thus the encryptor) and the validation word will make sure that only an authorized person (for example, the application deployer) sets the passwords.

    As this class extends SimplePBEConfig, parameter values can be also set with the usual setX methods.

    For any of the configuration parameters, if its setX method is not called, a null value will be returned by the corresponding getX method.

    Since:
    1.3
    • Field Detail

      • name

        private java.lang.String name
      • validationWord

        private java.lang.String validationWord
    • Constructor Detail

      • WebPBEConfig

        public WebPBEConfig()

        Creates a new WebPBEConfig instance.

    • Method Detail

      • getName

        public java.lang.String getName()

        Returns the name by which this WebPBEConfig object will be identified from the web. This name must be unique for each WebPBEConfig object.

        Returns:
        the config name.
      • setName

        public void setName​(java.lang.String name)

        Sets the name by which this WebPBEConfig object will be identified from the web. This name must be unique for each WebPBEConfig object.

        Parameters:
        name - the unique name which will identify this config object.
      • getValidationWord

        public java.lang.String getValidationWord()

        Returns the validation word which will be asked from the web to the person setting the password for the encryptor this config object belongs to. This validation word will make sure that only an authorized person (for example, the application deployer) sets the value for the encryption password.

        Returns:
        the validation word assigned to this config object
      • setValidationWord

        public void setValidationWord​(java.lang.String validation)

        Sets the validation word which will be asked from the web to the person setting the password for the encryptor this config object belongs to. This validation word will make sure that only an authorized person (for example, the application deployer) sets the value for the encryption password.

        Parameters:
        validation - the validation word to be assigned to this config object
      • isComplete

        public boolean isComplete()

        Returns whether this config object is complete or not (both name and validation word have been set). Intended for internal use only.

        Returns:
        whether the config object is complete or not.