Package com.iplanet.am.sdk.ldap

Class 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.

    • 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

      • 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