com.ibm.di.connector.dominoUsers
Class UserRegistration

java.lang.Object
  extended by com.ibm.di.connector.dominoUsers.UserRegistration
All Implemented Interfaces:
IDominoAction

public class UserRegistration
extends java.lang.Object
implements IDominoAction

This class performs a user registration from Domino.


Field Summary
static java.lang.String ATTR_NAME_REG_ALT_ORG_UNIT
          Attribute name - "REG_AltOrgUnit".
static java.lang.String ATTR_NAME_REG_ALT_ORG_UNIT_LANG
          Attribute name - "REG_AltOrgUnitLang".
static java.lang.String ATTR_NAME_REG_CERT_PASSWORD
          Attribute name - "REG_CertPassword".
static java.lang.String ATTR_NAME_REG_CERTIFIER_ID_FILE
          Attribute name - "REG_CertifierIDFile".
static java.lang.String ATTR_NAME_REG_CREATE_MAIL_DB
          Attribute name - "REG_CreateMailDb".
static java.lang.String ATTR_NAME_REG_EXPIRATION
          Attribute name - "REG_Expiration".
static java.lang.String ATTR_NAME_REG_FORWARD
          Attribute name - "REG_Forward".
static java.lang.String ATTR_NAME_REG_ID_FILE
          Attribute name - "REG_IdFile".
static java.lang.String ATTR_NAME_REG_ID_TYPE
          Attribute name - "REG_IDType".
static java.lang.String ATTR_NAME_REG_IS_NORTH_AMERICAN
          Attribute name - "REG_IsNorthAmerican".
static java.lang.String ATTR_NAME_REG_MIN_PASSWORD_LENGTH
          Attribute name - "REG_MinPasswordLength".
static java.lang.String ATTR_NAME_REG_ORG_UNIT
          Attribute name - "REG_OrgUnit".
static java.lang.String ATTR_NAME_REG_PERFORM
          Attribute name - "REG_Perform".
static java.lang.String ATTR_NAME_REG_REGISTRATION_LOG
          Attribute name - "REG_RegistrationLog".
static java.lang.String ATTR_NAME_REG_REGISTRATION_SERVER
          Attribute name - "REG_RegistrationServer".
static java.lang.String ATTR_NAME_REG_SERVER
          Attribute name - "REG_Server".
static java.lang.String ATTR_NAME_REG_STORE_ID_IN_ADDRESS_BOOK
          Attribute name - "REG_StoreIDInAddressBook".
static java.lang.String ATTR_NAME_REG_USER_PW
          Attribute name - "REG_UserPw".
static int ATTR_VALUE_ID_TYPE_CERTIFIER
          Attribute value for ID type - certifier.
static int ATTR_VALUE_ID_TYPE_FLAT_ID
          Attribute value for ID type - flat id.
static int ATTR_VALUE_ID_TYPE_HIERARCHICAL_ID
          Attribute value for ID type - hierarchical id.
 
Constructor Summary
UserRegistration(DominoUsersConnector aParent)
          Class contructor
 
Method Summary
 java.lang.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 java.lang.String ATTR_NAME_REG_PERFORM
Attribute name - "REG_Perform".

See Also:
Constant Field Values

ATTR_NAME_REG_ID_FILE

public static final java.lang.String ATTR_NAME_REG_ID_FILE
Attribute name - "REG_IdFile".

See Also:
Constant Field Values

ATTR_NAME_REG_USER_PW

public static final java.lang.String ATTR_NAME_REG_USER_PW
Attribute name - "REG_UserPw".

See Also:
Constant Field Values

ATTR_NAME_REG_SERVER

public static final java.lang.String ATTR_NAME_REG_SERVER
Attribute name - "REG_Server".

See Also:
Constant Field Values

ATTR_NAME_REG_CERTIFIER_ID_FILE

public static final java.lang.String ATTR_NAME_REG_CERTIFIER_ID_FILE
Attribute name - "REG_CertifierIDFile".

See Also:
Constant Field Values

ATTR_NAME_REG_CERT_PASSWORD

public static final java.lang.String ATTR_NAME_REG_CERT_PASSWORD
Attribute name - "REG_CertPassword".

See Also:
Constant Field Values

ATTR_NAME_REG_FORWARD

