SyncBeanBase

java.lang.Object
- com.ibm.commerce.member.syncbeans.SyncBeanBase

Direct Known Subclasses:

MemberSyncBean
```
public abstract class SyncBeanBase
extends java.lang.Object
```
The base class for the synchronization beans, also known as sync beans. Sync beans allow member data to be accessed without having to worry about the underlying persistence layer: WebSphere Commerce database or an LDAP server. The most commonly used sync beans are the UserSyncBean and OrganizationSyncBean. These sync beans are used to access user and organization data respectively. The sync beans make use of sync helper data object classes, that extend from DOBase, and are used to read from and write to the WebSphere Commerce database tables. VMMProxy is used to read from and write to LDAP.
If WebSphere Commerce is configured to use its own database as the master member profile repository, then the sync beans will only interact with WebSphere Commerce member tables. If on the other hand, WebSphere Commerce is configured to use an LDAP server as the master profile repository, the sync beans will persist member data to LDAP as well as the WebSphere Commerce database. During a read operation, the sync bean's properties are first populated based on the data in the database. Then, if the data on the LDAP server has been updated since the last synchronization, any LDAP properties that are configured to be synchronized will overwrite the existing property values. The ldapentry.xml configuration file controls which properties are synchronized between WebSphere Commerce and LDAP, and in which direction:
- LDAP to WebSphere Commerce
- WebSphere Commerce to LDAP
- Bidirectional
- LDAP only

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The IBM Copyright notice field.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM Copyright notice field.

Constructor Summary

Constructors
Modifier Constructor and Description

protected SyncBeanBase()
Default constructor.

Constructors
Modifier	Constructor and Description
`protected`	`SyncBeanBase()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addDO(DOBase aDataObject)` Adds a sync helper data object to the list of data objects that will be used for reading and writing data to the database.
`protected void`	`addProperties(TypedProperty tpProperties)` Adds the specified properties to the list of properties for this object.
`protected void`	`addProperties(TypedProperty tpProperties, boolean bLDAPOnly)` Adds the specified properties to the list of properties for this object.
`protected void`	`create(TypedProperty tpCreate)` Creates the data in the database.
`protected void`	`createInDB(TypedProperty tpCreate)` Creates the entry in the database.
`protected void`	`createInLDAP(TypedProperty tpCreate)` Create the entry in LDAP.
`protected abstract boolean`	`existsInDB()` Check if the entry exists in the database.
`protected abstract boolean`	`existsInLDAP()` Check if the entry exists in LDAP.
`protected static commonj.sdo.DataObject`	`findInLDAPByExternalMemberID(java.lang.String strMemberUniqueID)` Finds a member in LDAP using the Virtual Member Manager (VMM) globally unique ID.
`protected TypedProperty`	`getAttributesFromLDAP(TypedProperty aLDAPAttributes)` Gets the Commerce properties that correspond to the input LDAP attributes.
`protected TypedProperty`	`getAttributesToUpdateLDAP(TypedProperty tpProperties)` Gets the LDAP attributes that need to be updated in LDAP, based in the input Commerce properties.
`static java.lang.String`	`getCommerceDN(java.lang.String astrLDAPDN, commonj.sdo.DataObject adoMember)` Gets the Commerce DN corresponding to the given LDAP DN.
`static java.lang.String`	`getLDAPDN(java.lang.String astrCommerceDN)` Gets the LDAP DN corresponding to the given Commerce DN.
`commonj.sdo.DataObject`	`getLDAPMember()` Gets the entity data object corresponding to the member in LDAP.
`java.lang.String`	`getMemberId()` Gets the member ID that corresponds to this sync bean.
`short`	`getMemberType()` Gets the member type: ECMemberCommandParameterConstants.MEMBER_TYPE_UNKNOWN = -1 `ECMemberCommandParameterConstants.MEMBER_TYPE_PERSON` = 0 `ECMemberCommandParameterConstants.MEMBER_TYPE_GROUP` = 1 `ECMemberCommandParameterConstants.MEMBER_TYPE_ORGANIZATION` = 2 `ECMemberCommandParameterConstants.MEMBER_TYPE_ORGANIZATIONAL_UNIT` = 3
`TypedProperty`	`getProperties()` Gets the properties of the sync bean.
`java.lang.String`	`getProperty(java.lang.String strAttributeName)` Gets the value of the specified attribute.
`java.util.Vector`	`getProperty(java.lang.String strAttributeName, java.lang.String strStoreEntityId)` Gets a vector of member attribute values based on the attribute name and store ID.
`protected java.util.Vector`	`getSyncHelpers()` Gets a vector of sync helper data objects.
`com.ibm.commerce.member.objects.WMMMapAccessBean`	`getWMMMapAccessBean()` Get the `WMMMap` access bean that corresponds to the row in the WMMMAP table for this sync bean.
`protected abstract void`	`initDOs()` Initialization for the list of sync helper data object classes for reading and writing data to the various database tables.
`protected static boolean`	`isLDAPEnabled()` Returns whether or not LDAP is used for storing member profile data.
`protected boolean`	`isLDAPModified()` Checks if the entry in LDAP was modified since the last synchronization.
`protected abstract boolean`	`isSynchronizationNeeded()` Checks if synchronization is needed between the database and LDAP.
`static boolean`	`isWMMEnabled()` Deprecated. in WC 7.0, replaced by `MemberHelper.isLDAPUsedForProfileStorage()`
`void`	`refresh()` Refresh the bean by first getting the values from the database.
`protected void`	`resetProperties()` Resets the properties to an empty set.
`protected void`	`setLDAPMember(commonj.sdo.DataObject member)` Sets the LDAP member with its data object representation.
`protected void`	`setMemberId(java.lang.String strMemberId)` Sets the member ID.
`protected void`	`setMemberType(short shMemberType)` Sets the member type.
`protected void`	`setWMMMapAccessBean(com.ibm.commerce.member.objects.WMMMapAccessBean abWMMMap)` Sets the `WMMMap` access bean.
`void`	`update(TypedProperty tpUpdate)` Updates data in the sync bean, and then persists it to the Commerce database and LDAP.
`protected void`	`updateMapping()` Create the mapping between the database entry and LDAP entry in the WMMMAP table This method is also called to update the last sync field in the table.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SyncBeanBase
```
protected SyncBeanBase()
```
    Default constructor.
