com.ibm.di.connector.dominoUsers
Class UserRegistration

java.lang.Object
  com.ibm.di.connector.dominoUsers.UserRegistration

All Implemented Interfaces:

IDominoAction

public class UserRegistration
extends Object
implements IDominoAction

Field Summary

static String	ATTR_NAME_REG_ALT_ORG_UNIT
static String	ATTR_NAME_REG_ALT_ORG_UNIT_LANG
static String	ATTR_NAME_REG_CERT_PASSWORD
static String	ATTR_NAME_REG_CERTIFIER_ID_FILE
static String	ATTR_NAME_REG_CREATE_MAIL_DB
static String	ATTR_NAME_REG_EXPIRATION
static String	ATTR_NAME_REG_FORWARD
static String	ATTR_NAME_REG_ID_FILE
static String	ATTR_NAME_REG_ID_TYPE
static String	ATTR_NAME_REG_IS_NORTH_AMERICAN
static String	ATTR_NAME_REG_MIN_PASSWORD_LENGTH
static String	ATTR_NAME_REG_ORG_UNIT
static String	ATTR_NAME_REG_PERFORM
static String	ATTR_NAME_REG_REGISTRATION_LOG
static String	ATTR_NAME_REG_REGISTRATION_SERVER
static String	ATTR_NAME_REG_SERVER
static String	ATTR_NAME_REG_STORE_ID_IN_ADDRESS_BOOK
static String	ATTR_NAME_REG_USER_PW
static int	ATTR_VALUE_ID_TYPE_CERTIFIER
static int	ATTR_VALUE_ID_TYPE_FLAT_ID
static int	ATTR_VALUE_ID_TYPE_HIERARCHICAL_ID

Constructor Summary

UserRegistration(DominoUsersConnector aParent)

Method Summary

String	canPerform() Inspects the data stored in the local data holders and determines if it is consistent and the Domino Action can be performed.
Entry	extractAndStoreData(Entry aEntry) This method extracts and stores data.
boolean	mustPerform(Entry aEntry) Inspects the Attributes of the given Entry and determines if the Domino Action has to be performed.
void	perform() Performs the Domino Action useing the data from the local data holders.
void	resetData() Resets the local data holders to empty/default values according the business logic of the Domino Action.

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME_REG_PERFORM

public static final String ATTR_NAME_REG_PERFORM

See Also:

Constant Field Values

ATTR_NAME_REG_ID_FILE

public static final String ATTR_NAME_REG_ID_FILE

See Also:

Constant Field Values

ATTR_NAME_REG_USER_PW

public static final String ATTR_NAME_REG_USER_PW

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_CERTIFIER_ID_FILE

public static final String ATTR_NAME_REG_CERTIFIER_ID_FILE

See Also:

Constant Field Values

ATTR_NAME_REG_CERT_PASSWORD

public static final String ATTR_NAME_REG_CERT_PASSWORD

See Also:

Constant Field Values

ATTR_NAME_REG_FORWARD

public static final String ATTR_NAME_REG_FORWARD

See Also:

Constant Field Values

ATTR_NAME_REG_ALT_ORG_UNIT

public static final String ATTR_NAME_REG_ALT_ORG_UNIT

See Also:

Constant Field Values

ATTR_NAME_REG_ALT_ORG_UNIT_LANG

public static final String ATTR_NAME_REG_ALT_ORG_UNIT_LANG

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_EXPIRATION

public static final String ATTR_NAME_REG_EXPIRATION

See Also:

Constant Field Values

ATTR_NAME_REG_ID_TYPE

public static final String ATTR_NAME_REG_ID_TYPE

See Also:

Constant Field Values

ATTR_NAME_REG_IS_NORTH_AMERICAN

public static final String ATTR_NAME_REG_IS_NORTH_AMERICAN

See Also:

Constant Field Values

ATTR_NAME_REG_MIN_PASSWORD_LENGTH

public static final String ATTR_NAME_REG_MIN_PASSWORD_LENGTH

See Also:

Constant Field Values

ATTR_NAME_REG_ORG_UNIT

public static final String ATTR_NAME_REG_ORG_UNIT

See Also:

Constant Field Values

ATTR_NAME_REG_REGISTRATION_LOG

public static final String ATTR_NAME_REG_REGISTRATION_LOG

See Also:

Constant Field Values

ATTR_NAME_REG_REGISTRATION_SERVER

public static final String ATTR_NAME_REG_REGISTRATION_SERVER

See Also:

Constant Field Values

ATTR_NAME_REG_STORE_ID_IN_ADDRESS_BOOK

public static final String ATTR_NAME_REG_STORE_ID_IN_ADDRESS_BOOK

See Also:

Constant Field Values

ATTR_VALUE_ID_TYPE_FLAT_ID

public static final int ATTR_VALUE_ID_TYPE_FLAT_ID

See Also:

Constant Field Values

ATTR_VALUE_ID_TYPE_HIERARCHICAL_ID

public static final int ATTR_VALUE_ID_TYPE_HIERARCHICAL_ID

See Also:

Constant Field Values

ATTR_VALUE_ID_TYPE_CERTIFIER

public static final int ATTR_VALUE_ID_TYPE_CERTIFIER

See Also:

Constant Field Values

Constructor Detail

UserRegistration

public UserRegistration(DominoUsersConnector aParent)
                 throws Exception

Throws:

Exception

Method Detail

extractAndStoreData

public Entry extractAndStoreData(Entry aEntry)
                          throws Exception

Description copied from interface: IDominoAction

This method extracts and stores data. It performs the following actions:

(1) Extract data from the given Entry according to the fixed schema of Attributes;

(2) Stores this data into local data holders;

Specified by:

extractAndStoreData in interface IDominoAction

Parameters:

aEntry - The Entry object to extract data from.

Returns:

an Entry object that contains all Attributes of the aEntry parameter except those from the fixed schema.

Throws:

Exception - if an error that cannot be handled occurs while operating.

mustPerform

public boolean mustPerform(Entry aEntry)
                    throws Exception

Description copied from interface: IDominoAction

Inspects the Attributes of the given Entry and determines if the Domino Action has to be performed.

Specified by:

mustPerform in interface IDominoAction

Parameters:

aEntry - The Entry object which Attributes hold the necessary information whether to perform the Domino Action.

Returns:

"true" if the Domino Action must be performed; "false" otherwise.

Throws:

Exception - if an error that cannot be handled occurs while operating.

canPerform

public String canPerform()

Description copied from interface: IDominoAction

Inspects the data stored in the local data holders and determines if it is consistent and the Domino Action can be performed.

Specified by:

canPerform in interface IDominoAction

Returns:

"null" if the Domino Action can be performed with the current data;

and a non-empty string message explaining the problem, if the data is not consistent and the Action cannot be performed.

perform

public void perform()
             throws Exception

Description copied from interface: IDominoAction

Performs the Domino Action useing the data from the local data holders.

Specified by:

perform in interface IDominoAction

Throws:

Exception - if an error that cannot be handled occurs while operating.

resetData

public void resetData()
               throws Exception

Description copied from interface: IDominoAction

Resets the local data holders to empty/default values according the business logic of the Domino Action.

Specified by:

resetData in interface IDominoAction

Throws:

Exception - if an error that cannot be handled occurs while operating.