public static final java.lang.String ATTR_NAME_REG_FORWARD
Attribute name - "REG_Forward".

See Also:
Constant Field Values

ATTR_NAME_REG_ALT_ORG_UNIT

public static final java.lang.String ATTR_NAME_REG_ALT_ORG_UNIT
Attribute name - "REG_AltOrgUnit".

See Also:
Constant Field Values

ATTR_NAME_REG_ALT_ORG_UNIT_LANG

public static final java.lang.String ATTR_NAME_REG_ALT_ORG_UNIT_LANG
Attribute name - "REG_AltOrgUnitLang".

See Also:
Constant Field Values

ATTR_NAME_REG_CREATE_MAIL_DB

public static final java.lang.String ATTR_NAME_REG_CREATE_MAIL_DB
Attribute name - "REG_CreateMailDb".

See Also:
Constant Field Values

ATTR_NAME_REG_EXPIRATION

public static final java.lang.String ATTR_NAME_REG_EXPIRATION
Attribute name - "REG_Expiration".

See Also:
Constant Field Values

ATTR_NAME_REG_ID_TYPE

public static final java.lang.String ATTR_NAME_REG_ID_TYPE
Attribute name - "REG_IDType".

See Also:
Constant Field Values

ATTR_NAME_REG_IS_NORTH_AMERICAN

public static final java.lang.String ATTR_NAME_REG_IS_NORTH_AMERICAN
Attribute name - "REG_IsNorthAmerican".

See Also:
Constant Field Values

ATTR_NAME_REG_MIN_PASSWORD_LENGTH

public static final java.lang.String ATTR_NAME_REG_MIN_PASSWORD_LENGTH
Attribute name - "REG_MinPasswordLength".

See Also:
Constant Field Values

ATTR_NAME_REG_ORG_UNIT

public static final java.lang.String ATTR_NAME_REG_ORG_UNIT
Attribute name - "REG_OrgUnit".

See Also:
Constant Field Values

ATTR_NAME_REG_REGISTRATION_LOG

public static final java.lang.String ATTR_NAME_REG_REGISTRATION_LOG
Attribute name - "REG_RegistrationLog".

See Also:
Constant Field Values

ATTR_NAME_REG_REGISTRATION_SERVER

public static final java.lang.String ATTR_NAME_REG_REGISTRATION_SERVER
Attribute name - "REG_RegistrationServer".

See Also:
Constant Field Values

ATTR_NAME_REG_STORE_ID_IN_ADDRESS_BOOK

public static final java.lang.String ATTR_NAME_REG_STORE_ID_IN_ADDRESS_BOOK
Attribute name - "REG_StoreIDInAddressBook".

See Also:
Constant Field Values

ATTR_VALUE_ID_TYPE_FLAT_ID

public static final int ATTR_VALUE_ID_TYPE_FLAT_ID
Attribute value for 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
Attribute value for ID type - hierarchical id.

See Also:
Constant Field Values

ATTR_VALUE_ID_TYPE_CERTIFIER

public static final int ATTR_VALUE_ID_TYPE_CERTIFIER
Attribute value for ID type - certifier.

See Also:
Constant Field Values
Constructor Detail

UserRegistration

public UserRegistration(DominoUsersConnector aParent)
                 throws java.lang.Exception
Class contructor

Parameters:
aParent - the DominoUsersConnector that created this Domino Action object
Throws:
java.lang.Exception - if parent session is not valid.
Method Detail

extractAndStoreData

public Entry extractAndStoreData(Entry aEntry)
                          throws java.lang.Exception
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:
java.lang.Exception - if an error that cannot be handled occurs while operating.

mustPerform

public boolean mustPerform(Entry aEntry)
                    throws java.lang.Exception
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:
java.lang.Exception - if an error that cannot be handled occurs while operating.

canPerform

public java.lang.String canPerform()
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 java.lang.Exception
Performs the Domino Action useing the data from the local data holders.

Specified by:
perform in interface IDominoAction
Throws:
java.lang.Exception - if an error that cannot be handled occurs while operating.

resetData

public void resetData()
               throws java.lang.Exception
Resets the local data holders to empty/default values according the business logic of the Domino Action.

Specified by:
resetData in interface IDominoAction
Throws:
java.lang.Exception - if an error that cannot be handled occurs while operating.