com.ibm.di.connector.dominoUsers
Class UserAccess

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

All Implemented Interfaces:

IDominoAction

public class UserAccess
extends java.lang.Object
implements IDominoAction

This class performs a user access to Domino.

Field Summary

static java.lang.String	ATTR_NAME_DENY_GROUP_NAME Attribute name : "ACC_DenyGroupName"
static java.lang.String	ATTR_NAME_SET_TYPE Attribute name : "ACC_SetType"
static int	ATTR_VALUE_SET_TYPE_DISABLE Attribute name : 0
static int	ATTR_VALUE_SET_TYPE_ENABLE Attribute name : 1

Constructor Summary

UserAccess(DominoUsersConnector aParent)
Class constructor.

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.
java.lang.Integer	getAccessType() Retrieves acces type.
java.lang.String	getDenyGroupName() Retrieves deny group name.
java.lang.String	getUserFullName() Retrieves user's full name.
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	setAccessType(java.lang.Integer aAccessType) Sets access type.
void	setDenyGroupName(java.lang.String aDenyGroupName) Sets deny group name.
void	setUserFullName(java.lang.String aUserFullName) Sets user's full name

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME_SET_TYPE

public static final java.lang.String ATTR_NAME_SET_TYPE

Attribute name : "ACC_SetType"

See Also:

Constant Field Values

ATTR_NAME_DENY_GROUP_NAME

public static final java.lang.String ATTR_NAME_DENY_GROUP_NAME

Attribute name : "ACC_DenyGroupName"

See Also:

Constant Field Values

ATTR_VALUE_SET_TYPE_DISABLE

public static final int ATTR_VALUE_SET_TYPE_DISABLE

Attribute name : 0

See Also:

Constant Field Values

ATTR_VALUE_SET_TYPE_ENABLE

public static final int ATTR_VALUE_SET_TYPE_ENABLE

Attribute name : 1

See Also:

Constant Field Values

Constructor Detail

UserAccess

public UserAccess(DominoUsersConnector aParent)
           throws java.lang.Exception

Class constructor.

Parameters:

aParent - The DominoUsersConnector that created this Domino Action object

Throws:

java.lang.Exception - if parent session is not valid

Method Detail

getAccessType

public java.lang.Integer getAccessType()

Retrieves acces type.

Returns:

access type.

setAccessType

public void setAccessType(java.lang.Integer aAccessType)

Sets access type.

Parameters:

aAccessType - '0' disable , '1' enable.

getDenyGroupName

public java.lang.String getDenyGroupName()

Retrieves deny group name.

Returns:

deny group name.

setDenyGroupName

public void setDenyGroupName(java.lang.String aDenyGroupName)

Sets deny group name.

Parameters:

aDenyGroupName - name

getUserFullName

public java.lang.String getUserFullName()

Retrieves user's full name.

Returns:

user`s full name.

setUserFullName

public void setUserFullName(java.lang.String aUserFullName)

Sets user's full name

Parameters:

aUserFullName - full name

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.