com.ibm.di.config.base
Class SolutionInterfaceImpl

java.lang.Object
  extended by com.ibm.di.config.base.BaseConfigurationImpl
      extended by com.ibm.di.config.base.ContainerConfigImpl
          extended by com.ibm.di.config.base.SolutionInterfaceImpl
All Implemented Interfaces:
BaseConfiguration, ContainerConfig, MetamergeConfigChangeListener, SolutionInterface, java.io.Serializable

public class SolutionInterfaceImpl
extends ContainerConfigImpl
implements SolutionInterface

This class provides access to the Solution interface settings of a configuration. Most of these elements are used to define external aspects of a configuration such as which AssemblyLines and properties are visible/editable by a user at runtime.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.di.config.base.ContainerConfigImpl
items
 
Fields inherited from class com.ibm.di.config.base.BaseConfigurationImpl
NAME
 
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
 
Constructor Summary
SolutionInterfaceImpl()
           
SolutionInterfaceImpl(java.lang.Object data)
           
 
Method Summary
 BaseConfiguration addExposedAssemblyLine(java.lang.String name)
          Convenience method to create a BaseConfiguration object in the exposed assemblylines container.
 ExposedProperty addExposedProperty(java.lang.String propertyName, java.lang.String storeName)
          Convenience method to create an ExposedProperty object in the exposed properties container.
 java.lang.Object getClone()
          
 ContainerConfig getExposedAssemblyLines()
          Returns a container of assemblyline names that are exposed by this solution.
 ContainerConfig getExposedProperties()
          Returns a container of ExposedProperty objects.
 ExposedProperty getExposedProperty(java.lang.String propertyName, java.lang.String storeName)
          Returns the ExposedProperty object using name and storename
 java.lang.String getHealthAssemblyLine()
          Returns the name of the health assemblyline.
 int getHealthPollInterval()
          Returns the poll interval for the health assemblyline.
 java.lang.String getInstanceID()
          Returns the instance ID for this configuration or null if none is defined.
 java.util.List<java.lang.String> getPropertyCategoryNames()
          Convenience method that returns a list of unique category names found in the exposed properties container.
 java.util.List<java.lang.String> getPropertyStoreNames()
          Convenience method that returns a list of unique store names found in the exposed properties container.
 void init()
          Called after internal data structure is set.
 void setHealthAssemblyLine(java.lang.String name)
          Sets the name of the health assemblyline for this configuration (null or empty string to clear).
 void setHealthPollInterval(int seconds)
          Sets the poll interval for the health assemblyline.
 void setInstanceID(java.lang.String id)
          Sets the instance ID for this configuration or null if none is defined.
 
Methods inherited from class com.ibm.di.config.base.ContainerConfigImpl
addConfig, containsConfig, getChild, getChildNames, getConfig, getConfig, getConfig, getConfigurations, getInheritedConfigurations, indexOf, indexOf, insertConfig, moveConfig, moveConfig, moveConfig, removeConfig, removeConfig, removeConfig, setupInheritanceChain, size
 
Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl
addListener, configurationChanged, deepClone, detachFromParent, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChildForPath, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getLongName, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseConfigListeners, getUseListeners, getUserComment, hasParameter, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, performNotifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setUseConfigListeners, setUseListeners, setUserComment, toEntry, toString, updateInheritsFrom, willExpandProps, willFlatten, willUseInherited
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.di.config.interfaces.ContainerConfig
addConfig, containsConfig, getConfig, getConfig, getConfig, getConfigurations, getInheritedConfigurations, indexOf, indexOf, insertConfig, moveConfig, moveConfig, moveConfig, removeConfig, removeConfig, removeConfig, size
 
Methods inherited from interface com.ibm.di.config.interfaces.BaseConfiguration
addListener, detachFromParent, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterRaw, getParent, getPath, getReferences, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setupInheritanceChain, setUseListeners, setUserComment, toEntry, updateInheritsFrom, willFlatten
 

Constructor Detail

SolutionInterfaceImpl

public SolutionInterfaceImpl()

SolutionInterfaceImpl

public SolutionInterfaceImpl(java.lang.Object data)
Method Detail

init

public void init()
Description copied from class: BaseConfigurationImpl
Called after internal data structure is set.

Specified by:
init in interface BaseConfiguration
Overrides:
init in class BaseConfigurationImpl

getExposedAssemblyLines

public ContainerConfig getExposedAssemblyLines()
Description copied from interface: SolutionInterface
Returns a container of assemblyline names that are exposed by this solution. Each child of the list is a BaseConfiguration object where the name is set to that of the assemblyline. The BaseConfiguration object for each assemblyline can be used to hold additional custom information about each AL.

