com.ibm.di.connector
Class CommandLineConnector

java.lang.Object
  com.ibm.di.connector.Connector
      com.ibm.di.connector.CommandLineConnector

All Implemented Interfaces:

ConnectorInterface, VersionInfoInterface

public class CommandLineConnector
extends Connector
implements ConnectorInterface

Field Summary

static String	ATTR_COMMAND_LINE
static String	ATTR_COMMAND_OUTPUT

Fields inherited from class com.ibm.di.connector.Connector

ALL_MODES, myLog, PROPERTY_MESSAGE, PROPERTY_READER, PROPERTY_WRITER

Constructor Summary

CommandLineConnector()

Method Summary

Entry	getNextEntry() Returns the next Entry from the connector.
String	getVersion() Return version information
void	initialize(Object o) Initialize the connector.
void	putEntry(Entry entry) Adds a new entry to the data source
Entry	queryReply(Entry aEntry) Performs a query/reply operations.
void	selectEntries() Prepare the Connector for sequential read.
void	terminate() Terminate the connector.

Methods inherited from class com.ibm.di.connector.Connector

addFindEntry, allModes, clearFindEntries, debug, debugMode, deleteEntry, findEntry, findEntry, getBoolean, getClassInstance, getConfiguration, getContext, getFindEntryCount, getFirstFindEntry, getLog, getMaxDuplicateEntries, getModes, getModes, getName, getNextClient, getNextFindEntry, getParam, getParser, getProperty, getPushbackEntry, getRawConnectorConfiguration, getRSInterface, hasConfigValue, hasParser, initParser, isDeltaSupported, isExceptionFatal, isIOException, logmsg, modEntry, modEntry, pushback, queryOperations, querySchema, queryTables, reconnect, reconnect, registerScriptBeans, replyEntry, setConfiguration, setContext, setCurrent, setLog, setMaxDuplicateEntries, setModes, setModes, setName, setParam, setParser, setProperty, setRSInterface, terminateServer

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.di.connector.ConnectorInterface

deleteEntry, findEntry, getConfiguration, getContext, getFindEntryCount, getFirstFindEntry, getMaxDuplicateEntries, getName, getNextClient, getNextFindEntry, getParam, getPushbackEntry, getRawConnectorConfiguration, isDeltaSupported, isExceptionFatal, isIOException, modEntry, modEntry, pushback, queryOperations, querySchema, reconnect, registerScriptBeans, replyEntry, setConfiguration, setContext, setCurrent, setLog, setMaxDuplicateEntries, setName, setParam, setRSInterface, terminateServer

Field Detail

ATTR_COMMAND_LINE

public static final String ATTR_COMMAND_LINE

See Also:

Constant Field Values

ATTR_COMMAND_OUTPUT

public static final String ATTR_COMMAND_OUTPUT

See Also:

Constant Field Values

Constructor Detail

CommandLineConnector

public CommandLineConnector()

Method Detail

initialize

public void initialize(Object o)
                throws Exception

Description copied from class: Connector

Initialize the connector. The connector may be passed a parameter of any kind by the user. It is up to the connector to determine whether this object can be used or not. The parameter is typically provided by a user script. When an AssemblyLine initializes it's Connectors, they are passed a ConnectorMode object.

Specified by:

initialize in interface ConnectorInterface

Overrides:

initialize in class Connector

Parameters:

o - User provided parameter

Throws:

Exception

terminate

public void terminate()
               throws Exception

Description copied from class: Connector

Terminate the connector. This function closes all connection and releases all resources used by the connector. This function also calls the parser's closeParser() method if a parser is active.

Specified by:

terminate in interface ConnectorInterface

Overrides:

terminate in class Connector

Throws:

Exception

selectEntries

public void selectEntries()
                   throws Exception

Description copied from class: Connector

Prepare the Connector for sequential read. If necessary, create a result set to be used for getNextEntry(). When the Connector is used as an Iterator in an AssemblyLine, this method will be called. Default is an empty method.

Specified by:

selectEntries in interface ConnectorInterface

Overrides:

selectEntries in class Connector

Throws:

Exception

getNextEntry

public Entry getNextEntry()
                   throws Exception

Description copied from class: Connector

Returns the next Entry from the connector. The entry is populated with attributes and values from the next entry in the input set.

Specified by:

getNextEntry in interface ConnectorInterface

Overrides:

getNextEntry in class Connector

Returns:

- the next Entry, or null if no more data

Throws:

Exception

See Also:

Connector.selectEntries()

putEntry

public void putEntry(Entry entry)
              throws Exception

Description copied from class: Connector

Adds a new entry to the data source

Specified by:

putEntry in interface ConnectorInterface

Overrides:

putEntry in class Connector

Parameters:

entry - The entry data to add

Throws:

Exception - Any exceptions thrown by the connector's underlying classes

queryReply

public Entry queryReply(Entry aEntry)
                 throws Exception

Description copied from class: Connector

Performs a query/reply operations.

Specified by:

queryReply in interface ConnectorInterface

Overrides:

queryReply in class Connector

Parameters:

aEntry - The data used in outgoing call

Returns:

The entry returned by the peer

Throws:

Exception - Any exceptions thrown by the connector's underlying classes

getVersion

public String getVersion()

Return version information

Specified by:

getVersion in interface VersionInfoInterface