- Method Detail
  - initDOs
```
protected abstract void initDOs()
                         throws ECException
```
    Initialization for the list of sync helper data object classes for reading and writing data to the various database tables.
    
    Throws:
    
    ECException - Thrown if an error occurs.
  - isSynchronizationNeeded
```
protected abstract boolean isSynchronizationNeeded()
                                            throws javax.ejb.CreateException,
                                                   java.rmi.RemoteException,
                                                   javax.naming.NamingException,
                                                   javax.ejb.FinderException
```
    Checks if synchronization is needed between the database and LDAP.
    
    Returns:
    
    true if needed, false otherwise.
    
    Throws:
    
    javax.ejb.CreateException
    
    java.rmi.RemoteException
    
    javax.naming.NamingException
    
    javax.ejb.FinderException
  - existsInDB
```
protected abstract boolean existsInDB()
                               throws javax.ejb.CreateException,
                                      java.rmi.RemoteException,
                                      javax.naming.NamingException,
                                      javax.ejb.FinderException
```
    Check if the entry exists in the database.
    
    Returns:
    
    true if it exists in the database, false otherwise.
    
    Throws:
    
    javax.ejb.CreateException
    
    java.rmi.RemoteException
    
    javax.naming.NamingException
    
    javax.ejb.FinderException
  - existsInLDAP
```
protected abstract boolean existsInLDAP()
                                 throws javax.ejb.CreateException,
                                        java.rmi.RemoteException,
                                        javax.naming.NamingException,
                                        javax.ejb.FinderException
```
    Check if the entry exists in LDAP.
    
    Returns:
    
    true if it exists in LDAP, false otherwise.
    
    Throws:
    
    javax.ejb.CreateException
    
    java.rmi.RemoteException
    
    javax.naming.NamingException
    
    javax.ejb.FinderException
  - findInLDAPByExternalMemberID
