com.ibm.commerce.member.syncbeans.commands

Class LDAPIntegrationCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.member.syncbeans.commands.LDAPIntegrationCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, LDAPIntegrationCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class LDAPIntegrationCmdImpl
extends TaskCommandImpl
implements LDAPIntegrationCmd

This task command provides methods that can be overridden to customize the LDAP synchronization code.

The following methods are called by SyncBeanBase:

• postCreateInLDAPProcessing(com.ibm.commerce.member.syncbeans.SyncBeanBase)
• postRefreshFromLDAPProcessing(com.ibm.commerce.member.syncbeans.SyncBeanBase)
• postUpdateInLDAPProcessing(com.ibm.commerce.member.syncbeans.SyncBeanBase)

The following method is called from UserSyncBean.initDOs()

• getUserDOs()

The following method is called from OrganizationSyncBean#initDOs

• getOrganizationDOs()

The following method is called from LogonCmdImpl:

• postLogonProcessing(com.ibm.commerce.user.objects.UserAccessBean)

The following methods are called from the single sign-on code:

• getLDAPDNFromSingleSignOnTokenForWeb(javax.servlet.http.HttpServletRequest)
• getLDAPDNFromSingleSignOnTokenForWebServices(java.lang.String)
• postSingleSignOnProcessing(com.ibm.commerce.member.syncbeans.UserSyncBean)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.member.syncbeans.commands.LDAPIntegrationCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
LDAPIntegrationCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommerceDN(java.lang.String astrLDAPDN, commonj.sdo.DataObject adoMember) Returns the Commerce DN that corresponds to a specified LDAP DN.
java.lang.String	getLDAPDN(java.lang.String astrCommerceDN) Returns the LDAP DN that corresponds to a specified Commerce DN.
java.lang.String	getLDAPDNFromSingleSignOnTokenForWeb(javax.servlet.http.HttpServletRequest request) This method is called in single sign on scenarios from web requests.
java.lang.String	getLDAPDNFromSingleSignOnTokenForWebServices(java.lang.String ssoToken) This method is called in single sign on scenarios from web services requests.
java.util.Vector	getOrganizationDOs() Returns a vector of Data Object classes that correspond to OrganizationSyncBean.
java.util.Vector	getUserDOs() Returns a vector of Data Object classes that correspond to UserSyncBean.
void	postCreateInLDAPProcessing(SyncBeanBase aSyncBean) This method is called when an entry is being created in LDAP based on Commerce data.
void	postLogonProcessing(UserAccessBean aUserAccessBean) This method is called from LogonCmdImpl, when the authentication mode is set to LDAP, and the authentication is successful.
void	postRefreshFromLDAPProcessing(SyncBeanBase aSyncBean) This method is called when an entry in Commerce is being refreshed with LDAP data.
void	postSingleSignOnProcessing(UserSyncBean aUserSyncBean) This method is called after single sign-on has taken place.
void	postUpdateInLDAPProcessing(SyncBeanBase aSyncBean) This method is called when an entry in LDAP is being updated with Commerce data.

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, performExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

LDAPIntegrationCmdImpl

public LDAPIntegrationCmdImpl()

Method Detail

getLDAPDN

public java.lang.String getLDAPDN(java.lang.String astrCommerceDN)
                           throws ECException

Returns the LDAP DN that corresponds to a specified Commerce DN. By default, the same DN is returned.

Specified by:

getLDAPDN in interface LDAPIntegrationCmd

Parameters:

astrCommerceDN - The Commerce DN.

Returns:

The LDAP DN.

Throws:

ECException - Thrown if an error occurs.

postLogonProcessing

public void postLogonProcessing(UserAccessBean aUserAccessBean)
                         throws ECException

This method is called from LogonCmdImpl, when the authentication mode is set to LDAP, and the authentication is successful. It is provided to allow extra synchronization between the Commerce database and LDAP if it's needed.

The default logic is to do nothing.

Specified by:

postLogonProcessing in interface LDAPIntegrationCmd

Parameters:

aUserAccessBean - The user that has authenticated.

Throws:

ECException - Thrown if an error occurs.

postSingleSignOnProcessing

public void postSingleSignOnProcessing(UserSyncBean aUserSyncBean)
                                throws ECException

This method is called after single sign-on has taken place. It is provided to allow extra synchronization between the Commerce database and LDAP if it's needed.

The default logic is to do nothing.

Specified by:

postSingleSignOnProcessing in interface LDAPIntegrationCmd

Parameters:

aUserSyncBean - Contains information about the user that has authenticated.

Throws:

ECException - Thrown if an error occurs.

getUserDOs

public java.util.Vector getUserDOs()

Returns a vector of Data Object classes that correspond to UserSyncBean. These Data Object classes each correspond to a Commerce database table, and are used for reading from and writing to that table. The default logic is to return the following Data Object classes:

