Package org.apache.derby.iapi.services.property

Interface PropertyFactory

  • All Known Implementing Classes:
    PropertyValidation
    public interface PropertyFactory
    Module interface for an Property validation.

    An PropertyFactory is typically obtained from the Monitor: 

            // Get the current validation factory.
        PropertyFactory af;
        af = (PropertyFactory) Monitor.findServiceModule(this, org.apache.derby.iapi.reference.Module.PropertyFactory);

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addPropertySetNotification​(PropertySetCallback who)
      Add a callback for a change in any property value.
      java.io.Serializable doMap​(java.lang.String key, java.io.Serializable value, java.util.Dictionary set)
      Call the property set callbacks to map a proposed property value to a value to save.
      java.io.Serializable doValidateApplyAndMap​(TransactionController tc, java.lang.String key, java.io.Serializable value, java.util.Dictionary d, boolean dbOnlyProperty)  
      void validateSingleProperty​(java.lang.String key, java.io.Serializable value, java.util.Dictionary set)
      validation a single property
      void verifyPropertySet​(java.util.Properties p, java.util.Properties ignore)
      Validate a Property set.

    • Method Detail

      • addPropertySetNotification

        void addPropertySetNotification​(PropertySetCallback who)
        Add a callback for a change in any property value.
        The callback is made in the context of the transaction making the change.
        Parameters:
        who - which object is called

      • verifyPropertySet

        void verifyPropertySet​(java.util.Properties p,
                       java.util.Properties ignore)
                throws StandardException
        Validate a Property set.

        Validate a Property set by calling all the registered property set notification functions with .

        Parameters:
        p - Properties to validate.
        ignore - Properties to not validate in p. Usefull for properties that may not be set after boot.
        Throws:
        StandardException - Throws if p fails a check.

      • validateSingleProperty

        void validateSingleProperty​(java.lang.String key,
                            java.io.Serializable value,
                            java.util.Dictionary set)
                     throws StandardException
        validation a single property
        Throws:
        StandardException

      • doMap

        java.io.Serializable doMap​(java.lang.String key,
                           java.io.Serializable value,
                           java.util.Dictionary set)
                    throws StandardException
        Call the property set callbacks to map a proposed property value to a value to save.

        The caller must run this in a block synchronized on this to serialize validations with changes to the set of property callbacks

        Throws:
        StandardException