com.ibm.di.api.remote.impl
Class TDIPropertiesImpl

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              com.ibm.di.api.remote.impl.APIRemoteObject
                  com.ibm.di.api.remote.impl.TDIPropertiesImpl

All Implemented Interfaces:

TDIProperties, Serializable, Remote

public class TDIPropertiesImpl
extends APIRemoteObject
implements TDIProperties

Wrapper API to expose the functionality available from com.ibm.di.config.interfaces.TDIProperties.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Method Summary

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.
static TDIPropertiesImpl	createInstance(TDIProperties localTDIP, SessionImpl aSession) Creates TDIPropertiesImpl instance.
TDIPropertyStore	getDefaultStore() Returns the default property store.
TDIPropertyStore	getPasswordStore() Returns the password store.
Object	getProperty(String key) Gets the property value from the property store chosen by TDIProperties.
Object	getProperty(String propertyStoreName, String key) Returns the property value from the named property store.
TDIPropertyStore	getPropertyStore(String name) Returns the named property store.
String[]	getPropertyStoreKeys(String propertyStoreName) Returns an array containing all the property keys in the named property store.
List	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(String propertyStoreName, String key) Returns whether specified property is encrypted or not.
void	removeProperty(String propertyStoreName, String key) Removes a property in the named property store.
void	removePropertyStore(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(String key, Object value) Sets the property in the property store chosen by TDIProperties.
TDIPropertyStore	setProperty(String key, Object value, boolean protect) Sets the property in the property store chosen by TDIProperties.
void	setProperty(String propertyStoreName, String key, Object value) Sets the property in the named property store.
void	setProperty(String propertyStoreName, String key, Object value, boolean protect) Sets the property in the named property store.
String	trimKey(String key) Trims the key from a given string.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

commit

public void commit()
            throws RemoteException,
                   Exception

Does a commit on all property stores.

Specified by:

commit in interface TDIProperties

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

getProperty

public Object getProperty(String key)
                   throws RemoteException,
                          Exception

Gets the property value from the property store chosen by TDIProperties.

Specified by:

getProperty in interface TDIProperties

Parameters:

key - The property name

Returns:

The property value

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

setProperty

public TDIPropertyStore setProperty(String key,
                                    Object value)
                             throws RemoteException,
                                    Exception

Sets the property in the property store chosen by TDIProperties.

Specified by:

setProperty in interface TDIProperties

Parameters:

key - The property name

value - The new property value

Returns:

the TDIPropertyStore to which the key/value pair was written

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

setProperty

public TDIPropertyStore setProperty(String key,
                                    Object value,
                                    boolean protect)
                             throws RemoteException,
                                    Exception

Sets the property in the property store chosen by TDIProperties.

Specified by:

setProperty in interface 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:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

removeProperty

public void removeProperty(String propertyStoreName,
                           String key)
                    throws RemoteException,
                           Exception

Removes a property in the named property store.

Specified by:

removeProperty in interface TDIProperties

Parameters:

propertyStoreName - The name of the property store

key - The property to delete

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

getProperty

public Object getProperty(String propertyStoreName,
                          String key)
                   throws RemoteException,
                          Exception

Returns the property value from the named property store.

Specified by:

getProperty in interface TDIProperties

Parameters:

propertyStoreName - The name of the property store

key - The property value

Returns:

The property value

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

setProperty

public void setProperty(String propertyStoreName,
                        String key,
                        Object value)
                 throws RemoteException,
                        Exception

Sets the property in the named property store.

Specified by:

setProperty in interface TDIProperties

Parameters:

propertyStoreName - The name of the property store

key - The property name

value - The new property value

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

getPropertyStoreKeys

public String[] getPropertyStoreKeys(String propertyStoreName)
                              throws RemoteException,
                                     Exception

Returns an array containing all the property keys in the named property store.

Specified by:

getPropertyStoreKeys in interface TDIProperties

Parameters:

propertyStoreName - The name of the property store

Returns:

The propertyStoreKeys value

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

addPropertyStore

public void addPropertyStore(PropertyStoreConfig config)
                      throws RemoteException,
                             Exception

Adds a property store to the end of the list of TDI-P's list of property stores.

Specified by:

addPropertyStore in interface TDIProperties

Parameters:

config - The property store configuration

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

insertPropertyStore

public void insertPropertyStore(PropertyStoreConfig config,
                                int atIndex)
                         throws RemoteException,
                                Exception

Inserts a connector interface at the given index. See addPropertyStore() for a description of parameters.

Specified by:

insertPropertyStore in interface TDIProperties

Parameters:

config - The property store configuration

atIndex - The position where the new connector is placed (-1 = END, 0 = First)

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

removePropertyStore

public void removePropertyStore(String propertyStoreName)
                         throws RemoteException,
                                Exception

Removes a property store from TDI-P. The connector interface is closed and then removed.

Specified by:

removePropertyStore in interface TDIProperties

Parameters:

propertyStoreName - The name of the property store

Throws:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

getPropertyStoreNames

public List getPropertyStoreNames()
                           throws Exception,
                                  RemoteException

Returns a list of property store names in use by TDI-P.

Specified by:

getPropertyStoreNames in interface TDIProperties

Returns:

The propertyStoreNames value

Throws:

Exception - if Runtime or Security exception occurs

RemoteException - if a communication-related exception occurs.

getDefaultStore

public TDIPropertyStore getDefaultStore()
                                 throws Exception,
                                        RemoteException

Returns the default property store.

Specified by:

getDefaultStore in interface TDIProperties

Returns:

the default property store

Throws:

Exception - if Runtime or Security exception occurs

RemoteException - if a communication-related exception occurs.

setDefaultStore

public void setDefaultStore(TDIPropertyStore defaultStore)
                     throws Exception,
                            RemoteException

Sets the default property store.

Specified by:

setDefaultStore in interface TDIProperties

Parameters:

defaultStore - the new default property store

Throws:

Exception - if Runtime or Security exception occurs

RemoteException - if a communication-related exception occurs.

getPasswordStore

public TDIPropertyStore getPasswordStore()
                                  throws Exception,
                                         RemoteException

Returns the password store.

Specified by:

getPasswordStore in interface TDIProperties

Returns:

the password store

Throws:

Exception - if Runtime or Security exception occurs

RemoteException - if a communication-related exception occurs.

setPasswordStore

public void setPasswordStore(TDIPropertyStore passwordStore)
                      throws Exception,
                             RemoteException

Sets the password store.

Specified by:

setPasswordStore in interface TDIProperties

Parameters:

passwordStore - the new password store

Throws:

Exception - if Runtime or Security exception occurs

RemoteException - if a communication-related exception occurs.

getPropertyStore

public TDIPropertyStore getPropertyStore(String name)
                                  throws Exception,
                                         RemoteException

Returns the named property store.

Specified by:

getPropertyStore in interface TDIProperties

Parameters:

name - the name of the property store

Returns:

the TDIPropertyStore with specified name

Throws:

Exception - if Runtime or Security exception occurs

RemoteException - if a communication-related exception occurs.

trimKey

public String trimKey(String key)
               throws Exception,
                      RemoteException

Trims the key from a given string. For example trimKey("greeting:Hello, world!") will return the following string: "Hello, world!".

Specified by:

trimKey in interface TDIProperties

Parameters:

key - a string representing key:value pair

Returns:

string containing only the value

Throws:

Exception - if Runtime or Security exception occurs

RemoteException - if a communication-related exception occurs.

setProperty

public void setProperty(String propertyStoreName,
                        String key,
                        Object value,
                        boolean protect)
                 throws RemoteException,
                        Exception

Sets the property in the named property store.

Specified by:

setProperty in interface TDIProperties

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:

RemoteException - if a communication-related exception occurs.

Exception - if Runtime or Security exception occurs

isPropertyEncrypted

public boolean isPropertyEncrypted(String propertyStoreName,
                                   String key)
                            throws Exception,
                                   RemoteException

Returns whether specified property is encrypted or not.

Specified by:

isPropertyEncrypted in interface TDIProperties

Parameters:

propertyStoreName - The name of the property store

key - The property value

Returns:

true if this property is encrypted; false otherwise

Throws:

Exception

RemoteException - if a communication-related exception occurs.

createInstance

public static TDIPropertiesImpl createInstance(TDIProperties localTDIP,
                                               SessionImpl aSession)
                                        throws DIException,
                                               RemoteException

Creates TDIPropertiesImpl instance.

Parameters:

localTDIP - the local TDIProperties

aSession - the SessionImpl object

Returns:

TDIPropertiesImpl object

Throws:

DIException - if Runtime or Security exception occurs.

RemoteException - if a communication-related exception occurs.