com.ibm.di.config.xml
Class ConnectorFactory

java.lang.Object
  extended by com.ibm.di.config.xml.Factories
      extended by com.ibm.di.config.xml.ConnectorFactory

public class ConnectorFactory
extends Factories

Read/write ConnectorConfig and children elements in XML format.


Field Summary
static String AMI_ADD
           
static String AMI_ENABLED
           
static String AMI_MODIFY
           
static String AMI_NAME
           
static String AMI_SCRIPT
           
static String AMI_SIMPLE
           
static String AMI_SUBST_TEMPLATE
           
static String AMI_TYPE
           
static String ATTRIBUTE_MAP
           
static String ATTRIBUTE_MAP_ITEM
           
static String COMPUTE_CHANGES
           
static String CONFIGURATION
           
static String CONNECTOR_TAG
           
static String DELTA_ATTRIBUTE
           
static String DELTA_ATTRIBUTE_LIST
           
static String DELTA_BEHAVIOR
           
static String DELTA_CHANGE_DETECTION_MODE
           
static String DELTA_DRIVER
           
static String DELTA_DUPLICATE_KEYS
           
static String DELTA_ENABLED
           
static String DELTA_FAST_ALGORITHM
           
static String DELTA_FILEPATH
           
static String DELTA_LEVEL
           
static String DELTA_READ_DELETED
           
static String DELTA_REMOVE_DELETED
           
static String DELTA_RETURN_UNCHANGED
           
static String DELTA_ROW_LOCKING
           
static String DELTA_SETTINGS
           
static String DELTA_STRICT
           
static String DELTA_WHEN_TO_COMMIT
           
static String HOOK
           
static String HOOKS
           
static String INIT_OPTION
           
static String LCI_ATTRIBUTE
           
static String LCI_KEY
           
static String LCI_OPERAND
           
static String LCI_VALUE
           
static String LINK_CRITERIA
           
static String LINK_CRITERIA_ITEM
           
static String LINK_CRITERIA_MODE
           
static String LINK_CRITERIA_OR
           
static String LINK_CRITERIA_SCRIPT
           
static String LOOKUP_LIMIT
           
static String MODE
           
static String OPS_CARRIER
           
static String OPS_CARRIER_PROP
           
static String POOL_DEF
           
static String POOL_DEF_ENABLED
           
static String POOL_DEF_INITIALIZE_ATTEMPTS
           
static String POOL_DEF_INITIALIZE_SLEEP_INTERVAL
           
static String POOL_DEF_MAX_SIZE
           
static String POOL_DEF_MIN_SIZE
           
static String POOL_DEF_PURGE_INTERVAL
           
static String POOL_INSTANCE
           
static String POOL_INSTANCE_ENABLED
           
static String POOL_INSTANCE_EXHAUSTED_BEHAVIOR
           
static String SCRIPT
           
static String SKIP_LOOKUP
           
static String STATE
           
 
Fields inherited from class com.ibm.di.config.xml.Factories
classMap, implMap, INHERIT_TAG, logger, MOD_TS_TAG, NAME_ATTRIBUTE, NAME_TAG, NULLBEHAVIOR, NULLBEHAVIORVALUE, NULLDEFINITION, NULLDEFINITIONVALUE, PARAMETER_TAG, parent, USER_COMMENT_ATTRIBUTE, VALUE_ATTRIBUTE
 
