com.ibm.di.connector
Class FileConnector

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

All Implemented Interfaces:

ConnectorInterface, CheckpointRestartInterface, VersionInfoInterface

public class FileConnector
extends Connector
implements ConnectorInterface, CheckpointRestartInterface

Field Summary

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

ALL_MODES, myLog, PROPERTY_MESSAGE, PROPERTY_READER, PROPERTY_WRITER

Fields inherited from interface com.ibm.di.server.CheckpointRestartInterface

RESTART_AFTER, RESTART_BEFORE, RESTART_IN

Constructor Summary

FileConnector()

Method Summary

void	acquireLock(FileChannel fc, long timeout, boolean shared)
Entry	getCheckpointInformation() Returns the state information for the connector.
Entry	getNextEntry() Returns the next Entry from the connector.
String	getVersion() Return version information
void	initialize(Object o) Initialize the connector.
boolean	isCheckpointRestartEnabled(int mode) Components that support checkpoint/restart for a specific mode must return TRUE from this method.
void	openReadFile()
void	openWriteFile()
void	prepareForRestart(ALState state, Entry restartInfo, int restartPoint) Notifies the connector of a restart situation.
void	putEntry(Entry entry) Adds a new entry to the data source
void	reconnect() Reconnect to the underlying data source.
void	releaseLock()
void	selectEntries() Prepare the Connector for sequential read.

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, queryReply, querySchema, queryTables, reconnect, registerScriptBeans, replyEntry, setConfiguration, setContext, setCurrent, setLog, setMaxDuplicateEntries, setModes, setModes, setName, setParam, setParser, setProperty, setRSInterface, terminate, 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, queryReply, querySchema, reconnect, registerScriptBeans, replyEntry, setConfiguration, setContext, setCurrent, setLog, setMaxDuplicateEntries, setName, setParam, setRSInterface, terminate, terminateServer

Constructor Detail

FileConnector

public FileConnector()

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

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

openReadFile

public void openReadFile()
                  throws Exception

Throws:

Exception

openWriteFile

public void openWriteFile()
                   throws Exception

Throws:

Exception

acquireLock

public void acquireLock(FileChannel fc,
                        long timeout,
                        boolean shared)
                 throws Exception

Throws:

Exception

releaseLock

public void releaseLock()

getVersion

public String getVersion()

Return version information

Specified by:

getVersion in interface VersionInfoInterface

isCheckpointRestartEnabled

public boolean isCheckpointRestartEnabled(int mode)

Components that support checkpoint/restart for a specific mode must return TRUE from this method. If a restart has no meaning for mode then the connector should still return TRUE.

Specified by:

isCheckpointRestartEnabled in interface CheckpointRestartInterface

Parameters:

mode - The mode the connector runs in

Returns:

true if checkpoint is supported in mode

See Also:

ServerConstants

getCheckpointInformation

public Entry getCheckpointInformation()
                               throws Exception

Returns the state information for the connector. If for some reason the connector decidies that a restart is impossible it must throw an exception. The method is called immediatly before any component methods are called. If there is no need to save any state information a null value should be returned. For eventhandlers this method is called by the dispatcher routine.

Specified by:

getCheckpointInformation in interface CheckpointRestartInterface

Returns:

The entry the connector needs to do a restart or null if that is not needed.

Throws:

Exception

prepareForRestart

public void prepareForRestart(ALState state,
                              Entry restartInfo,
                              int restartPoint)
                       throws Exception

Notifies the connector of a restart situation. This method is called after the connector has been loaded and before any other method calls are made to the connector. If the connector decides it cannot restart it must throw an exception.

Specified by:

prepareForRestart in interface CheckpointRestartInterface

Parameters:

restartInfo - The last entry object returned by the connector in the getCheckpointInformation method

state - The ALState object for the AssemblyLine

restartPoint - The relative point where restarting is taking place (e.g. RESTART_BEFORE ...)

Throws:

Exception

reconnect

public void reconnect()
               throws Exception

Description copied from class: Connector

Reconnect to the underlying data source.

Overrides:

reconnect in class Connector

Throws:

Exception