```
protected static commonj.sdo.DataObject findInLDAPByExternalMemberID(java.lang.String strMemberUniqueID)
                                                              throws java.rmi.RemoteException,
                                                                     javax.ejb.FinderException,
                                                                     javax.naming.NamingException,
                                                                     javax.ejb.CreateException,
                                                                     ECException
```
    Finds a member in LDAP using the Virtual Member Manager (VMM) globally unique ID.
    
    Parameters:
    
    strMemberUniqueID - ID used to identify the member in the external system.
    
    Returns:
    
    a Virtual Member Manager entity data object representing the member.
    
    Throws:
    
    java.rmi.RemoteException
    
    javax.ejb.FinderException
    
    javax.naming.NamingException
    
    javax.ejb.CreateException
    
    ECException
  - isWMMEnabled
```
public static boolean isWMMEnabled()
```
    Deprecated. in WC 7.0, replaced by MemberHelper.isLDAPUsedForProfileStorage()
    
    Returns whether or not LDAP is used for storing member profile data. It is based on the setting of ProfileDataStorage flag in the instance configuration file.
    
    Returns:
    
    true if LDAP is enabled; false otherwise.
  - isLDAPEnabled
```
protected static boolean isLDAPEnabled()
```
    Returns whether or not LDAP is used for storing member profile data. It is based on the setting of ProfileDataStorage flag in the instance configuration file.
    
    Returns:
    
    true if LDAP is enabled; false otherwise.
  - addProperties
```
protected void addProperties(TypedProperty tpProperties,
                 boolean bLDAPOnly)
```
    Adds the specified properties to the list of properties for this object.
    
    Parameters:
    
    tpProperties - The properties to be added.
    
    bLDAPOnly - true if only ldapOnly attributes should be processed; false otherwise.
  - addProperties
```
protected void addProperties(TypedProperty tpProperties)
```
    Adds the specified properties to the list of properties for this object.
    
    Parameters:
    
    tpProperties - The properties to be added.
  - addDO
```
protected void addDO(DOBase aDataObject)
```
    Adds a sync helper data object to the list of data objects that will be used for reading and writing data to the database.
    
    Parameters:
    
    aDataObject - The data object to be added.
  - create
```
protected void create(TypedProperty tpCreate)
               throws javax.ejb.FinderException,
                      ECException,
                      java.rmi.RemoteException,
                      javax.naming.NamingException,
                      javax.ejb.CreateException
```
    Creates the data in the database. It will also create it in LDAP if it is enabled.
    
    Parameters:
    
    tpCreate - The input properties.
    
    Throws:
    
    javax.ejb.FinderException
    
    ECException
    
    java.rmi.RemoteException
    
    javax.naming.NamingException
    
    javax.ejb.CreateException
  - createInDB
```
protected void createInDB(TypedProperty tpCreate)
                   throws ECException,
                          java.rmi.RemoteException,
                          javax.ejb.CreateException,
                          javax.naming.NamingException,
                          javax.ejb.FinderException
```
    Creates the entry in the database.
    
    Parameters:
    
    tpCreate - The properties of the entry to be created.
    
    Throws:
    
    ECException
    
    java.rmi.RemoteException
    
    javax.ejb.CreateException
    
    javax.naming.NamingException
    
    javax.ejb.FinderException
  - createInLDAP
```
protected void createInLDAP(TypedProperty tpCreate)
                     throws java.rmi.RemoteException,
                            javax.ejb.CreateException,
                            javax.ejb.FinderException,
                            javax.naming.NamingException,
                            ECException
```
    Create the entry in LDAP. Assumes that the user does not already exist in LDAP.
    
    Parameters:
    
    tpCreate - the input properties.
    
    Throws:
    
    java.rmi.RemoteException
    
    javax.ejb.CreateException
    
    javax.ejb.FinderException
    
    javax.naming.NamingException
    
    ECException
  - getMemberId
```
public java.lang.String getMemberId()
```
    Gets the member ID that corresponds to this sync bean.
    
    Returns:
    
    the member ID.
  - getLDAPMember
```
public commonj.sdo.DataObject getLDAPMember()
```
    Gets the entity data object corresponding to the member in LDAP.
    
    Returns:
    
    the entity data object corresponding to the member in LDAP.
  - getWMMMapAccessBean
```
public com.ibm.commerce.member.objects.WMMMapAccessBean getWMMMapAccessBean()
```
    Get the WMMMap access bean that corresponds to the row in the WMMMAP table for this sync bean.
    
    Returns:
    
    the WMMMap access bean.
  - getMemberType
