com.ibm.di.config.base
Class ConnectorConfigImpl

java.lang.Object
  com.ibm.di.config.base.BaseConfigurationImpl
      com.ibm.di.config.base.ConnectorConfigImpl

All Implemented Interfaces:

BaseConfiguration, ConnectorConfig, MetamergeConfigChangeListener, OperationsConfig, Serializable

Direct Known Subclasses:

ALMappingConfigImpl, FunctionConfigImpl

public class ConnectorConfigImpl
extends BaseConfigurationImpl
implements ConnectorConfig

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.di.config.base.BaseConfigurationImpl

NAME

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

ADDONLY_MODE, BRANCH_MODE, CALL_REPLY_MODE, COMP_INIT_DEFAULT, COMP_INIT_EVERYTIME, COMP_INIT_MODIFIED, COMP_INIT_USE, DELETE_MODE, DELTA_MODE, DELTA_NO_DELETE, DELTA_NORMAL, DISABLED_STATE, ENABLED_STATE, FUNCTION_MODE, INPUT_MAP_NAME, ITERATOR_MODE, LOOKUP_MODE, MAPPING_MODE, OUTPUT_MAP_NAME, PASSIVE_STATE, REPLY_MODE, SCHEMA_INPUT, SCHEMA_OUTPUT, SCRIPT_MODE, SERVER_MODE, SERVER_OPTION_CONNECTOR, SERVER_OPTION_ENTRY, UPDATE_MODE

Constructor Summary

ConnectorConfigImpl()

ConnectorConfigImpl(Object config)

Method Summary

OperationConfig	createOperation(String name) This method creates a new operation object.
boolean	flatten(List excludedNS) flatten - combines all values from this object and its inherited objects into one single config object.
AttributeMapConfig	getAttributeMap() Attribute Maps
AttributeMapConfig	getAttributeMap(boolean input) Attribute Maps
AttributeMapConfig	getAttributeMap(Object name) Gets the attributeMap attribute of the ConnectorConfig object
CheckpointConfig	getCheckpointConfig() Returns the CheckpointInfo object
Object	getClone() Return self clone
boolean	getComputeChanges() Returns the compute-changes flag for Update mode connector.
RawConnectorConfig	getConnectionConfig() Connector driver parameters
String	getConnectorScript() Script Connector
int	getDeltaBehavior() Returns true if the connector uses delta behavior
DeltaConfig	getDeltaConfig() Delta configuration
boolean	getDeltaStrict() Returns the delta strict flag
boolean	getEnabled() Gets the enabled attribute of the BaseConfiguration object
HooksConfig	getHooks() Hooks
int	getInitializeOption() This method returns the initialization option for the component
LinkCriteriaConfig	getLinkCriteria() Link Criteria
String	getMode() Connector mode
OperationConfig	getOperation(String name) This method returns the config for a given operation
String	getOperationCarrier() This method returns the name of the operation carrier
boolean	getOperationCarrierIsProperty() This method returns whether the operation carrier is an entry attribute or entry property
ContainerConfig	getOperations() This method returns a list of supported operations
ParserConfig	getParserConfig() Associated Parser configuration
PoolDefConfig	getPoolDefConfig() Connector Pool Definition
PoolInstanceConfig	getPoolInstanceConfig() Connector Pool Instance
SchemaConfig	getPublishedInitParams() Returns the Published Initialization Parameter Schema for the AssemblyLine
ReconnectConfig	getReconnectConfig() Returns the reconnect config
List	getReferences(List list) Returns a list of all references to other object from which this object or its children inherit from.
boolean	getReplyRequired() Returns true if the connector requires a response in server or iterator mode.
SandboxConfig	getSandboxConfig() Returns the Sandbox object
SchemaConfig	getSchema(boolean input) Connector abstract schema
SchemaConfig	getSchema(String name) Connector abstract schema
String	getServerOption() Returns the server option (entry or connector) that determines whether the connector returns a connector instance or an entry in server mode.
String	getState() State (typically used in the AssemblyLine)
void	init() init - method called after internal data structure is set
boolean	isEntryFeed() Returns true if the connector is an entry feed connector
void	setAttributeMap(AttributeMapConfig attributeMap) Sets the attributeMap attribute of the ConnectorConfig object
void	setAttributeMap(AttributeMapConfig attributeMap, boolean input) Sets the attributeMap attribute of the ConnectorConfig object
void	setComputeChanges(boolean cc) Sets the compute-changes flag for Update mode connector.
void	setConnectionConfig(RawConnectorConfig rcc)
void	setConnectorScript(String script) Sets the connectorScript attribute of the ConnectorConfig object
void	setDeltaBehavior(int behavior) Sets delta behavior
void	setDeltaStrict(boolean strict) Sets the delta strict flag
void	setEnabled(boolean enabled) Gets the enabled attribute of the BaseConfiguration object
void	setInheritsFromRef(String ref) Sets the name of the object from which this object should inherit its values.
void	setInitializeOption(int option) This method sets the the initialization option for the component
void	setLinkCriteria(LinkCriteriaConfig linkCriteria) Sets the linkCriteria attribute of the ConnectorConfig object
void	setMode(String mode) Sets the mode attribute of the ConnectorConfig object
void	setOperationCarrier(String name) This method sets the name of the operation carrier
void	setOperationCarrierIsProperty(boolean isproperty) This method sets whether the operation carrier is an entry attribute or entry property
void	setParserConfig(ParserConfig parser) Sets the parserConfig attribute of the ConnectorConfig object
void	setPublishedInitParams(SchemaConfig schema) Sets the Published Initialization Parameter Schema for the AssemblyLine
void	setState(String state) Sets the state attribute of the ConnectorConfig object
void	setupInheritanceChain() Established the inheritance chain for this object.
void	updateInheritsFrom(String ref) Sets the name of the object from which this object should inherit its values and calls the setupInheritanceChain to activate the change.

Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl

addListener, configurationChanged, deepClone, expandPropertyValue, expandPropertyValue, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getData, getDataIterator, getDebug, getDebug, getDebugBreak, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getResHash, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, isParameterLocal, nameForChild, notifyChange, notifyChange, performNotifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebug, setDebugBreak, setFlags, setInheritsFrom, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setUseListeners, setUserComment, size, toEntry, toString, willExpandProps, willFlatten, willUseInherited

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConnectorConfigImpl

public ConnectorConfigImpl()

ConnectorConfigImpl

public ConnectorConfigImpl(Object config)

Method Detail

init

public void init()
          throws Exception

Description copied from class: BaseConfigurationImpl

init - method called after internal data structure is set

Specified by:

init in interface BaseConfiguration

Overrides:

init in class BaseConfigurationImpl

Throws:

Exception - if the initialization fails

setupInheritanceChain

public void setupInheritanceChain()
                           throws Exception

Description copied from class: BaseConfigurationImpl

Established the inheritance chain for this object.

Specified by:

setupInheritanceChain in interface BaseConfiguration

Overrides:

setupInheritanceChain in class BaseConfigurationImpl

Throws:

Exception - if the operation does not succeed

updateInheritsFrom

public void updateInheritsFrom(String ref)
                        throws Exception

Description copied from interface: BaseConfiguration

Sets the name of the object from which this object should inherit its values and calls the setupInheritanceChain to activate the change.

Specified by:

updateInheritsFrom in interface BaseConfiguration

Overrides:

updateInheritsFrom in class BaseConfigurationImpl

Parameters:

ref - The new inheritsFromRef value

Throws:

Exception

setInheritsFromRef

public void setInheritsFromRef(String ref)

Description copied from interface: BaseConfiguration

Sets the name of the object from which this object should inherit its values.

Specified by:

setInheritsFromRef in interface BaseConfiguration

Overrides:

setInheritsFromRef in class BaseConfigurationImpl

Parameters:

ref - The new inheritsFromRef value

getMode

public String getMode()

Description copied from interface: ConnectorConfig

Connector mode

Specified by:

getMode in interface ConnectorConfig

Returns:

The mode value

setMode

public void setMode(String mode)

Description copied from interface: ConnectorConfig

Sets the mode attribute of the ConnectorConfig object

Specified by:

setMode in interface ConnectorConfig

Parameters:

mode - The new mode value

getSchema

public SchemaConfig getSchema(String name)

Connector abstract schema

Specified by:

getSchema in interface ConnectorConfig

Returns:

The schema value

getSchema

public SchemaConfig getSchema(boolean input)

Connector abstract schema

Specified by:

getSchema in interface ConnectorConfig

Returns:

The schema value

getDeltaConfig

public DeltaConfig getDeltaConfig()

Delta configuration

Specified by:

getDeltaConfig in interface ConnectorConfig

getPoolDefConfig

public PoolDefConfig getPoolDefConfig()

Connector Pool Definition

Specified by:

getPoolDefConfig in interface ConnectorConfig

getPoolInstanceConfig

public PoolInstanceConfig getPoolInstanceConfig()

Connector Pool Instance

Specified by:

getPoolInstanceConfig in interface ConnectorConfig

getConnectorScript

public String getConnectorScript()

Script Connector

Specified by:

getConnectorScript in interface ConnectorConfig

Returns:

The connectorScript value

setConnectorScript

public void setConnectorScript(String script)

Description copied from interface: ConnectorConfig

Sets the connectorScript attribute of the ConnectorConfig object

Specified by:

setConnectorScript in interface ConnectorConfig

Parameters:

script - The new connectorScript value

getAttributeMap

public AttributeMapConfig getAttributeMap(boolean input)

Attribute Maps

Specified by:

getAttributeMap in interface ConnectorConfig

Parameters:

input - a boolean value specifying whether the input or output Attribute map to retrieve

Returns:

The attributeMap value

getAttributeMap

public AttributeMapConfig getAttributeMap(Object name)

Description copied from interface: ConnectorConfig

Gets the attributeMap attribute of the ConnectorConfig object

Specified by:

getAttributeMap in interface ConnectorConfig

Parameters:

name - the name of the Attribute map to retrieve

Returns:

The attributeMap value

getAttributeMap

public AttributeMapConfig getAttributeMap()

Description copied from interface: ConnectorConfig

Attribute Maps

Specified by:

getAttributeMap in interface ConnectorConfig

Returns:

The attributeMap value

setAttributeMap

public void setAttributeMap(AttributeMapConfig attributeMap)

Description copied from interface: ConnectorConfig

Sets the attributeMap attribute of the ConnectorConfig object

Specified by:

setAttributeMap in interface ConnectorConfig

Parameters:

attributeMap - The new attributeMap value

setAttributeMap

public void setAttributeMap(AttributeMapConfig attributeMap,
                            boolean input)

Description copied from interface: ConnectorConfig

Sets the attributeMap attribute of the ConnectorConfig object

Specified by:

setAttributeMap in interface ConnectorConfig

Parameters:

attributeMap - The new attributeMap value

input - The new attributeMap value

getLinkCriteria

public LinkCriteriaConfig getLinkCriteria()

Link Criteria

Specified by:

getLinkCriteria in interface ConnectorConfig

Returns:

The linkCriteria value

setLinkCriteria

public void setLinkCriteria(LinkCriteriaConfig linkCriteria)

Description copied from interface: ConnectorConfig

Sets the linkCriteria attribute of the ConnectorConfig object

Specified by:

setLinkCriteria in interface ConnectorConfig

Parameters:

linkCriteria - The new linkCriteria value

getHooks

public HooksConfig getHooks()

Hooks

Specified by:

getHooks in interface ConnectorConfig

Returns:

The hooks value

getConnectionConfig

public RawConnectorConfig getConnectionConfig()

Connector driver parameters

Specified by:

getConnectionConfig in interface ConnectorConfig

Returns:

The connectionConfig value

setConnectionConfig

public void setConnectionConfig(RawConnectorConfig rcc)

getParserConfig

public ParserConfig getParserConfig()

Associated Parser configuration

Specified by:

getParserConfig in interface ConnectorConfig

Returns:

The parserConfig value

setParserConfig

public void setParserConfig(ParserConfig parser)

Description copied from interface: ConnectorConfig

Sets the parserConfig attribute of the ConnectorConfig object

Specified by:

setParserConfig in interface ConnectorConfig

Parameters:

parser - The new parserConfig value

getState

public String getState()

Description copied from interface: ConnectorConfig

State (typically used in the AssemblyLine)

Specified by:

getState in interface ConnectorConfig

Returns:

The configured state

setState

public void setState(String state)

Description copied from interface: ConnectorConfig

Sets the state attribute of the ConnectorConfig object

Specified by:

setState in interface ConnectorConfig

Parameters:

state - The new state

getEnabled

public boolean getEnabled()

Description copied from interface: BaseConfiguration

Gets the enabled attribute of the BaseConfiguration object

Specified by:

getEnabled in interface BaseConfiguration

Specified by:

getEnabled in interface ConnectorConfig

Overrides:

getEnabled in class BaseConfigurationImpl

Returns:

The nullBehaviorValue value

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: BaseConfiguration

Gets the enabled attribute of the BaseConfiguration object

Specified by:

setEnabled in interface BaseConfiguration

Specified by:

setEnabled in interface ConnectorConfig

Overrides:

setEnabled in class BaseConfigurationImpl

Parameters:

enabled - The new enabled value

getComputeChanges

public boolean getComputeChanges()

Returns the compute-changes flag for Update mode connector.

Specified by:

getComputeChanges in interface ConnectorConfig

Returns:

The enabled value

setComputeChanges

public void setComputeChanges(boolean cc)

Sets the compute-changes flag for Update mode connector.

Specified by:

setComputeChanges in interface ConnectorConfig

Parameters:

cc - The compute-change flag to set.

getCheckpointConfig

public CheckpointConfig getCheckpointConfig()

Returns the CheckpointInfo object

Specified by:

getCheckpointConfig in interface ConnectorConfig

getSandboxConfig

public SandboxConfig getSandboxConfig()

Returns the Sandbox object

Specified by:

getSandboxConfig in interface ConnectorConfig

getDeltaBehavior

public int getDeltaBehavior()

Returns true if the connector uses delta behavior

Specified by:

getDeltaBehavior in interface ConnectorConfig

setDeltaBehavior

public void setDeltaBehavior(int behavior)

Sets delta behavior

Specified by:

setDeltaBehavior in interface ConnectorConfig

getDeltaStrict

public boolean getDeltaStrict()

Returns the delta strict flag

Specified by:

getDeltaStrict in interface ConnectorConfig

setDeltaStrict

public void setDeltaStrict(boolean strict)

Sets the delta strict flag

Specified by:

setDeltaStrict in interface ConnectorConfig

getServerOption

public String getServerOption()

Returns the server option (entry or connector) that determines whether the connector returns a connector instance or an entry in server mode.

Specified by:

getServerOption in interface ConnectorConfig

getReplyRequired

public boolean getReplyRequired()

Returns true if the connector requires a response in server or iterator mode.

Specified by:

getReplyRequired in interface ConnectorConfig

isEntryFeed

public boolean isEntryFeed()

Returns true if the connector is an entry feed connector

Specified by:

isEntryFeed in interface ConnectorConfig

getOperations

public ContainerConfig getOperations()

This method returns a list of supported operations

Specified by:

getOperations in interface OperationsConfig

getOperation

public OperationConfig getOperation(String name)

This method returns the config for a given operation

Specified by:

getOperation in interface OperationsConfig

createOperation

public OperationConfig createOperation(String name)
                                throws Exception

This method creates a new operation object.

Specified by:

createOperation in interface OperationsConfig

Throws:

Exception

getOperationCarrier

public String getOperationCarrier()

This method returns the name of the operation carrier

Specified by:

getOperationCarrier in interface ConnectorConfig

setOperationCarrier

public void setOperationCarrier(String name)

This method sets the name of the operation carrier

Specified by:

setOperationCarrier in interface ConnectorConfig

getOperationCarrierIsProperty

public boolean getOperationCarrierIsProperty()

This method returns whether the operation carrier is an entry attribute or entry property

Specified by:

getOperationCarrierIsProperty in interface ConnectorConfig

setOperationCarrierIsProperty

public void setOperationCarrierIsProperty(boolean isproperty)

This method sets whether the operation carrier is an entry attribute or entry property

Specified by:

setOperationCarrierIsProperty in interface ConnectorConfig

flatten

public boolean flatten(List excludedNS)
                throws Exception

Description copied from class: BaseConfigurationImpl

flatten - combines all values from this object and its inherited objects into one single config object. After flattening, the object is a complete object with no inherited values except those from the excludedNS list.

Specified by:

flatten in interface BaseConfiguration

Overrides:

flatten in class BaseConfigurationImpl

Parameters:

excludedNS - List of namespaces to exclude from flattening

Returns:

TRUE if object attempted flattening, FALSE is this object inherits from an excluded namespace or has no inheritance

Throws:

Exception

getReferences

public List getReferences(List list)

Description copied from interface: BaseConfiguration

Returns a list of all references to other object from which this object or its children inherit from.

Specified by:

getReferences in interface BaseConfiguration

Overrides:

getReferences in class BaseConfigurationImpl

Parameters:

list - If non-null, the object must use the provided list rather than creating its own

getReconnectConfig

public ReconnectConfig getReconnectConfig()

Description copied from interface: ConnectorConfig

Returns the reconnect config

Specified by:

getReconnectConfig in interface ConnectorConfig

getInitializeOption

public int getInitializeOption()

Description copied from interface: ConnectorConfig

This method returns the initialization option for the component

Specified by:

getInitializeOption in interface ConnectorConfig

setInitializeOption

public void setInitializeOption(int option)

Description copied from interface: ConnectorConfig

This method sets the the initialization option for the component

Specified by:

setInitializeOption in interface ConnectorConfig

getClone

public Object getClone()
                throws Exception

Return self clone

Specified by:

getClone in interface BaseConfiguration

Overrides:

getClone in class BaseConfigurationImpl

Throws:

Exception

getPublishedInitParams

public SchemaConfig getPublishedInitParams()

Description copied from interface: OperationsConfig

Returns the Published Initialization Parameter Schema for the AssemblyLine

Specified by:

getPublishedInitParams in interface OperationsConfig

setPublishedInitParams

public void setPublishedInitParams(SchemaConfig schema)

Description copied from interface: OperationsConfig

Sets the Published Initialization Parameter Schema for the AssemblyLine

Specified by:

setPublishedInitParams in interface OperationsConfig

Parameters:

schema - The new schema