Constructor Summary
ConnectorFactory()
           
 
Method Summary
 void build(BaseConfiguration config, Element elem)
          Generate a XML element from a configuration object.
 void getAttributeMap(Element elem, AttributeMapConfig amc)
           
 void getAttributeMapItem(Element elem, AttributeMapConfig amc)
           
 void getAttributeMapItem(Element elem, AttributeMapItem ami)
           
 void getAttributeMaps(Element elem, ConnectorConfig config)
           
 void getDeltaSettings(Element elem, DeltaConfig dc)
           
 void getLinkCriteria(LinkCriteriaConfig lcc, Element elem)
           
 void getLinkCriteriaItems(LinkCriteriaConfig lcc, Element elem)
           
 void getPoolDefConfig(Element elem, PoolDefConfig poolConfig)
           
 void getPoolInstanceConfig(Element elem, PoolInstanceConfig poolConfig)
           
 void getSchemas(Element elem, ConnectorConfig config)
           
 void parse(BaseConfiguration config, Element elem)
          Parse a XML element into a configuration object.
 void setAttributeMap(AttributeMapConfig amc, Element elem)
           
 void setAttributeMapItems(AttributeMapConfig amc, Element e)
           
 void setAttributeMaps(Element elem, ConnectorConfig cc)
           
 void setDeltaSettings(Element elem, DeltaConfig dc)
           
 void setLinkCriteria(LinkCriteriaConfig lcc, Element elem)
           
 void setLinkCriteriaItems(LinkCriteriaConfig lcc, Element elem)
           
 void setPoolDefConfig(Element elem, PoolDefConfig poolConfig)
           
 void setPoolInstanceConfig(Element elem, PoolInstanceConfig poolConfig)
           
 void setSchemas(Element elem, ConnectorConfig cc)
           
 
Methods inherited from class com.ibm.di.config.xml.Factories
debug, dump, getBaseName, getClassTag, getFactory, getImpl, getInheritsFrom, getNodeText, getNodeTextByName, getParameter, getParameters, getSingleElement, isDebugMode, logmsg, setBaseName, setInheritsFrom, setParameter, setParameters, setSingleElement, setSingleElement
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONNECTOR_TAG

public static final String CONNECTOR_TAG
See Also:
Constant Field Values

MODE

public static final String MODE
See Also:
Constant Field Values

STATE

public static final String STATE
See Also:
Constant Field Values

SCRIPT

public static final String SCRIPT
See Also:
Constant Field Values

INIT_OPTION

public static final String INIT_OPTION
See Also:
Constant Field Values

COMPUTE_CHANGES

public static final String COMPUTE_CHANGES
See Also:
Constant Field Values

SKIP_LOOKUP

public static final String SKIP_LOOKUP
See Also:
Constant Field Values

LINK_CRITERIA

public static final String LINK_CRITERIA
See Also:
Constant Field Values

LINK_CRITERIA_ITEM

public static final String LINK_CRITERIA_ITEM
See Also:
Constant Field Values

LINK_CRITERIA_MODE

public static final String LINK_CRITERIA_MODE
See Also:
Constant Field Values

LINK_CRITERIA_OR

public static final String LINK_CRITERIA_OR
See Also:
Constant Field Values

LINK_CRITERIA_SCRIPT

public static final String LINK_CRITERIA_SCRIPT
See Also:
Constant Field Values

LCI_ATTRIBUTE

public static final String LCI_ATTRIBUTE
See Also:
Constant Field Values

LCI_OPERAND

public static final String LCI_OPERAND
See Also:
Constant Field Values

LCI_VALUE

public static final String LCI_VALUE
See Also:
Constant Field Values

LCI_KEY

public static final String LCI_KEY
See Also:
Constant Field Values

ATTRIBUTE_MAP

public static final String ATTRIBUTE_MAP
See Also:
Constant Field Values

ATTRIBUTE_MAP_ITEM

public static final String ATTRIBUTE_MAP_ITEM
See Also:
Constant Field Values

AMI_NAME

public static final String AMI_NAME
See Also:
Constant Field Values

AMI_TYPE

public static final String AMI_TYPE
See Also:
Constant Field Values

AMI_SCRIPT

public static final String AMI_SCRIPT
See Also:
Constant Field Values

AMI_ADD

public static final String AMI_ADD
See Also:
Constant Field Values

AMI_MODIFY

public static final String AMI_MODIFY
See Also:
Constant Field Values

AMI_SIMPLE

public static final String AMI_SIMPLE
See Also:
Constant Field Values

AMI_ENABLED

