com.ibm.commerce.member.syncbeans.commands

Interface LDAPIntegrationCmd

All Superinterfaces:

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

All Known Implementing Classes:

LDAPIntegrationCmdImpl

public interface LDAPIntegrationCmd
extends TaskCommand

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)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The copyright field.
static java.lang.String	defaultCommandClassName The default command implementation class.
static java.lang.String	NAME The command name.

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

serialVersionUID

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 sync helper data object classes that correspond to OrganizationSyncBean.
java.util.Vector	getUserDOs() Returns a vector of sync helper 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 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

static final java.lang.String COPYRIGHT

The copyright field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The command name.

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default command implementation class.

Method Detail

getCommerceDN

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.

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.

getLDAPDN

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

Returns the LDAP DN that corresponds to a specified Commerce DN.

Parameters:

astrCommerceDN - The Commerce DN.

Returns:

The LDAP DN.

Throws:

ECException - Thrown if an error occurs.

getUserDOs

java.util.Vector getUserDOs()

Returns a vector of sync helper 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. 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.

Returns:

a vector of Data Object classes that correspond to UserSyncBean.

getOrganizationDOs

java.util.Vector getOrganizationDOs()

Returns a vector of sync helper 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. 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.

Returns:

a vector of Data Object classes that correspond to UserSyncBean.

postLogonProcessing

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.

Parameters:

aUserAccessBean - The user that has authenticated.

Throws:

ECException - Thrown if an error occurs.

postSingleSignOnProcessing

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.

Parameters:

aUserSyncBean - Contains information about the user that has authenticated.

Throws:

ECException - Thrown if an error occurs.

postCreateInLDAPProcessing

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.

Parameters:

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

Throws:

ECException - Thrown if an error occurs.

postUpdateInLDAPProcessing

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.

Parameters:

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

Throws:

ECException - Thrown if an error occurs.

postRefreshFromLDAPProcessing

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.

Parameters:

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

Throws:

ECException - Thrown if an error occurs.

getLDAPDNFromSingleSignOnTokenForWeb

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

This method is called in single sign on scenarios from web requests. The implementation of this method should fetch the single sign on token from the request, validate the token and return the LDAP user DN that this token maps to.

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

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

This method is called in single sign on scenarios from web services requests. The implementation of this method should validate the single sign on token and return the LDAP user DN that this token maps to.

Parameters:

ssoToken - The single sign on token

Returns:

The LDAP user DN that this token maps to.

Throws:

ECException - Thrown if an error occurs.