• UserDO - maps to USERS table.
• UserRegistryDO - maps to USERREG table.
• UserDemographicsDO - maps to USERDEMO table.
• SelfAddressDO - maps to ADDRESS table.
• BusinessProfileDO - maps to BUSPROF table.
• UserProfileDO - maps to USERPROF table.
• MemberAttributesDO - maps to MBRATTRVAL table.

You have the option of removing Data Object classes for tables that you don't want to be synchronized, and also adding a new Data Object class for your own custom database table that you wish to be synchronized.

Specified by:

getUserDOs in interface LDAPIntegrationCmd

Returns:

a vector of Data Object classes that correspond to UserSyncBean.

getOrganizationDOs

public java.util.Vector getOrganizationDOs()

Returns a vector of Data Object classes that correspond to OrganizationSyncBean. These Data Object classes each correspond to a Commerce database table, and are used for reading from and writing to that table. The default logic is to return the following Data Object classes:

• OrgEntityDO - maps to ORGENTITY table.
• SelfAddressDO - maps to ADDRESS table.
• MemberAttributesDO - maps to MBRATTRVAL table.

You have the option of removing Data Object classes for tables that you don't want to be synchronized, and also adding a new Data Object class for your own custom database table that you wish to be synchronized.

Specified by:

getOrganizationDOs in interface LDAPIntegrationCmd

Returns:

a vector of Data Object classes that correspond to UserSyncBean.

getCommerceDN

public java.lang.String getCommerceDN(java.lang.String astrLDAPDN,
                                      commonj.sdo.DataObject adoMember)
                               throws ECException

Returns the Commerce DN that corresponds to a specified LDAP DN. By default, the same DN is returned.

Specified by:

getCommerceDN in interface LDAPIntegrationCmd

Parameters:

astrLDAPDN - The LDAP DN.

adoMember - The entity data object corresponding to the member.

Returns:

The Commerce DN.

Throws:

ECException - Thrown if an error occurs.

postCreateInLDAPProcessing

public void postCreateInLDAPProcessing(SyncBeanBase aSyncBean)
                                throws ECException

This method is called when an entry is being created in LDAP based on Commerce data. It enables extra processing to take place in this scenario.

The default logic is to do nothing.

Specified by:

postCreateInLDAPProcessing in interface LDAPIntegrationCmd

Parameters:

aSyncBean - Contains information about the object that is being synchronized.

Throws:

ECException - Thrown if an error occurs.

postUpdateInLDAPProcessing

public void postUpdateInLDAPProcessing(SyncBeanBase aSyncBean)
                                throws ECException

This method is called when an entry in LDAP is being updated with Commerce data. It enables extra processing to take place in this scenario.

The default logic is to do nothing.

Specified by:

postUpdateInLDAPProcessing in interface LDAPIntegrationCmd

Parameters:

aSyncBean - Contains information about the object that is being synchronized.

Throws:

ECException - Thrown if an error occurs.

postRefreshFromLDAPProcessing

public void postRefreshFromLDAPProcessing(SyncBeanBase aSyncBean)
                                   throws ECException

This method is called when an entry in Commerce is being refreshed with LDAP data. It enables extra processing to take place in this scenario.

The default logic is to do nothing.

Specified by:

postRefreshFromLDAPProcessing in interface LDAPIntegrationCmd

Parameters:

aSyncBean - Contains information about the object that is being synchronized.

Throws:

ECException - Thrown if an error occurs.

getLDAPDNFromSingleSignOnTokenForWeb

public java.lang.String getLDAPDNFromSingleSignOnTokenForWeb(javax.servlet.http.HttpServletRequest request)
                                                      throws ECException

This method is called in single sign on scenarios from web requests. This default implementation will first call the getSingleSignOnTokenForWeb method to retrieve the LTPA token from the request. Then it calls the getUniqueIDFromSingleSignOnToken method to validate the token and retrieve the unique ID from the token. Finally it calls the getLDAPDNFromUniqueID method to retrieve the LDAP DN that maps to this unique ID.

Specified by:

getLDAPDNFromSingleSignOnTokenForWeb in interface LDAPIntegrationCmd

Parameters:

request - The http request object of the current request.

Returns:

The LDAP user DN that this token maps to.

Throws:

ECException - Thrown if an error occurs.

getLDAPDNFromSingleSignOnTokenForWebServices

public java.lang.String getLDAPDNFromSingleSignOnTokenForWebServices(java.lang.String ssoToken)
                                                              throws ECException

This method is called in single sign on scenarios from web services requests. This default implementation will take a LTPA token as a parameter. Then it calls the getUniqueIDFromSingleSignOnToken method to validate the token and retrieve the unique ID from the token. Finally it calls the getLDAPDNFromUniqueID method to retrieve the LDAP DN that maps to this unique ID.

Specified by:

getLDAPDNFromSingleSignOnTokenForWebServices in interface LDAPIntegrationCmd

Parameters:

ssoToken - The single sign on token

Returns:

The LDAP user DN that this token maps to.

Throws:

ECException - Thrown if an error occurs.