Package org.apache.felix.webconsole.spi

Interface ConfigurationHandler

  • @ConsumerType
@Deprecated(since="2021-04-30")
public interface ConfigurationHandler
    Deprecated.
    The Apache Felix Webconsole is not supported in Cloud environments.
    A configuration handler allows to hook into the processing of configurations for the webconsole plugin. A handler can decide to hide configurations and properties but also implement additional validation. All configuration handlers are called in no particular order.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      void createConfiguration​(java.lang.String pid)
      Deprecated.
      A new configuration with that pid should be created
      void createFactoryConfiguration​(java.lang.String factoryPid, java.lang.String name)
      Deprecated.
      A new factory configuration with that pid should be created
      void deleteConfiguration​(java.lang.String factoryPid, java.lang.String pid)
      Deprecated.
      A configuration should be deleted
      default void filterProperties​(java.lang.String factoryPid, java.lang.String pid, java.util.Collection<java.lang.String> propertyNames)
      Deprecated.
      Filter the properties do be displayed.
      default boolean listConfiguration​(java.lang.String factoryPid, java.lang.String pid)
      Deprecated.
      A configuration should be listed
      void updateConfiguration​(java.lang.String factoryPid, java.lang.String pid, java.util.Dictionary<java.lang.String,​java.lang.Object> props)
      Deprecated.
      A configuration should be updated

    • Method Detail

      • createConfiguration

        void createConfiguration​(java.lang.String pid)
                  throws ValidationException,
                         java.io.IOException
        Deprecated.
        A new configuration with that pid should be created
        Parameters:
        pid - The pid
        Throws:
        java.io.IOException - For an error
        ValidationException - if creation is not allowed

      • createFactoryConfiguration

        void createFactoryConfiguration​(java.lang.String factoryPid,
                                java.lang.String name)
                         throws ValidationException,
                                java.io.IOException
        Deprecated.
        A new factory configuration with that pid should be created
        Parameters:
        factoryPid - The factory pid
        name - Optional name, might be null if unknown
        Throws:
        java.io.IOException - For an error
        ValidationException - if creation is not allowed

      • deleteConfiguration

        void deleteConfiguration​(java.lang.String factoryPid,
                         java.lang.String pid)
                  throws ValidationException,
                         java.io.IOException
        Deprecated.
        A configuration should be deleted
        Parameters:
        factoryPid - Optional factory pid
        pid - The pid
        Throws:
        java.io.IOException - For an error
        ValidationException - if deletion is not allowed

      • updateConfiguration

        void updateConfiguration​(java.lang.String factoryPid,
                         java.lang.String pid,
                         java.util.Dictionary<java.lang.String,​java.lang.Object> props)
                  throws ValidationException,
                         java.io.IOException
        Deprecated.
        A configuration should be updated
        Parameters:
        factoryPid - Optional factory pid
        pid - The pid
        props - Mutable dictionary
        Throws:
        java.io.IOException - For an error
        ValidationException - if updating is not allowed

      • listConfiguration

        default boolean listConfiguration​(java.lang.String factoryPid,
                                  java.lang.String pid)
                           throws java.io.IOException
        Deprecated.
        A configuration should be listed
        Parameters:
        factoryPid - Optional factory pid
        pid - The pid
        Returns:
        true if the configuration may be listed
        Throws:
        java.io.IOException - For an error
        Since:
        1.1

      • filterProperties

        default void filterProperties​(java.lang.String factoryPid,
                              java.lang.String pid,
                              java.util.Collection<java.lang.String> propertyNames)
                       throws java.io.IOException
        Deprecated.
        Filter the properties do be displayed. Properties that should be hidden can be removed from the passed in collection
        Parameters:
        factoryPid - Optional factory pid
        pid - The pid
        propertyNames - The mutable collection of property names
        Throws:
        java.io.IOException - For an error
        Since:
        1.1