```
public short getMemberType()
```
    Gets the member type:
    - ECMemberCommandParameterConstants.MEMBER_TYPE_UNKNOWN = -1
    - ECMemberCommandParameterConstants.MEMBER_TYPE_PERSON = 0
    - ECMemberCommandParameterConstants.MEMBER_TYPE_GROUP = 1
    - ECMemberCommandParameterConstants.MEMBER_TYPE_ORGANIZATION = 2
    - ECMemberCommandParameterConstants.MEMBER_TYPE_ORGANIZATIONAL_UNIT = 3
    Returns:
    
    the member type.
  - getProperties
```
public TypedProperty getProperties()
```
    Gets the properties of the sync bean.
    
    Returns:
    
    the properties.
  - getProperty
```
public java.lang.String getProperty(java.lang.String strAttributeName)
```
    Gets the value of the specified attribute.
    
    Parameters:
    
    strAttributeName - The name of the attribute to be retrieved.
    
    Returns:
    
    the value of the specified attribute name.
  - getProperty
```
public java.util.Vector getProperty(java.lang.String strAttributeName,
                           java.lang.String strStoreEntityId)
```
    Gets a vector of member attribute values based on the attribute name and store ID.
    
    Parameters:
    
    strAttributeName - The attribute name to be retrieved.
    
    strStoreEntityId - The store ID context.
    
    Returns:
    
    a vector of the value of retrieved attribute
  - getSyncHelpers
```
protected java.util.Vector getSyncHelpers()
```
    Gets a vector of sync helper data objects.
    
    Returns:
    
    the vector of sync helpers.
  - updateMapping
```
protected void updateMapping()
                      throws javax.ejb.CreateException,
                             java.rmi.RemoteException,
                             javax.naming.NamingException,
                             javax.ejb.FinderException,
                             ECException
```
    Create the mapping between the database entry and LDAP entry in the WMMMAP table This method is also called to update the last sync field in the table.
    
    Throws:
    
    javax.ejb.CreateException
    
    java.rmi.RemoteException
    
    javax.naming.NamingException
    
    javax.ejb.FinderException
    
    ECException - thrown if there is an error parsing the modify timestamp.
  - isLDAPModified
```
protected boolean isLDAPModified()
                          throws java.rmi.RemoteException,
                                 javax.ejb.CreateException,
                                 javax.ejb.FinderException,
                                 javax.naming.NamingException,
                                 ECException
```
    Checks if the entry in LDAP was modified since the last synchronization.
    
    Returns:
    
    true if LDAP was modified, false otherwise.
    
    Throws:
    
    java.rmi.RemoteException
    
    javax.ejb.CreateException
    
    javax.ejb.FinderException
    
    javax.naming.NamingException
    
    ECException - thrown if the LDAP modify timestamp cannot be parsed.
  - refresh
```
public void refresh()
             throws javax.naming.NamingException,
                    javax.ejb.CreateException,
                    java.rmi.RemoteException,
                    javax.ejb.FinderException,
                    ECException
```
    Refresh the bean by first getting the values from the database. Then overwrite the values with any data from LDAP, if the entity exists in LDAP. If the entity does not exist in LDAP, then create it there, as long as this is not a UserSyncBean. This method is called during find and update scenarios, but not during create.
    
    Throws:
    
    javax.naming.NamingException
    
    javax.ejb.CreateException
    
    java.rmi.RemoteException
    
    javax.ejb.FinderException
    
    ECException
  - resetProperties
```
protected void resetProperties()
```
    Resets the properties to an empty set.
  - setMemberId
```
protected void setMemberId(java.lang.String strMemberId)
```
    Sets the member ID.
    
    Parameters:
    
    strMemberId - The member ID.
  - setLDAPMember
```
protected void setLDAPMember(commonj.sdo.DataObject member)
```
    Sets the LDAP member with its data object representation.
    
    Parameters:
    
    member - The LDAP member.
  - setWMMMapAccessBean
```
protected void setWMMMapAccessBean(com.ibm.commerce.member.objects.WMMMapAccessBean abWMMMap)
```
    Sets the WMMMap access bean.
    
    Parameters:
    
    abWMMMap - WMMMap access bean.
  - setMemberType
