com.ibm.di.config.interfaces
Interface ConnectorConfig

All Superinterfaces:

BaseConfiguration, OperationsConfig, Serializable

All Known Subinterfaces:

ALMappingConfig, FunctionConfig

All Known Implementing Classes:

ALMappingConfigImpl, ConnectorConfigImpl, FunctionConfigImpl

public interface ConnectorConfig
extends BaseConfiguration, OperationsConfig

This is the interface for the TDI Connector configuration.

Field Summary

static String	ADDONLY_MODE
static String	BRANCH_MODE
static String	CALL_REPLY_MODE
static int	COMP_INIT_DEFAULT Component initialization options
static int	COMP_INIT_EVERYTIME
static int	COMP_INIT_MODIFIED
static int	COMP_INIT_USE
static String	DELETE_MODE
static String	DELTA_MODE
static int	DELTA_NO_DELETE
static int	DELTA_NORMAL The following are valid delta behaviors
static String	DISABLED_STATE
static String	ENABLED_STATE The following are the valid connector states
static String	FUNCTION_MODE
static String	INPUT_MAP_NAME Attribute map names
static String	ITERATOR_MODE The following constants are used with the setMode(String) method of the connector config.
static String	LOOKUP_MODE
static String	MAPPING_MODE
static String	OUTPUT_MAP_NAME
static String	PASSIVE_STATE
static String	REPLY_MODE
static String	SCHEMA_INPUT The map name of the input/output schema
static String	SCHEMA_OUTPUT
static String	SCRIPT_MODE
static String	SERVER_MODE
static String	SERVER_OPTION_CONNECTOR
static String	SERVER_OPTION_ENTRY Server options
static String	UPDATE_MODE

Method Summary

AttributeMapConfig	getAttributeMap() Attribute Maps
AttributeMapConfig	getAttributeMap(boolean input) Gets the attributeMap attribute of the ConnectorConfig object
AttributeMapConfig	getAttributeMap(Object name) Gets the attributeMap attribute of the ConnectorConfig object
CheckpointConfig	getCheckpointConfig() Returns the checkpoint configuration.
boolean	getComputeChanges() Returns the compute-changes flag for Update mode connector.
RawConnectorConfig	getConnectionConfig() Connection parameters
String	getConnectorScript() Script connectors
int	getDeltaBehavior() Returns true if the connector uses delta behavior
DeltaConfig	getDeltaConfig() Returns the delta configuration
boolean	getDeltaStrict() Returns the delta strict flag
boolean	getEnabled() Enabled (typically used in the AssemblyLine)
HooksConfig	getHooks() Hooks
int	getInitializeOption() This method returns the initialization option for the component
LinkCriteriaConfig	getLinkCriteria() Link Criteria
String	getMode() Connector mode
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
ParserConfig	getParserConfig() Associated Parser configuration
PoolDefConfig	getPoolDefConfig() Returns the Connector Pool definition configuration
PoolInstanceConfig	getPoolInstanceConfig() Returns the Connector Pool instance configuration
ReconnectConfig	getReconnectConfig() Returns the reconnect config
boolean	getReplyRequired() Returns true if the connector requires a response in server or iterator mode.
SandboxConfig	getSandboxConfig() Returns the checkpoint configuration.
SchemaConfig	getSchema(boolean input) Connector's abstract schema - returns the input or output schema config
SchemaConfig	getSchema(String name) Connector's abstract schema - returns a named Schema config
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)
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	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) Sets the enabled attribute of the ConnectorConfig object
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	setState(String state) Sets the state attribute of the ConnectorConfig object

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

createOperation, getOperation, getOperations, getPublishedInitParams, setPublishedInitParams

Field Detail

SCHEMA_INPUT

static final String SCHEMA_INPUT

The map name of the input/output schema

See Also:

Constant Field Values

SCHEMA_OUTPUT

static final String SCHEMA_OUTPUT

See Also:

Constant Field Values

