com.ibm.di.connector.dominoUsers
Class UserDeletion

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

public class UserDeletion
extends Object
implements IDominoAction

This class performs a user deletion from Domino.


Field Summary
static String ATTR_NAME_DELETE_GROUP_NAME
          Attribute name : "DEL_DeleteGroupName"
static String ATTR_NAME_DELETE_MAIL_FILE
          Attribute name : "DEL_DeleteMailFile"
static int DELETE_MAIL_FILE_DATABASE
          Attribute value : 1
static int DELETE_MAIL_FILE_DONT
          Attribute value : 0
static int DELETE_MAIL_FILE_REPLICAS
          Attribute value : 2
 
Constructor Summary
UserDeletion(DominoUsersConnector aParent)
          Class constructor
 
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.
 String getAddToGroup()
          Retrieves the name of the group the user is added to.
 String getAddToGroupActionValue()
          Retrieves the name of the group the user is added to , if value is not found the name of the default group is returned.
 String getDefaultAddToGroup()
          Retrieves the
 int getDefaultDeleteMailFile()
           
 Integer getDeleteMailFile()
           
 String getDeleteMailFileActionValue()
          Retrives the value of the delete mail action.
 String getUserFullName()
          Retrives user's full name.
 String getUserMailFile()
          Retrieves mail file.
 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.
 void setAddToGroup(String aAddToGroup)
          Sets add to group value
 void setDefaultAddToGroup(String aDefaultAddToGroup)
          Sets default add to group value
 void setDefaultDeleteMailFile(int aDefaultDeleteMailFile)
          Sets default delete mail file value
 void setDeleteMailFile(Integer aDeleteMailFile)
          Sets delete mail value
 void setUserFullName(String aUserFullName)
          Sets user's full name.
 void setUserMailFile(String aUserMailFile)
          Sets mail file
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTR_NAME_DELETE_MAIL_FILE

public static final String ATTR_NAME_DELETE_MAIL_FILE
Attribute name : "DEL_DeleteMailFile"

See Also:
Constant Field Values

ATTR_NAME_DELETE_GROUP_NAME

public static final String ATTR_NAME_DELETE_GROUP_NAME
Attribute name : "DEL_DeleteGroupName"

See Also:
Constant Field Values

DELETE_MAIL_FILE_DONT

public static final int DELETE_MAIL_FILE_DONT
Attribute value : 0

See Also:
Constant Field Values

DELETE_MAIL_FILE_DATABASE

public static final int DELETE_MAIL_FILE_DATABASE
Attribute value : 1

See Also:
Constant Field Values

DELETE_MAIL_FILE_REPLICAS

public static final int DELETE_MAIL_FILE_REPLICAS
Attribute value : 2

See Also:
Constant Field Values
Constructor Detail

UserDeletion

public UserDeletion(DominoUsersConnector aParent)
             throws Exception
Class constructor

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

getDefaultDeleteMailFile

public int getDefaultDeleteMailFile()
Returns:
default delete mail value.

setDefaultDeleteMailFile

public void setDefaultDeleteMailFile(int aDefaultDeleteMailFile)
                              throws Exception
Sets default delete mail file value

Parameters:
aDefaultDeleteMailFile - value to set
Throws:
Exception - if parameter is not supported.

getDefaultAddToGroup

public String getDefaultAddToGroup()
Retrieves the

Returns:
default add to group value.

setDefaultAddToGroup

public void setDefaultAddToGroup(String aDefaultAddToGroup)
                          throws Exception
Sets default add to group value

Parameters:
aDefaultAddToGroup - value to set
Throws:
Exception - if group value does not exist

getDeleteMailFile

public Integer getDeleteMailFile()
Returns:
delete mail file.

setDeleteMailFile

public void setDeleteMailFile(Integer aDeleteMailFile)
Sets delete mail value

Parameters:
aDeleteMailFile - value to set

getAddToGroup

public String getAddToGroup()
Retrieves the name of the group the user is added to.

Returns:
add to group value.

setAddToGroup

public void setAddToGroup(String aAddToGroup)
Sets add to group value

Parameters:
aAddToGroup - value to set

getUserFullName

public String getUserFullName()
Retrives user's full name.

Returns:
user's full name

setUserFullName

public void setUserFullName(String aUserFullName)
Sets user's full name.

Parameters:
aUserFullName - name to set.

getUserMailFile

public String getUserMailFile()
Retrieves mail file.

Returns:
mail file.

setUserMailFile

public void setUserMailFile(String aUserMailFile)
Sets mail file

Parameters:
aUserMailFile - value to set

extractAndStoreData

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

mustPerform

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

canPerform

public 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 Exception
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
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.

getDeleteMailFileActionValue

public String getDeleteMailFileActionValue()
Retrives the value of the delete mail action.

Returns:
value of the delete mail file action.

getAddToGroupActionValue

public String getAddToGroupActionValue()
Retrieves the name of the group the user is added to , if value is not found the name of the default group is returned.

Returns:
add to group action value