Specified by:
getExposedAssemblyLines in interface SolutionInterface
Returns:
ContainerConfig of assemblyline names (String values)

addExposedAssemblyLine

public BaseConfiguration addExposedAssemblyLine(java.lang.String name)
                                         throws java.lang.Exception
Description copied from interface: SolutionInterface
Convenience method to create a BaseConfiguration object in the exposed assemblylines container. Use getExposedAssemblyLines().getConfig()/removeConfig() etc to manipulate contents. If an assemblyline with that name is already defined the current configuration is returned.

Specified by:
addExposedAssemblyLine in interface SolutionInterface
Parameters:
name - Name of the AL to expose
Returns:
The new/current configuration
Throws:
java.lang.Exception

getExposedProperty

public ExposedProperty getExposedProperty(java.lang.String propertyName,
                                          java.lang.String storeName)
Description copied from interface: SolutionInterface
Returns the ExposedProperty object using name and storename

Specified by:
getExposedProperty in interface SolutionInterface
Parameters:
propertyName - The propery name.
storeName - The store name.
Returns:
Returns the ExposedProperty object using name and store name.

addExposedProperty

public ExposedProperty addExposedProperty(java.lang.String propertyName,
                                          java.lang.String storeName)
Description copied from interface: SolutionInterface
Convenience method to create an ExposedProperty object in the exposed properties container. Use getExposedProperties().getConfig()/removeConfig() etc to manipulate contents. If a property with that name/storename is already defined the current configuration is returned. When creating a new ExposedProperty object the concatenation of "propertyName.propertyStore" is used to generate a unique name for the object.

Specified by:
addExposedProperty in interface SolutionInterface
Parameters:
propertyName - Name of the AL to expose.
storeName - Name of the store.
Returns:
The new/current configuration

getExposedProperties

public ContainerConfig getExposedProperties()
Description copied from interface: SolutionInterface
Returns a container of ExposedProperty objects.

Specified by:
getExposedProperties in interface SolutionInterface
Returns:
ContainerConfig of ExposedProperty objects.

getHealthAssemblyLine

public java.lang.String getHealthAssemblyLine()
Description copied from interface: SolutionInterface
Returns the name of the health assemblyline. The return value is null if no assemblyline is configured.

Specified by:
getHealthAssemblyLine in interface SolutionInterface
Returns:
The name of the Health assemblyline

setHealthAssemblyLine

public void setHealthAssemblyLine(java.lang.String name)
Description copied from interface: SolutionInterface
Sets the name of the health assemblyline for this configuration (null or empty string to clear).

Specified by:
setHealthAssemblyLine in interface SolutionInterface
Parameters:
name - The name of the Health assemblyline (using empty string will translate to null value).

getPropertyCategoryNames

public java.util.List<java.lang.String> getPropertyCategoryNames()
Description copied from interface: SolutionInterface
Convenience method that returns a list of unique category names found in the exposed properties container.

Specified by:
getPropertyCategoryNames in interface SolutionInterface
Returns:
List of category names (String values)

getPropertyStoreNames

public java.util.List<java.lang.String> getPropertyStoreNames()
Description copied from interface: SolutionInterface
Convenience method that returns a list of unique store names found in the exposed properties container.

Specified by:
getPropertyStoreNames in interface SolutionInterface
Returns:
List of store names (String values)

getInstanceID

public java.lang.String getInstanceID()
Description copied from interface: SolutionInterface
Returns the instance ID for this configuration or null if none is defined.

Specified by:
getInstanceID in interface SolutionInterface

setInstanceID

public void setInstanceID(java.lang.String id)
Description copied from interface: SolutionInterface
Sets the instance ID for this configuration or null if none is defined.

Specified by:
setInstanceID in interface SolutionInterface
Parameters:
id - The config instance id or null

getHealthPollInterval

public int getHealthPollInterval()
Description copied from interface: SolutionInterface
Returns the poll interval for the health assemblyline.

Specified by:
getHealthPollInterval in interface SolutionInterface
Returns:
The poll interval seconds or -1 if not configured

setHealthPollInterval

public void setHealthPollInterval(int seconds)
Description copied from interface: SolutionInterface
Sets the poll interval for the health assemblyline.

Specified by:
setHealthPollInterval in interface SolutionInterface
Parameters:
seconds - The poll interval in seconds

getClone

public java.lang.Object getClone()
                          throws java.lang.Exception
Description copied from class: BaseConfigurationImpl

Specified by:
getClone in interface BaseConfiguration
Overrides:
getClone in class ContainerConfigImpl
Returns:
a cloned version of this object.
Throws:
java.lang.Exception