public static final String AMI_ENABLED
See Also:
Constant Field Values

AMI_SUBST_TEMPLATE

public static final String AMI_SUBST_TEMPLATE
See Also:
Constant Field Values

CONFIGURATION

public static final String CONFIGURATION
See Also:
Constant Field Values

HOOKS

public static final String HOOKS
See Also:
Constant Field Values

HOOK

public static final String HOOK
See Also:
Constant Field Values

DELTA_SETTINGS

public static final String DELTA_SETTINGS
See Also:
Constant Field Values

DELTA_ENABLED

public static final String DELTA_ENABLED
See Also:
Constant Field Values

DELTA_ATTRIBUTE

public static final String DELTA_ATTRIBUTE
See Also:
Constant Field Values

DELTA_FILEPATH

public static final String DELTA_FILEPATH
See Also:
Constant Field Values

DELTA_READ_DELETED

public static final String DELTA_READ_DELETED
See Also:
Constant Field Values

DELTA_REMOVE_DELETED

public static final String DELTA_REMOVE_DELETED
See Also:
Constant Field Values

DELTA_RETURN_UNCHANGED

public static final String DELTA_RETURN_UNCHANGED
See Also:
Constant Field Values

DELTA_WHEN_TO_COMMIT

public static final String DELTA_WHEN_TO_COMMIT
See Also:
Constant Field Values

DELTA_ROW_LOCKING

public static final String DELTA_ROW_LOCKING
See Also:
Constant Field Values

DELTA_ATTRIBUTE_LIST

public static final String DELTA_ATTRIBUTE_LIST
See Also:
Constant Field Values

DELTA_CHANGE_DETECTION_MODE

public static final String DELTA_CHANGE_DETECTION_MODE
See Also:
Constant Field Values

DELTA_DRIVER

public static final String DELTA_DRIVER
See Also:
Constant Field Values

DELTA_LEVEL

public static final String DELTA_LEVEL
See Also:
Constant Field Values

DELTA_BEHAVIOR

public static final String DELTA_BEHAVIOR
See Also:
Constant Field Values

DELTA_STRICT

public static final String DELTA_STRICT
See Also:
Constant Field Values

DELTA_FAST_ALGORITHM

public static final String DELTA_FAST_ALGORITHM
See Also:
Constant Field Values

DELTA_DUPLICATE_KEYS

public static final String DELTA_DUPLICATE_KEYS
See Also:
Constant Field Values

POOL_DEF

public static final String POOL_DEF
See Also:
Constant Field Values

POOL_DEF_ENABLED

public static final String POOL_DEF_ENABLED
See Also:
Constant Field Values

POOL_DEF_MIN_SIZE

public static final String POOL_DEF_MIN_SIZE
See Also:
Constant Field Values

POOL_DEF_MAX_SIZE

public static final String POOL_DEF_MAX_SIZE
See Also:
Constant Field Values

POOL_DEF_PURGE_INTERVAL

public static final String POOL_DEF_PURGE_INTERVAL
See Also:
Constant Field Values

POOL_DEF_INITIALIZE_ATTEMPTS

public static final String POOL_DEF_INITIALIZE_ATTEMPTS
See Also:
Constant Field Values

POOL_DEF_INITIALIZE_SLEEP_INTERVAL

public static final String POOL_DEF_INITIALIZE_SLEEP_INTERVAL
See Also:
Constant Field Values

POOL_INSTANCE

public static final String POOL_INSTANCE
See Also:
Constant Field Values

POOL_INSTANCE_ENABLED

public static final String POOL_INSTANCE_ENABLED
See Also:
Constant Field Values

POOL_INSTANCE_EXHAUSTED_BEHAVIOR

public static final String POOL_INSTANCE_EXHAUSTED_BEHAVIOR
See Also:
Constant Field Values

OPS_CARRIER

public static final String OPS_CARRIER
See Also:
Constant Field Values

OPS_CARRIER_PROP

public static final String OPS_CARRIER_PROP
See Also:
Constant Field Values

