com.iplanet.am.sdk.ldap

Class DCTreeServicesImpl

java.lang.Object

com.iplanet.am.sdk.common.DCTreeServicesHelper

com.iplanet.am.sdk.ldap.DCTreeServicesImpl

All Implemented Interfaces:

AMConstants, IDCTreeServices

public class DCTreeServicesImpl
extends DCTreeServicesHelper
implements AMConstants, IDCTreeServices

This class DCTree contains the functionality to support a DC Tree in the LDAP DIT. The methods of this class will be used by other classes in com.iplanet.dpro.sdk package.

In order to determine if DC Tree support is required or not, the parameter com.iplanet.am.dctree will be verified. A value of true for this parameter, means DC Tree support is required

NOTE: An explicit check must be performed using DCTree.isRequired() method before calling any other methods in this class.

Field Summary

Fields inherited from class com.iplanet.am.sdk.common.DCTreeServicesHelper

adminServiceGlobalSchema, DCTREE_START_DN, DOMAIN_BASE_DN, INET_CANONICAL_DOMAIN, IPLANET_DOMAIN_NAME_ATTR, isInitialized

Fields inherited from interface com.iplanet.am.sdk.AMConstants

ADD_MEMBER, ADMIN_GROUPS_ENABLED_ATTR, ADMIN_ROLE_ATTR, ADMINISTRATION_SERVICE, CACHE_ENABLED_DISABLED_KEY, CACHE_MAX_SIZE_KEY, COMPLIANCE_SPECIAL_FILTER_ATTR, COMPLIANCE_USER_DELETION_ATTR, CONTAINER_DEFAULT_TEMPLATE_ROLE, CONTAINER_SUPPORTED_TYPES_ATTRIBUTE, DCT_ATTRIBUTE_LIST_ATTR, DCT_ENABLED_ATTR, DOMAIN_ADMINISTRATORS, DOMAIN_HELP_DESK_ADMINISTRATORS, EMAIL_ATTRIBUTE, FILTER_ATTR_NAME, INET_ADMIN_OBJECT_CLASS, INET_DOMAIN_STATUS_ATTR, INET_DOMAIN_STATUS_ATTRIBUTE, INVALID_USERID_CHARACTERS, OTHER_COSATTR_TYPE, POLICY_COSATTR_TYPE, POLICY_SUFFIX, PRE_POST_PROCESSING_MODULES_ATTR, REMOVE_ATTRIBUTE, REMOVE_MEMBER, REQUIRED_SERVICES_ATTR, ROLE_MANAGED_CONTAINER_DN_ATTRIBUTE, SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SERVICE_STATUS_ATTRIBUTE, STATIC_GROUP_DN_ATTRIBUTE, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_ATTRIBUTE_LIST_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE, USER_CREATE_NOTIFICATION_LIST, USER_DELETE_NOTIFICATION_LIST, USER_ENCRYPTED_PASSWORD_ATTRIBUTE, USER_ENTRY_PROCESSING_IMPL, USER_MODIFY_NOTIFICATION_LIST, USER_PASSWORD_ATTRIBUTE, USER_SEARCH_RETURN_ATTR, USERID_PASSWORD_VALIDATION_CLASS

Constructor Summary

Constructors

Constructor and Description
DCTreeServicesImpl() Public default constructor

Method Summary

Modifier and Type	Method and Description
void	cleanDomainMap(String canonOrgDN) This is a public method used by the notification event listener thread to clean the domain map, when organization entry is changed.
protected void	createDomain(SSOToken token, Guid orgGuid, AttrSet attrSet) Method which creates a Domain Component Tree for the given organization, if the sunPreferredDomain attribute is present and has a fully qualified domain name as value.
protected void	createDomain(SSOToken token, Guid orgGuid, String domainName, AttrSet attrSet) Method which creates a DC Tree for the given org, if the sunPreferredDomain attribute is present and has a fully qualified domain name as value.
Set	dcNodeAttributes()
protected String	getCanonicalDomain(SSOToken token, String orgDN) This is a public method to get canonical domain name for a given organization.
protected String	getDCNodeDN(SSOToken token, String orgDN)
protected AttrSet	getDomainAttributes(SSOToken token, String orgDN, String[] attrNames)
String	getOrganizationDN(SSOToken token, String domainName) Returns the organization DN matching the domain name
protected void	removeDomain(SSOToken token, String orgDN) Method which removes the DC Tree corresponding to the Org
protected void	setDomainAttributes(SSOToken token, String orgDN, AttrSet attrSet)
protected AttrSet[]	splitAttrSet(String orgDN, AttrSet attrSet)
protected void	updateDomainStatus(SSOToken token, String orgDN, String status) Method which update attribute inetdomainstatus of the DC Tree corresponding to the Org

