Package com.ibm.di.api.local

Interface TDIProperties

  • All Known Implementing Classes:
    TDIPropertiesImpl
    public interface TDIProperties
    Local server API interface to TDIProperties. Wrapper API to expose the functionality available from com.ibm.di.config.interface.TDIProperties
    See Also:
    TDIProperties

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addPropertyStore​(PropertyStoreConfig config)
      Adds a property store to the end of the list of TDI-P's list of property stores.
      void commit()
      Does a commit on all property stores.
      TDIPropertyStore getDefaultStore()
      Returns the default property store.
      TDIPropertyStore getPasswordStore()
      Returns the password store.
      java.lang.Object getProperty​(java.lang.String key)
      Gets the property value from the property store chosen by TDIProperties.
      java.lang.Object getProperty​(java.lang.String propertyStoreName, java.lang.String key)
      Returns the property value from the named property store.
      TDIPropertyStore getPropertyStore​(java.lang.String name)
      Returns the named property store.
      java.lang.String[] getPropertyStoreKeys​(java.lang.String propertyStoreName)
      Returns an array containing all the property keys in the named property store.
      java.util.List<java.lang.String> getPropertyStoreNames()
      Returns a list of property store names in use by TDI-P.
      void insertPropertyStore​(PropertyStoreConfig config, int atIndex)
      Inserts a connector interface at the given index.
      boolean isPropertyEncrypted​(java.lang.String propertyStoreName, java.lang.String key)
      Returns whether specified property is encrypted or not.
      void removeProperty​(java.lang.String propertyStoreName, java.lang.String key)
      Removes a property in the named property store.
      void removePropertyStore​(java.lang.String propertyStoreName)
      Removes a property store from TDI-P.
      void setDefaultStore​(TDIPropertyStore defaultStore)
      Sets the default property store.
      void setPasswordStore​(TDIPropertyStore passwordStore)
      Sets the password store.
      TDIPropertyStore setProperty​(java.lang.String key, java.lang.Object value)
      Sets the property in the property store chosen by TDIProperties.
      TDIPropertyStore setProperty​(java.lang.String key, java.lang.Object value, boolean protect)
      Sets the property in the property store chosen by TDIProperties.
      void setProperty​(java.lang.String propertyStoreName, java.lang.String key, java.lang.Object value)
      Sets the property in the named property store.
      void setProperty​(java.lang.String propertyStoreName, java.lang.String key, java.lang.Object value, boolean protect)
      Sets the property in the named property store.
      java.lang.String trimKey​(java.lang.String key)
      Trims the key from a given string.

    • Method Detail

      • commit

        void commit()
     throws java.lang.Exception
        Does a commit on all property stores.
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • getProperty

        java.lang.Object getProperty​(java.lang.String key)
                      throws java.lang.Exception
        Gets the property value from the property store chosen by TDIProperties.
        Parameters:
        key - The property name
        Returns:
        The property value
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • setProperty

        TDIPropertyStore setProperty​(java.lang.String key,
                             java.lang.Object value)
                      throws java.lang.Exception
        Sets the property in the property store chosen by TDIProperties.
        Parameters:
        key - The property name
        value - The new property value
        Returns:
        the TDIPropertyStore to which the key/value pair was written
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • setProperty

        TDIPropertyStore setProperty​(java.lang.String key,
                             java.lang.Object value,
                             boolean protect)
                      throws java.lang.Exception
        Sets the property in the property store chosen by TDIProperties.
        Parameters:
        key - The property name
        value - The new property value
        protect - True if value should be protected (driver dependent)
        Returns:
        the TDIPropertyStore to which the key/value pair was written
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • setProperty

        void setProperty​(java.lang.String propertyStoreName,
                 java.lang.String key,
                 java.lang.Object value)
          throws java.lang.Exception
        Sets the property in the named property store.
        Parameters:
        propertyStoreName - The name of the property store
        key - The property name
        value - The new property value
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • setProperty

        void setProperty​(java.lang.String propertyStoreName,
                 java.lang.String key,
                 java.lang.Object value,
                 boolean protect)
          throws java.lang.Exception
        Sets the property in the named property store.
        Parameters:
        propertyStoreName - The name of the property store
        key - The property name
        value - The new property value
        protect - True if value should be protected (driver dependent)
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • removeProperty

        void removeProperty​(java.lang.String propertyStoreName,
                    java.lang.String key)
             throws java.lang.Exception
        Removes a property in the named property store.
        Parameters:
        propertyStoreName - The name of the property store
        key - The property to delete
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • getProperty

        java.lang.Object getProperty​(java.lang.String propertyStoreName,
                             java.lang.String key)
                      throws java.lang.Exception
        Returns the property value from the named property store.
        Parameters:
        propertyStoreName - The name of the property store
        key - The property value
        Returns:
        The property value
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • getPropertyStoreKeys

        java.lang.String[] getPropertyStoreKeys​(java.lang.String propertyStoreName)
                                 throws java.lang.Exception
        Returns an array containing all the property keys in the named property store.
        Parameters:
        propertyStoreName - The name of the property store
        Returns:
        The propertyStoreKeys value
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • getPropertyStoreNames

        java.util.List<java.lang.String> getPropertyStoreNames()
                                                throws java.lang.Exception
        Returns a list of property store names in use by TDI-P.
        Returns:
        The propertyStoreNames value
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • getDefaultStore

        TDIPropertyStore getDefaultStore()
                          throws java.lang.Exception
        Returns the default property store.
        Returns:
        the default property store
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • getPasswordStore

        TDIPropertyStore getPasswordStore()
                           throws java.lang.Exception
        Returns the password store.
        Returns:
        the password store
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • getPropertyStore

        TDIPropertyStore getPropertyStore​(java.lang.String name)
                           throws java.lang.Exception
        Returns the named property store.
        Parameters:
        name - the name of the property store
        Returns:
        the TDIPropertyStore with specified name
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • isPropertyEncrypted

        boolean isPropertyEncrypted​(java.lang.String propertyStoreName,
                            java.lang.String key)
                     throws java.lang.Exception
        Returns whether specified property is encrypted or not.
        Parameters:
        propertyStoreName - The name of the property store
        key - The property value
        Returns:
        true if this property is encrypted; false otherwise
        Throws:
        java.lang.Exception

      • addPropertyStore

        void addPropertyStore​(PropertyStoreConfig config)
               throws java.lang.Exception
        Adds a property store to the end of the list of TDI-P's list of property stores.
        Parameters:
        config - The property store configuration
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • insertPropertyStore

        void insertPropertyStore​(PropertyStoreConfig config,
                         int atIndex)
                  throws java.lang.Exception
        Inserts a connector interface at the given index. See addPropertyStore() for a description of parameters.
        Parameters:
        config - The property store configuration
        atIndex - The position where the new connector is placed (-1 = END, 0 = First)
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • removePropertyStore

        void removePropertyStore​(java.lang.String propertyStoreName)
                  throws java.lang.Exception
        Removes a property store from TDI-P. The connector interface is closed and then removed.
        Parameters:
        propertyStoreName - The name of the property store
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • setDefaultStore

        void setDefaultStore​(TDIPropertyStore defaultStore)
              throws java.lang.Exception
        Sets the default property store.
        Parameters:
        defaultStore - the new default property store
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • setPasswordStore

        void setPasswordStore​(TDIPropertyStore passwordStore)
               throws java.lang.Exception
        Sets the password store.
        Parameters:
        passwordStore - the new password store
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs

      • trimKey

        java.lang.String trimKey​(java.lang.String key)
                  throws java.lang.Exception
        Trims the key from a given string. For example trimKey("greeting:Hello, world!") will return the following string: "Hello, world!".
        Parameters:
        key - a string representing key:value pair
        Returns:
        string containing only the value
        Throws:
        java.lang.Exception - if Runtime or Security exception occurs