```
protected void setMemberType(short shMemberType)
```
    Sets the member type. For organizations, this is based on the ORGENTITY.ORGENTITYTYPE:
    - ECMemberCommandParameterConstants.MEMBER_TYPE_UNKNOWN = -1
    - ECMemberCommandParameterConstants.MEMBER_TYPE_PERSON = 0
    - ECMemberCommandParameterConstants.MEMBER_TYPE_GROUP = 1
    - ECMemberCommandParameterConstants.MEMBER_TYPE_ORGANIZATION = 2
    - ECMemberCommandParameterConstants.MEMBER_TYPE_ORGANIZATIONAL_UNIT = 3
    Parameters:
    
    shMemberType - The member type
  - update
```
public void update(TypedProperty tpUpdate)
            throws javax.naming.NamingException,
                   javax.ejb.CreateException,
                   java.rmi.RemoteException,
                   javax.ejb.FinderException,
                   ECException
```
    Updates data in the sync bean, and then persists it to the Commerce database and LDAP. Called by the member update commands as well as Logon command in the case that a user is migrated from the database to LDAP.
    
    Parameters:
    
    tpUpdate - Update properties.
    
    Throws:
    
    javax.naming.NamingException
    
    javax.ejb.CreateException
    
    java.rmi.RemoteException
    
    javax.ejb.FinderException
    
    ECException
  - getAttributesFromLDAP
```
protected TypedProperty getAttributesFromLDAP(TypedProperty aLDAPAttributes)
```
    Gets the Commerce properties that correspond to the input LDAP attributes. A Commerce attribute is returned as long as the corresponding LDAP attribute exists in the input and ldapentry.xml has specified one of the following flows for the attribute:
    - bothDirections
    - ldapToWcs
    - ldapOnly
    Parameters:
    
    aLDAPAttributes - The attributes that were retrieved from LDAP.
    
    Returns:
    
    the list of Commerce properties based on values in LDAP.
  - getAttributesToUpdateLDAP
```
protected TypedProperty getAttributesToUpdateLDAP(TypedProperty tpProperties)
```
    Gets the LDAP attributes that need to be updated in LDAP, based in the input Commerce properties. An LDAP attribute is returned as long as the corresponding Commerce property exists in the input and ldapentry.xml has specified one of the following flows for the attribute:
    - bothDirections
    - wcsToLdap
    Parameters:
    
    tpProperties - the input properties
    
    Returns:
    
    the list of LDAP attributes
  - getCommerceDN
```
public static java.lang.String getCommerceDN(java.lang.String astrLDAPDN,
                             commonj.sdo.DataObject adoMember)
                                      throws ECException
```
    Gets the Commerce DN corresponding to the given LDAP DN. Delegates to LDAPIntegrationCmd.getCommerceDN(String, DataObject).
    
    Parameters:
    
    astrLDAPDN - The LDAP DN.
    
    adoMember - The entity object representing the member.
    
    Returns:
    
    The Commerce DN corresponding to the given LDAP DN.
    
    Throws:
    
    ECException - Thrown if an error occurs.
  - getLDAPDN
```
public static java.lang.String getLDAPDN(java.lang.String astrCommerceDN)
                                  throws ECException
```
    Gets the LDAP DN corresponding to the given Commerce DN. Delegates to LDAPIntegrationCmd.getLDAPDN(String).
    
    Parameters:
    
    astrCommerceDN - The Commerce DN.
    
    Returns:
    
    The LDAP DN corresponding to the given Commerce DN.
    
    Throws:
    
    ECException - Thrown if an error occurs.

Class SyncBeanBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

Constructor Detail

SyncBeanBase

Method Detail

initDOs

isSynchronizationNeeded

existsInDB

existsInLDAP

findInLDAPByExternalMemberID

isWMMEnabled

isLDAPEnabled

addProperties

addProperties

addDO

create

createInDB

createInLDAP

getMemberId

getLDAPMember

getWMMMapAccessBean

getMemberType

getProperties

getProperty

getProperty

getSyncHelpers

updateMapping

isLDAPModified

refresh

resetProperties

setMemberId

setLDAPMember

setWMMMapAccessBean

setMemberType

update

getAttributesFromLDAP

getAttributesToUpdateLDAP

getCommerceDN

getLDAPDN