|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TDIProperties
Remote Server API interface to TDIProperties. Wrapper API to expose the functionality available from com.ibm.di.config.interfaces.TDIProperties
TDIProperties
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. |
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. |
Method Detail |
---|
void commit() throws RemoteException, Exception
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.Object getProperty(String key) throws RemoteException, Exception
key
- The property name
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.Object getProperty(String propertyStoreName, String key) throws RemoteException, Exception
propertyStoreName
- The name of the property storekey
- The property value
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.String[] getPropertyStoreKeys(String propertyStoreName) throws RemoteException, Exception
propertyStoreName
- The name of the property store
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.TDIPropertyStore setProperty(String key, Object value) throws RemoteException, Exception
key
- The property namevalue
- The new property value
TDIPropertyStore
to which the key/value pair
was written
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.TDIPropertyStore setProperty(String key, Object value, boolean protect) throws RemoteException, Exception
key
- The property namevalue
- The new property valueprotect
- True if value should be protected (driver dependent)
TDIPropertyStore
to which the key/value pair
was written
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.void setProperty(String propertyStoreName, String key, Object value) throws RemoteException, Exception
propertyStoreName
- The name of the property storekey
- The property namevalue
- The new property value
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.void setProperty(String propertyStoreName, String key, Object value, boolean protect) throws RemoteException, Exception
propertyStoreName
- The name of the property storekey
- The property namevalue
- The new property valueprotect
- True if value should be protected (driver dependent)
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.void removeProperty(String propertyStoreName, String key) throws RemoteException, Exception
propertyStoreName
- The name of the property storekey
- The property to delete
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.void addPropertyStore(PropertyStoreConfig config) throws RemoteException, Exception
config
- The property store configuration
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.void insertPropertyStore(PropertyStoreConfig config, int atIndex) throws RemoteException, Exception
config
- The property store configurationatIndex
- The position where the new connector is placed (-1 = END, 0 =
First)
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.void removePropertyStore(String propertyStoreName) throws RemoteException, Exception
propertyStoreName
- The name of the property store
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.List getPropertyStoreNames() throws Exception, RemoteException
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.TDIPropertyStore getDefaultStore() throws Exception, RemoteException
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.void setDefaultStore(TDIPropertyStore defaultStore) throws Exception, RemoteException
defaultStore
- the new default property store
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.TDIPropertyStore getPasswordStore() throws Exception, RemoteException
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.void setPasswordStore(TDIPropertyStore passwordStore) throws Exception, RemoteException
passwordStore
- the new password store
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.TDIPropertyStore getPropertyStore(String name) throws Exception, RemoteException
name
- the name of the property store
TDIPropertyStore
with specified name
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.String trimKey(String key) throws Exception, RemoteException
trimKey("greeting:Hello, world!")
will return
the following string: "Hello, world!"
.
key
- a string representing key:value pair
Exception
- if Runtime or Security exception occurs
RemoteException
- if a communication-related exception occurs.boolean isPropertyEncrypted(String propertyStoreName, String key) throws Exception, RemoteException
propertyStoreName
- The name of the property storekey
- The property value
true
if this property is encrypted;
false
otherwise
Exception
RemoteException
- if a communication-related exception occurs.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |