com.ibm.di.connector.dominoUsers
Class DominoUsersConnector

java.lang.Object
  com.ibm.di.connector.Connector
      com.ibm.di.connector.dominoUsers.DominoUsersConnector

All Implemented Interfaces:

ConnectorInterface, VersionInfoInterface, Runnable

public class DominoUsersConnector
extends Connector
implements Runnable, ConnectorInterface

Field Summary

protected static String	ADMIN_DATABASE_NAME
static String	ATTR_NAME_ALT_FULL_NAME
static String	ATTR_NAME_ALT_FULL_NAME_LANGUAGE
static String	ATTR_NAME_COMMENT
static String	ATTR_NAME_DER_IS_ENABLED
static String	ATTR_NAME_FIRST_NAME
static String	ATTR_NAME_FORM
static String	ATTR_NAME_FULL_NAME
static String	ATTR_NAME_HTTP_PASSWORD
static String	ATTR_NAME_LAST_NAME
static String	ATTR_NAME_LOCATION
static String	ATTR_NAME_MAIL_DB_INHERIT
static String	ATTR_NAME_MAIL_FILE
static String	ATTR_NAME_MAIL_TEMPLATE_FILE
static String	ATTR_NAME_MAIL_TEMPLATE_SERVER
static String	ATTR_NAME_MIDDLE_INITIAL
static String	ATTR_NAME_REG_CREATE_MAIL_DB
static String	ATTR_NAME_REG_PERFORM
static String	ATTR_NAME_REG_SERVER
static String	ATTR_NAME_TYPE
protected static String	FORMULA_FORM_PERSON
protected static String	NAB_DEFAULT_VALUE
static String	PROP_AUTHORS
static String	PROP_IS_SIGNED
static String	PROP_IS_VALID
static String	PROP_NOTE_ID
static String	PROP_UNIVERSAL_ID
static String	PROP_VERIFIER
protected static String	VIEW_PEOPLE

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

ALL_MODES, myLog, PROPERTY_MESSAGE, PROPERTY_READER, PROPERTY_WRITER

Constructor Summary

DominoUsersConnector()

Method Summary

protected void	checkExtractAndExecuteDominoAction(IDominoAction aDominoAction, Entry aEntry)
protected Entry	clearFixedDominoActionAttributes(IDominoAction aDominoAction, Entry aEntry)
void	deleteEntry(Entry aEntry, SearchCriteria aSearch) Deletes an existing entry.
Entry	findEntry(SearchCriteria aSearch) Finds an existing entry.
String	getDeleteGroupName()
int	getDeleteMailFile()
Entry	getNextEntry() Returns the next Entry from the connector.
static ResourceHash	getResHash()
String	getVersion()
void	initialize(Object aObject) Initialize the connector.
void	modEntry(Entry aEntry, SearchCriteria aSearch) Modifies an existing entry.
protected boolean	mustPerformDominoAction(IDominoAction aDominoAction, Entry aEntry)
protected void	performDominoAction(IDominoAction aDominoAction)
void	putEntry(Entry aEntry) Adds a new entry to the data source
protected void	resetAndExtractData(IDominoAction aDominoAction, Entry aEntry)
void	run()
void	selectEntries() Prepare the Connector for sequential read.
void	setDeleteGroupName(String aGroupName)
void	setDeleteMailFile(int aDeleteType)
void	terminate() Terminate the connector.

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, hasConfigValue, hasParser, initParser, isDeltaSupported, isExceptionFatal, isIOException, logmsg, modEntry, pushback, queryOperations, queryReply, 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

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

Field Detail

ATTR_NAME_FORM

public static final String ATTR_NAME_FORM

See Also:

Constant Field Values

ATTR_NAME_TYPE

public static final String ATTR_NAME_TYPE

See Also:

Constant Field Values

ATTR_NAME_FIRST_NAME

public static final String ATTR_NAME_FIRST_NAME

See Also:

Constant Field Values

ATTR_NAME_MIDDLE_INITIAL

public static final String ATTR_NAME_MIDDLE_INITIAL

See Also:

Constant Field Values

ATTR_NAME_LAST_NAME

public static final String ATTR_NAME_LAST_NAME

See Also:

Constant Field Values

ATTR_NAME_FULL_NAME

public static final String ATTR_NAME_FULL_NAME

See Also:

Constant Field Values

ATTR_NAME_MAIL_FILE

public static final String ATTR_NAME_MAIL_FILE

See Also:

Constant Field Values

ATTR_NAME_LOCATION

public static final String ATTR_NAME_LOCATION

See Also:

Constant Field Values

ATTR_NAME_COMMENT

public static final String ATTR_NAME_COMMENT

See Also:

Constant Field Values

ATTR_NAME_ALT_FULL_NAME

public static final String ATTR_NAME_ALT_FULL_NAME

See Also:

Constant Field Values

ATTR_NAME_ALT_FULL_NAME_LANGUAGE

public static final String ATTR_NAME_ALT_FULL_NAME_LANGUAGE

See Also:

Constant Field Values

ATTR_NAME_HTTP_PASSWORD

public static final String ATTR_NAME_HTTP_PASSWORD

See Also:

Constant Field Values

ATTR_NAME_REG_SERVER

public static final String ATTR_NAME_REG_SERVER

See Also:

Constant Field Values

ATTR_NAME_REG_CREATE_MAIL_DB

public static final String ATTR_NAME_REG_CREATE_MAIL_DB

See Also:

Constant Field Values

ATTR_NAME_REG_PERFORM

public static final String ATTR_NAME_REG_PERFORM

See Also:

Constant Field Values

ATTR_NAME_MAIL_TEMPLATE_FILE

public static final String ATTR_NAME_MAIL_TEMPLATE_FILE

See Also:

Constant Field Values

ATTR_NAME_MAIL_DB_INHERIT

public static final String ATTR_NAME_MAIL_DB_INHERIT

See Also:

Constant Field Values

ATTR_NAME_MAIL_TEMPLATE_SERVER

public static final String ATTR_NAME_MAIL_TEMPLATE_SERVER

See Also:

Constant Field Values

ATTR_NAME_DER_IS_ENABLED

public static final String ATTR_NAME_DER_IS_ENABLED

See Also:

Constant Field Values

PROP_NOTE_ID

public static final String PROP_NOTE_ID

See Also:

Constant Field Values

PROP_UNIVERSAL_ID

public static final String PROP_UNIVERSAL_ID

See Also:

Constant Field Values

PROP_AUTHORS

public static final String PROP_AUTHORS

See Also:

Constant Field Values

PROP_IS_VALID

public static final String PROP_IS_VALID

See Also:

Constant Field Values

PROP_IS_SIGNED

public static final String PROP_IS_SIGNED

See Also:

Constant Field Values

PROP_VERIFIER

public static final String PROP_VERIFIER

See Also:

Constant Field Values

NAB_DEFAULT_VALUE

protected static final String NAB_DEFAULT_VALUE

See Also:

Constant Field Values

ADMIN_DATABASE_NAME

protected static final String ADMIN_DATABASE_NAME

See Also:

Constant Field Values

VIEW_PEOPLE

protected static final String VIEW_PEOPLE

See Also:

Constant Field Values

FORMULA_FORM_PERSON

protected static final String FORMULA_FORM_PERSON

See Also:

Constant Field Values

Constructor Detail

DominoUsersConnector

public DominoUsersConnector()

Method Detail

getResHash

public static ResourceHash getResHash()

run

public void run()

Specified by:

run in interface Runnable

initialize

public void initialize(Object aObject)
                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:

aObject - 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()

findEntry

public Entry findEntry(SearchCriteria aSearch)
                throws Exception

Description copied from class: Connector

Finds an existing entry. The search criteria specifies which entry to locate

Specified by:

findEntry in interface ConnectorInterface

Overrides:

findEntry in class Connector

Parameters:

aSearch - The search criteria used to locate the entry to be modified

Returns:

The entry found, or null if no or multiple entries found

Throws:

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

modEntry

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

Description copied from class: Connector

Modifies an existing entry. The new entry data is given by the entry parameter and the search criteria specifies which entry to modify.

Specified by:

modEntry in interface ConnectorInterface

Overrides:

modEntry in class Connector

Parameters:

aEntry - The entry data

aSearch - The search criteria used to locate the entry to be modified

Throws:

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

putEntry

public void putEntry(Entry aEntry)
              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:

aEntry - The entry data to add

Throws:

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

deleteEntry

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

Description copied from class: Connector

Deletes an existing entry. The search criteria specifies which entry to modify. Some connectors may silently ignore the search criteria. For example, the LDAP connector will use the distinguished name ($dn) from the entry parameter (if it exists) rather than expanding the search criteria and search for the entry. Each connector's inner semantics governs wheter the search parameter is used or not.

Specified by:

deleteEntry in interface ConnectorInterface

Overrides:

deleteEntry in class Connector

Parameters:

aEntry - The entry data

aSearch - The search criteria used to locate the entry to be deleted

Throws:

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

terminate

public void terminate()

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

getVersion

public String getVersion()

Specified by:

getVersion in interface VersionInfoInterface

getDeleteMailFile

public int getDeleteMailFile()

setDeleteMailFile

public void setDeleteMailFile(int aDeleteType)
                       throws Exception

Throws:

Exception

getDeleteGroupName

public String getDeleteGroupName()

setDeleteGroupName

public void setDeleteGroupName(String aGroupName)
                        throws Exception

Throws:

Exception

mustPerformDominoAction

protected boolean mustPerformDominoAction(IDominoAction aDominoAction,
                                          Entry aEntry)
                                   throws Exception

Throws:

Exception

resetAndExtractData

protected void resetAndExtractData(IDominoAction aDominoAction,
                                   Entry aEntry)
                            throws Exception

Throws:

Exception

performDominoAction

protected void performDominoAction(IDominoAction aDominoAction)
                            throws Exception

Throws:

Exception

clearFixedDominoActionAttributes

protected Entry clearFixedDominoActionAttributes(IDominoAction aDominoAction,
                                                 Entry aEntry)
                                          throws Exception

Throws:

Exception

checkExtractAndExecuteDominoAction

protected void checkExtractAndExecuteDominoAction(IDominoAction aDominoAction,
                                                  Entry aEntry)
                                           throws Exception

Throws:

Exception