ITERATOR_MODE

static final String ITERATOR_MODE

The following constants are used with the setMode(String) method of the connector config.

See Also:

Constant Field Values

ADDONLY_MODE

static final String ADDONLY_MODE

See Also:

Constant Field Values

DELETE_MODE

static final String DELETE_MODE

See Also:

Constant Field Values

LOOKUP_MODE

static final String LOOKUP_MODE

See Also:

Constant Field Values

UPDATE_MODE

static final String UPDATE_MODE

See Also:

Constant Field Values

SCRIPT_MODE

static final String SCRIPT_MODE

See Also:

Constant Field Values

CALL_REPLY_MODE

static final String CALL_REPLY_MODE

See Also:

Constant Field Values

SERVER_MODE

static final String SERVER_MODE

See Also:

Constant Field Values

REPLY_MODE

static final String REPLY_MODE

See Also:

Constant Field Values

BRANCH_MODE

static final String BRANCH_MODE

See Also:

Constant Field Values

DELTA_MODE

static final String DELTA_MODE

See Also:

Constant Field Values

FUNCTION_MODE

static final String FUNCTION_MODE

See Also:

Constant Field Values

MAPPING_MODE

static final String MAPPING_MODE

See Also:

Constant Field Values

INPUT_MAP_NAME

static final String INPUT_MAP_NAME

Attribute map names

See Also:

Constant Field Values

OUTPUT_MAP_NAME

static final String OUTPUT_MAP_NAME

See Also:

Constant Field Values

ENABLED_STATE

static final String ENABLED_STATE

The following are the valid connector states

See Also:

Constant Field Values

PASSIVE_STATE

static final String PASSIVE_STATE

See Also:

Constant Field Values

DISABLED_STATE

static final String DISABLED_STATE

See Also:

Constant Field Values

DELTA_NORMAL

static final int DELTA_NORMAL

The following are valid delta behaviors

See Also:

Constant Field Values

DELTA_NO_DELETE

static final int DELTA_NO_DELETE

See Also:

Constant Field Values

SERVER_OPTION_ENTRY

static final String SERVER_OPTION_ENTRY

Server options

See Also:

Constant Field Values

SERVER_OPTION_CONNECTOR

static final String SERVER_OPTION_CONNECTOR

See Also:

Constant Field Values

COMP_INIT_DEFAULT

static final int COMP_INIT_DEFAULT

Component initialization options

See Also:

Constant Field Values

COMP_INIT_USE

static final int COMP_INIT_USE

See Also:

Constant Field Values

COMP_INIT_MODIFIED

static final int COMP_INIT_MODIFIED

See Also:

Constant Field Values

COMP_INIT_EVERYTIME

static final int COMP_INIT_EVERYTIME

See Also:

Constant Field Values

Method Detail

getMode

String getMode()

Connector mode

Returns:

The mode value

setMode

void setMode(String mode)

Sets the mode attribute of the ConnectorConfig object

Parameters:

mode - The new mode value

getSchema

SchemaConfig getSchema(String name)

Connector's abstract schema - returns a named Schema config

Returns:

The schema value

getSchema

SchemaConfig getSchema(boolean input)

Connector's abstract schema - returns the input or output schema config

Returns:

The schema value

getConnectorScript

String getConnectorScript()

Script connectors

Returns:

The connectorScript value

setConnectorScript

void setConnectorScript(String script)

Sets the connectorScript attribute of the ConnectorConfig object

Parameters:

script - The new connectorScript value

getAttributeMap

AttributeMapConfig getAttributeMap()

Attribute Maps

Returns:

The attributeMap value

setAttributeMap

void setAttributeMap(AttributeMapConfig attributeMap)

Sets the attributeMap attribute of the ConnectorConfig object

Parameters:

attributeMap - The new attributeMap value

getAttributeMap

AttributeMapConfig getAttributeMap(boolean input)

Gets the attributeMap attribute of the ConnectorConfig object

Parameters:

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

Returns:

The attributeMap value

getAttributeMap

AttributeMapConfig getAttributeMap(Object name)

Gets the attributeMap attribute of the ConnectorConfig object

Parameters:

name - the name of the Attribute map to retrieve

Returns:

The attributeMap value

setAttributeMap

void setAttributeMap(AttributeMapConfig attributeMap,
                     boolean input)

Sets the attributeMap attribute of the ConnectorConfig object

Parameters:

attributeMap - The new attributeMap value

input - The new attributeMap value

getLinkCriteria

LinkCriteriaConfig getLinkCriteria()

Link Criteria

Returns:

The linkCriteria value

setLinkCriteria

void setLinkCriteria(LinkCriteriaConfig linkCriteria)

Sets the linkCriteria attribute of the ConnectorConfig object

Parameters:

linkCriteria - The new linkCriteria value

getHooks

HooksConfig getHooks()

Hooks

Returns:

The hooks value

getConnectionConfig

RawConnectorConfig getConnectionConfig()

Connection parameters

Returns:

The connectionConfig value

getParserConfig

ParserConfig getParserConfig()

Associated Parser configuration

Returns:

The parserConfig value

setParserConfig

void setParserConfig(ParserConfig parser)

Sets the parserConfig attribute of the ConnectorConfig object

Parameters:

parser - The new parserConfig value

getState

String getState()

State (typically used in the AssemblyLine)

Returns:

The configured state

setState

void setState(String state)

Sets the state attribute of the ConnectorConfig object

Parameters:

state - The new state

getEnabled

boolean getEnabled()

Enabled (typically used in the AssemblyLine)

Specified by:

getEnabled in interface BaseConfiguration

Returns:

The enabled value

setEnabled

void setEnabled(boolean enabled)

Sets the enabled attribute of the ConnectorConfig object

Specified by:

setEnabled in interface BaseConfiguration

Parameters:

enabled - The new enabled value

getComputeChanges

boolean getComputeChanges()

Returns the compute-changes flag for Update mode connector.

Returns:

The enabled value

setComputeChanges

void setComputeChanges(boolean cc)

Sets the compute-changes flag for Update mode connector.

Parameters:

cc - The new enabled value

getDeltaConfig

DeltaConfig getDeltaConfig()

Returns the delta configuration

getPoolDefConfig

PoolDefConfig getPoolDefConfig()

Returns the Connector Pool definition configuration

getPoolInstanceConfig

PoolInstanceConfig getPoolInstanceConfig()

Returns the Connector Pool instance configuration

getCheckpointConfig

CheckpointConfig getCheckpointConfig()

Returns the checkpoint configuration.

getSandboxConfig

SandboxConfig getSandboxConfig()

Returns the checkpoint configuration.

getDeltaBehavior

int getDeltaBehavior()

Returns true if the connector uses delta behavior

setDeltaBehavior

void setDeltaBehavior(int behavior)

Sets delta behavior

getDeltaStrict

boolean getDeltaStrict()

Returns the delta strict flag

setDeltaStrict

void setDeltaStrict(boolean strict)

Sets the delta strict flag

getServerOption

String getServerOption()

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

getReplyRequired

boolean getReplyRequired()

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

isEntryFeed

boolean isEntryFeed()

Returns true if the connector is an entry feed connector

getOperationCarrier

String getOperationCarrier()

This method returns the name of the operation carrier

setOperationCarrier

void setOperationCarrier(String name)

This method sets the name of the operation carrier

getOperationCarrierIsProperty

boolean getOperationCarrierIsProperty()

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

setOperationCarrierIsProperty

void setOperationCarrierIsProperty(boolean isproperty)

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

getReconnectConfig

ReconnectConfig getReconnectConfig()

Returns the reconnect config

getInitializeOption

int getInitializeOption()

This method returns the initialization option for the component

setInitializeOption

void setInitializeOption(int option)

This method sets the the initialization option for the component