Methods inherited from class com.iplanet.am.sdk.common.DCTreeServicesHelper

getAdminServiceGlobalSchema, initialize, isInitalized, isRequired

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.iplanet.am.sdk.common.IDCTreeServices

isRequired

Constructor Detail

DCTreeServicesImpl

public DCTreeServicesImpl()

Public default constructor

Method Detail

createDomain

protected void createDomain(SSOToken token,
                            Guid orgGuid,
                            AttrSet attrSet)
                     throws AMException,
                            SSOException

Method which creates a Domain Component Tree for the given organization, if the sunPreferredDomain attribute is present and has a fully qualified domain name as value.

Parameters:

token - SSO Token

orgGuid - identifiication of organization entry to be mapped from dctree to organization DIT organization

attrSet - the attributes to be set on creation of domain.

Throws:

AMException - if unsuccessful in creating a dc tree for the organization or unsuccessful in setting the mapping between dc tree and the organization

SSOException

createDomain

protected void createDomain(SSOToken token,
                            Guid orgGuid,
                            String domainName,
                            AttrSet attrSet)
                     throws AMException

Method which creates a DC Tree for the given org, if the sunPreferredDomain attribute is present and has a fully qualified domain name as value.

Parameters:

token - SSOToken

orgGuid - identifiication of Organization entry to be mapped from dctree to organization DIT organization

domainName - set the domain this organization belongs to.

attrSet - the AttrSet of the organization

Throws:

AMException - if unsuccessful in creating a dc tree for the organization or unsuccessful in setting the mapping between dc tree and the organization

removeDomain

protected void removeDomain(SSOToken token,
                            String orgDN)
                     throws AMException

Method which removes the DC Tree corresponding to the Org

Parameters:

token - SSOToken

orgDN - String representing the DN correponding to the organization

Throws:

AMException - if error occured in accessing the org corresponding to orgDN or during the removal of the dc tree corresponding to the orgDN

updateDomainStatus

protected void updateDomainStatus(SSOToken token,
                                  String orgDN,
                                  String status)
                           throws AMException

Method which update attribute inetdomainstatus of the DC Tree corresponding to the Org

Parameters:

token - SSOToken

orgDN - String representing the DN correponding to the organization

status - inetdomainstatus value

Throws:

AMException - if error occured in accessing the org corresponding to orgDN or during the attribute change of the dc tree corresponding to the orgDN

setDomainAttributes

protected void setDomainAttributes(SSOToken token,
                                   String orgDN,
                                   AttrSet attrSet)
                            throws AMException

Throws:

AMException

getDCNodeDN

protected String getDCNodeDN(SSOToken token,
                             String orgDN)
                      throws AMException

Throws:

AMException

getDomainAttributes

protected AttrSet getDomainAttributes(SSOToken token,
                                      String orgDN,
                                      String[] attrNames)
                               throws AMException,
                                      SSOException

Throws:

AMException

SSOException

getOrganizationDN

public String getOrganizationDN(SSOToken token,
                                String domainName)
                         throws AMException

Returns the organization DN matching the domain name

Specified by:

getOrganizationDN in interface IDCTreeServices

Parameters:

token - SSOToken

domainName - String representing domin name

Returns:

the organization dn

Throws:

AMException

splitAttrSet

protected AttrSet[] splitAttrSet(String orgDN,
                                 AttrSet attrSet)
                          throws AMException,
                                 SSOException

Throws:

AMException

SSOException

getCanonicalDomain

protected String getCanonicalDomain(SSOToken token,
                                    String orgDN)
                             throws AMException

This is a public method to get canonical domain name for a given organization.

Throws:

AMException

cleanDomainMap

public void cleanDomainMap(String canonOrgDN)

This is a public method used by the notification event listener thread to clean the domain map, when organization entry is changed.

Parameters:

canonOrgDN - organization DN

dcNodeAttributes

public Set dcNodeAttributes()
                     throws AMException,
                            SSOException

Throws:

AMException

SSOException