com.ibm.di.connector
Class ITIMAgentConnector

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

All Implemented Interfaces:

ConnectorInterface, VersionInfoInterface

public class ITIMAgentConnector
extends Connector
implements ConnectorInterface

The ITIM Agent Connector is an adapter between the TDI Connector API and the ITIM DAML JNDI package. Rather than using the built-in TDI JNDI Connector, this Connector allows the specifics of configuration to be controlled and can hide details in the JNDI setup that are irrelevant when talking to a DAML endpoint.

Field Summary

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

ALL_MODES, myLog, PROPERTY_MESSAGE, PROPERTY_READER, PROPERTY_WRITER

Constructor Summary

ITIMAgentConnector()
Constructor of the ITIM Agent Connector.

Method Summary

void	deleteEntry(Entry aEntry, SearchCriteria aSearch) Deletes a JNDI Entry.
Entry	findEntry(SearchCriteria aSearch) Finds a JNDI Entry given search criteria.
Entry	getNextEntry() Retrieves the next Entry object from the search results.
java.lang.String	getVersion() Version information.
void	initialize(java.lang.Object aObject) Reads Connector parameters and creates the JNDI context.
void	modEntry(Entry aEntry, SearchCriteria aSearch) Modifies a JNDI Entry.
void	modEntry(Entry aEntry, SearchCriteria aSearch, Entry aOldEntry) Modifies a JNDI Entry.
void	putEntry(Entry aEntry) Adds the given Entry as a new JNDI Subcontext.
void	selectEntries() Performs a JNDI search operation with the search controls specified.
void	terminate() Closes the JNDI context.

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

addFindEntry, allModes, clearFindEntries, debug, debugMode, findEntry, getBoolean, getClassInstance, getConfiguration, getContext, getFindEntryCount, getFirstFindEntry, getLog, getMaxDuplicateEntries, getModes, getModes, getName, getNextClient, getNextFindEntry, getParam, getParser, getProperty, getPushbackEntry, getRawConnectorConfiguration, getRSInterface, getUI, hasConfigValue, hasParser, initParser, isDeltaSupported, isExceptionFatal, isIOException, logError, logmsg, pushback, queryOperations, queryReply, querySchema, queryTables, reconnect, reconnect, registerScriptBeans, replyEntry, setConfiguration, setContext, setCurrent, setDebugMode, 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

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

Constructor Detail

ITIMAgentConnector

public ITIMAgentConnector()

Constructor of the ITIM Agent Connector.

Method Detail

initialize

public void initialize(java.lang.Object aObject)
                throws java.lang.Exception

Reads Connector parameters and creates the JNDI context.

Specified by:

initialize in interface ConnectorInterface

Overrides:

initialize in class Connector

Parameters:

aObject - - ignored

Throws:

java.lang.Exception - if a required parameter is missing or the JNDI context initialization fails.

selectEntries

public void selectEntries()
                   throws java.lang.Exception

Performs a JNDI search operation with the search controls specified.

Specified by:

selectEntries in interface ConnectorInterface

Overrides:

selectEntries in class Connector

Throws:

java.lang.Exception - if the search operation fails.

getNextEntry

public Entry getNextEntry()
                   throws java.lang.Exception

Retrieves the next Entry object from the search results.

Specified by:

getNextEntry in interface ConnectorInterface

Overrides:

getNextEntry in class Connector

Returns:

the next entry or null if no more entries are found.

Throws:

java.lang.Exception - if an error occurs.

See Also:

ConnectorInterface.selectEntries()

putEntry

public void putEntry(Entry aEntry)
              throws java.lang.Exception

Adds the given Entry as a new JNDI Subcontext.

Specified by:

putEntry in interface ConnectorInterface

Overrides:

putEntry in class Connector

Parameters:

aEntry - the entry to add

Throws:

java.lang.Exception - if an error occurs.

modEntry

public void modEntry(Entry aEntry,
                     SearchCriteria aSearch)
              throws java.lang.Exception

Modifies a JNDI Entry.

Specified by:

modEntry in interface ConnectorInterface

Overrides:

modEntry in class Connector

Parameters:

aEntry - the entry, result of the Output Mapping

aSearch - the search criteria used to find the entry in the back-end server.

Throws:

java.lang.Exception - if an error occurs.

modEntry

public void modEntry(Entry aEntry,
                     SearchCriteria aSearch,
                     Entry aOldEntry)
              throws java.lang.Exception

Modifies a JNDI Entry.

Specified by:

modEntry in interface ConnectorInterface

Overrides:

modEntry in class Connector

Parameters:

aEntry - the entry, result of the Output Mapping

aSearch - the search criteria used to find the entry in the back-end server.

aOldEntry - the found entry in the back-end server.

Throws:

java.lang.Exception - if the old entry is null, a distinguished name is not provided or other type of an error occurs.

deleteEntry

public void deleteEntry(Entry aEntry,
                        SearchCriteria aSearch)
                 throws java.lang.Exception

Deletes a JNDI Entry.

Specified by:

deleteEntry in interface ConnectorInterface

Overrides:

deleteEntry in class Connector

Parameters:

aEntry - the entry, result of the Otuput Mapping

aSearch - the search criteria used to find the entry to delete.

Throws:

java.lang.Exception - if the aEntry parameter is null, the distinguished name is not provided or other type of an error occurs.

findEntry

public Entry findEntry(SearchCriteria aSearch)
                throws java.lang.Exception

Finds a JNDI Entry given search criteria.

Specified by:

findEntry in interface ConnectorInterface

Overrides:

findEntry in class Connector

Parameters:

aSearch - the search criteria used to find the entry.

Returns:

the found entry object, or null.

Throws:

java.lang.Exception - if an error occurs.

terminate

public void terminate()

Closes the JNDI context.

Specified by:

terminate in interface ConnectorInterface

Overrides:

terminate in class Connector

getVersion

public java.lang.String getVersion()

Version information.

Specified by:

getVersion in interface VersionInfoInterface

Returns:

the version information.