com.ibm.di.config.interfaces
Interface PropertyManager

All Superinterfaces:

BaseConfiguration, Serializable

All Known Implementing Classes:

PropertyManagerImpl

public interface PropertyManager
extends BaseConfiguration

A PropertyManager manages the Property Stores.

Field Summary

static String	STDCOLL_GLOBAL
static String	STDCOLL_JAVA Predefined property store names
static String[]	STDCOLL_PROPERTY_NAMES
static String	STDCOLL_SOLUTION
static String	STDCOLL_SYSTEM

Fields inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

CHILD_PATH_SEPARATOR, DISABLE_EXTPROPS, DISABLE_INHERITANCE, INHERIT_NONE, INHERIT_PARENT, ONE_LEVEL, RECURSIVE, RECURSIVE_ONELEVEL, RECURSIVE_SUBTREE, SEARCH_EXACTCASE, SEARCH_ONELEVEL, SEARCH_PARAMNAME, SEARCH_PARAMNAME_RE, SEARCH_PROPERTY, SEARCH_REGEX, SEARCH_SUBSTRING, SUBTREE

Method Summary

void	addPropertyStore(PropertyStoreConfig psc) Adds the property store config to the prop store collection.
void	addStdStore(String store) Adds a standard property store to the config.
PropertyStoreConfig	getDefaultPropertyStore() Returns the designated default property store.
PropertyStoreConfig	getPasswordPropertyStore() Returns the designated password property store.
PropertyStoreConfig	getPropertyStore(String name) Returns the named PropertyStoreConfig.
ContainerConfig	getPropertyStores() Method gets the container for the property store configurations.
boolean	isStdStore(PropertyStoreConfig psc) Method determines if the Property Store Config passed in is as standard property store.
void	setDefaultPasswordStore(PropertyStoreConfig psc) Sets the default password store
void	setDefaultPropertyStore(PropertyStoreConfig psc) Sets the default property store

Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration

addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getClone, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, init, isExpression, isParameterLocal, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, size, toEntry, updateInheritsFrom, willFlatten

Field Detail

STDCOLL_JAVA

static final String STDCOLL_JAVA

Predefined property store names

See Also:

Constant Field Values

STDCOLL_GLOBAL

static final String STDCOLL_GLOBAL

See Also:

Constant Field Values

STDCOLL_SOLUTION

static final String STDCOLL_SOLUTION

See Also:

Constant Field Values

STDCOLL_SYSTEM

static final String STDCOLL_SYSTEM

See Also:

Constant Field Values

STDCOLL_PROPERTY_NAMES

static final String[] STDCOLL_PROPERTY_NAMES

Method Detail

getPropertyStores

ContainerConfig getPropertyStores()

Method gets the container for the property store configurations.

addPropertyStore

void addPropertyStore(PropertyStoreConfig psc)
                      throws Exception

Adds the property store config to the prop store collection.

Parameters:

psc - The property store config to add to the collection.

Throws:

Exception

getPropertyStore

PropertyStoreConfig getPropertyStore(String name)

Returns the named PropertyStoreConfig.

Parameters:

name -

getDefaultPropertyStore

PropertyStoreConfig getDefaultPropertyStore()

Returns the designated default property store.

Returns:

The default prop store or NULL if none is designated

getPasswordPropertyStore

PropertyStoreConfig getPasswordPropertyStore()

Returns the designated password property store.

Returns:

The password prop store or NULL if none is designated

setDefaultPropertyStore

void setDefaultPropertyStore(PropertyStoreConfig psc)
                             throws Exception

Sets the default property store

Parameters:

psc - The property store config

Throws:

Exception

setDefaultPasswordStore

void setDefaultPasswordStore(PropertyStoreConfig psc)
                             throws Exception

Sets the default password store

Parameters:

psc - The property store config

Throws:

Exception

addStdStore

void addStdStore(String store)
                 throws Exception

Adds a standard property store to the config. If one is already present this method does nothing.

Parameters:

store - The standard stor name

Throws:

Exception

isStdStore

boolean isStdStore(PropertyStoreConfig psc)

Method determines if the Property Store Config passed in is as standard property store.

Parameters:

psc - The Property Store Config to check on.

Returns:

Returns true if the Property Store Config is a standard store. Otherwise, false is returned.