LOOKUP_LIMIT

public static final String LOOKUP_LIMIT
See Also:
Constant Field Values
Constructor Detail

ConnectorFactory

public ConnectorFactory()
Method Detail

parse

public void parse(BaseConfiguration config,
                  Element elem)
           throws Exception
Parse a XML element into a configuration object.

Overrides:
parse in class Factories
Parameters:
config - an instance of the BaseConfiguration class which internal parameters will get set based on the information from the provided XML Element.
elem - this is a part of the XML tree that represents the BaseConfiguration object.
Throws:
Exception - in case the configuration object the provided XML element represents is not recognized.

getLinkCriteria

public void getLinkCriteria(LinkCriteriaConfig lcc,
                            Element elem)
                     throws Exception
Throws:
Exception

getLinkCriteriaItems

public void getLinkCriteriaItems(LinkCriteriaConfig lcc,
                                 Element elem)
                          throws Exception
Throws:
Exception

getSchemas

public void getSchemas(Element elem,
                       ConnectorConfig config)
                throws Exception
Throws:
Exception

getAttributeMaps

public void getAttributeMaps(Element elem,
                             ConnectorConfig config)
                      throws Exception
Throws:
Exception

getAttributeMapItem

public void getAttributeMapItem(Element elem,
                                AttributeMapConfig amc)
                         throws Exception
Throws:
Exception

getAttributeMap

public void getAttributeMap(Element elem,
                            AttributeMapConfig amc)
                     throws Exception
Throws:
Exception

getAttributeMapItem

public void getAttributeMapItem(Element elem,
                                AttributeMapItem ami)
                         throws Exception
Throws:
Exception

getDeltaSettings

public void getDeltaSettings(Element elem,
                             DeltaConfig dc)
                      throws Exception
Throws:
Exception

build

public void build(BaseConfiguration config,
                  Element elem)
           throws Exception
Generate a XML element from a configuration object.

Overrides:
build in class Factories
Parameters:
config - an instance of the BaseConfiguration class which internal parameters will be represented as a XML sub-tree.
elem - this is the part of the XML tree where the config object's XML representation will be attached to.
Throws:
Exception - in case the tag name of the provided XML element is not recognized as a valid name which is used for configuration object representation as a XML.

setSchemas

public void setSchemas(Element elem,
                       ConnectorConfig cc)
                throws Exception
Throws:
Exception

setAttributeMaps

public void setAttributeMaps(Element elem,
                             ConnectorConfig cc)
                      throws Exception
Throws:
Exception

setAttributeMap

public void setAttributeMap(AttributeMapConfig amc,
                            Element elem)
                     throws Exception
Throws:
Exception

setAttributeMapItems

public void setAttributeMapItems(AttributeMapConfig amc,
                                 Element e)
                          throws Exception
Throws:
Exception

setLinkCriteria

public void setLinkCriteria(LinkCriteriaConfig lcc,
                            Element elem)
                     throws Exception
Throws:
Exception

setLinkCriteriaItems

public void setLinkCriteriaItems(LinkCriteriaConfig lcc,
                                 Element elem)
                          throws Exception
Throws:
Exception

setDeltaSettings

public void setDeltaSettings(Element elem,
                             DeltaConfig dc)
                      throws Exception
Throws:
Exception

getPoolDefConfig

public void getPoolDefConfig(Element elem,
                             PoolDefConfig poolConfig)
                      throws Exception
Throws:
Exception

setPoolDefConfig

public void setPoolDefConfig(Element elem,
                             PoolDefConfig poolConfig)
                      throws Exception
Throws:
Exception

getPoolInstanceConfig

public void getPoolInstanceConfig(Element elem,
                                  PoolInstanceConfig poolConfig)
                           throws Exception
Throws:
Exception

setPoolInstanceConfig

public void setPoolInstanceConfig(Element elem,
                                  PoolInstanceConfig poolConfig)
                           throws Exception
Throws:
Exception