Interface ISourceConfigStore

  • All Superinterfaces:
    java.io.Serializable
    All Known Subinterfaces:
    IConfigStore

    public interface ISourceConfigStore
    extends java.io.Serializable
    An interface that represents the source that creates the configuration store tree. Note that the tree can be built based on the information from a text file or ldap entries.
    Version:
    $Revision$, $Date$
    See Also:
    IConfigStore
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clear()
      Clear the config store.
      java.lang.String get​(java.lang.String name)
      Gets a property.
      java.util.Enumeration<java.lang.String> keys()
      Returns an enumeration of the config store's keys.
      void load​(java.io.InputStream in)
      Reads a config store from an input stream.
      java.lang.String put​(java.lang.String name, java.lang.String value)
      Retrieves a property.
      void save​(java.io.OutputStream out, java.lang.String header)
      Stores this config store to the specified output stream.
    • Method Detail

      • get

        java.lang.String get​(java.lang.String name)
        Gets a property.

        Parameters:
        name - The property name
        Returns:
        property value
      • put

        java.lang.String put​(java.lang.String name,
                             java.lang.String value)
        Retrieves a property.

        Parameters:
        name - The property name
        value - The property value
      • keys

        java.util.Enumeration<java.lang.String> keys()
        Returns an enumeration of the config store's keys.

        Returns:
        a list of keys
        See Also:
        Hashtable.elements(), Enumeration
      • clear

        void clear()
        Clear the config store.
      • load

        void load​(java.io.InputStream in)
           throws java.io.IOException
        Reads a config store from an input stream.
        Parameters:
        in - input stream where the properties are located
        Throws:
        java.io.IOException - If an IO error occurs while loading from input.
      • save

        void save​(java.io.OutputStream out,
                  java.lang.String header)
        Stores this config store to the specified output stream.
        Parameters:
        out - output stream where the properties should be serialized
        header - optional header to be serialized