oracle.mail.ldap
Class ESDSDirServerAccess

java.lang.Object
  |
  +--oracle.mail.ldap.ESDSDirServerAccess

public final class ESDSDirServerAccess

extends java.lang.Object

This class provides the DS API's for Email Server 6.0.

Constructor Summary

ESDSDirServerAccess()
Constructor, Default debugmode is off

ESDSDirServerAccess(boolean debug)
Constructor for Debug Mode

ESDSDirServerAccess(OESContext cx)
Constructor for Debug Mode, Default debugmode is off

ESDSDirServerAccess(OESContext cx, boolean debug)
Constructor for Debug Mode

Method Summary

void	CreateContactInfo(OESContext oesctx, ESDSLdapObject contactinfo) Deprecated.
java.util.Hashtable	CreateDistributionList(OESContext oesctx, ESDSLdapObject list, java.util.Hashtable members) Deprecated.
void	CreateMailUser(OESContext oesctx, java.lang.String publicUserDN, ESDSLdapObject mailuser) Deprecated.
void	CreatePrivateList(OESContext oesctx, ESDSLdapObject privatelist) Deprecated.
void	DeleteContactInfo(OESContext oesctx, java.lang.String contactName) Deprecated.
void	DeleteDistributionList(OESContext oesctx, java.lang.String emailId) Deprecated.
void	DeleteMailUser(OESContext oesctx, java.lang.String emailId) Deprecated.
void	DeletePrivateList(OESContext oesctx, java.lang.String listName) Deprecated.
java.util.Vector	ESDSAddEntry(ESDSContext ctx, ESDSAddData[] data) This method adds an entry to the directory.
java.util.Vector	ESDSAddEntry(ESDSContext ctx, ESDSAddData[] data, boolean toContinue) This method adds an entry to the directory.
ESDSContext	ESDSClientLogon(ESDSContext serverContext, java.lang.String method, ESDSAuthObject logonParams) This method is going to be called when a server logons on on behalf of a client, say for example, imap for mailuser.
ESDSContext	ESDSClientLogon(java.lang.String ldapHost, java.lang.String ldapPort, java.lang.String method, ESDSAuthObject logonParams) This method is going to be called to logon a client (mailuser etc.) It will check if the client ctx has a key to pool, if not then will call connectAs repository API to logon as a APP type.
void	ESDSConfigureProcessInstanceDBPool(ESDSContext ctx, java.lang.String instanceName, java.lang.String mailStoreDn, java.util.Hashtable poolParams) Deprecated.
void	ESDSCreateContactInfo(ESDSContext ctx, ESDSLdapObject contactinfo) Deprecated.
java.util.Hashtable	ESDSCreateDistributionList(ESDSContext ctx, ESDSLdapObject list, boolean ifPrivate, java.util.Hashtable members) Deprecated.
java.util.Hashtable	ESDSCreateDistributionList(ESDSContext ctx, ESDSLdapObject list, java.lang.String domain, java.util.Hashtable members) This method creates a public distribution list object in the directory.
void	ESDSCreateDomain(ESDSContext ctx, java.lang.String installationName, java.lang.String domainName, java.lang.String parentDomain) This method creates a domain object in the directory.
void	ESDSCreateMailUser(ESDSContext context, java.sql.Connection conn, java.lang.String publicUser, ESDSLdapObject mailuser, int provisioningType) Deprecated.
void	ESDSCreateMailUser(ESDSContext context, java.sql.Connection conn, java.lang.String publicUser, java.lang.String domain, ESDSLdapObject mailuser, int provisioningType) This method creates a mailuser in the directory and db.
void	ESDSCreateMailUser(ESDSContext context, java.lang.String publicUser, ESDSLdapObject mailuser, int provisioningType) Deprecated.
void	ESDSCreateMailUser(ESDSContext context, java.lang.String publicUser, java.lang.String domain, ESDSLdapObject mailuser, int provisioningType) This method creates a mailuser in the directory and db.
void	ESDSCreatePrivateList(ESDSContext ctx, ESDSLdapObject list) Deprecated.
java.lang.String	ESDSCreateProcess(ESDSContext ctx, java.lang.String targetName, ESDSLdapObject process) Deprecated.
void	ESDSCreatePublicAlias(ESDSContext ctx, ESDSLdapObject alias, java.lang.String domain)
void	ESDSCreateRule(ESDSContext ctx, java.lang.String ruleType, java.lang.String instalOrDomainOrEmail, java.util.Vector ruleData) This method creates a Rule object in the directory.
void	ESDSCreateSharedFolder(ESDSContext context, java.lang.String folderName, ESDSLdapObject folder) This method creates a shared folder in the directory.
void	ESDSCreateSharedFolder(ESDSContext context, java.lang.String folderName, ESDSLdapObject folder, boolean ifPublic) This method creates a shared folder in the directory.
void	ESDSDeleteContactInfo(ESDSContext ctx, java.lang.String contactName) Deprecated.
void	ESDSDeleteDistributionList(ESDSContext ctx, java.lang.String listName, boolean ifPrivate) This method deletes a dl.
void	ESDSDeleteDomain(ESDSContext ctx, java.lang.String installationName, java.lang.String domainName) This method deletes the partially created email domain.
void	ESDSDeleteEntry(ESDSContext ctx, java.lang.String dn) This method deletes an entry from the directory.
void	ESDSDeleteMailStore(ESDSContext ctx, java.lang.String installationName, java.lang.String domainName, java.lang.String mailStore) This method deletes a mailstore object in the directory.
void	ESDSDeleteMailUser(ESDSContext ctx, java.sql.Connection conn, java.lang.String mailUser, int provisioningType) This method deletes a mailuser.
void	ESDSDeleteMailUser(ESDSContext ctx, java.lang.String mailUser, int provisioningType) This method deletes a mailuser.
void	ESDSDeletePrivateList(ESDSContext ctx, java.lang.String list) Deprecated.
void	ESDSDeleteProcess(ESDSContext ctx, java.lang.String processDN) Deprecated.
void	ESDSDeletePublicAlias(ESDSContext ctx, java.lang.String aliasName, java.lang.String domain) This method deletes an alias object in the directory.
void	ESDSDeleteRule(ESDSContext ctx, java.lang.String ruleType, java.lang.String instalOrDomainOrEmail) This method deletes an existing rule object in the directory.
void	ESDSDeleteSharedFolder(ESDSContext ctx, java.lang.String folderName) This method deletes a shared folder from the directory.
void	ESDSDeProvisionOIDGrp(ESDSContext ctx, java.lang.String domain, java.lang.String grpMailid)
ESDSLdapObject	ESDSGetAliasMetaData(ESDSContext ctx, java.lang.String domain) This method returns the metadata for a DL Must call ESDSLogon before this.
ESDSAttributeValueList[]	ESDSGetAllInstances(ESDSContext context, java.lang.String targetName) Deprecated.
java.lang.String[]	ESDSGetAllMailStores(ESDSContext ctx, java.lang.String installationName) This method returns all the mailstore dns for the given installation.
java.lang.String[]	ESDSGetAllMailStores(ESDSLdapHandle handle, java.lang.String installationName)
java.util.Hashtable	ESDSGetAllSubscribers(ESDSContext ctx)
java.util.Vector	ESDSGetAllTargets(ESDSContext context, java.lang.String installationName) Deprecated.
ESDSAttributeValueList[]	ESDSGetAttributes(ESDSContext ctx, java.lang.String searchBase, java.lang.String filter, java.util.Vector attributeNames) This method searches the directory for the given filter with the given searchbase and returns the value/values of attributes.
ESDSAttributeValueList[]	ESDSGetAttributes(ESDSContext ctx, java.lang.String searchBase, java.lang.String filter, java.util.Vector attributeNames, javax.naming.directory.SearchControls ctl) This method searches the directory for the given filter with the given searchbase and returns the value/values of attributes.
ESDSAttributeValueList[]	ESDSGetAttributes(ESDSContext ctx, java.lang.String filter, java.util.Vector attributeNames) This method searches the directory for the given filter and returns the value/values of attributes.
ESDSAttributeValueList[]	ESDSGetAttributes(java.lang.String searchBase, java.lang.String filter, java.util.Vector attributeNames, javax.naming.directory.SearchControls ctl, ESDSLdapHandle conn) This method searches the directory for the given filter with the given searchbase and returns the value/values of attributes.
ESDSLdapObject	ESDSGetContactInfoMetaData(ESDSContext ctx) Deprecated.
java.lang.String[]	ESDSGetContacts(ESDSContext ctx) Deprecated.
java.lang.String[]	ESDSGetContacts(ESDSContext ctx, java.lang.String searchCriteria) Deprecated.
int	ESDSGetDBUserID(ESDSContext ctx, java.lang.String mailid) This method returns the database userid of an email user.
ESDSLdapObject	ESDSGetDLMetaData(ESDSContext context, java.lang.String domain) This method returns the metadata for a DL Must call ESDSLogon before this.
ESDSLdapObject	ESDSGetDomainPreferences(ESDSContext ctx, java.lang.String installationName, java.lang.String domainName, java.lang.String preferenceType) This method returns the domain preferences depending on the type of pref.
java.util.Vector	ESDSGetDomains(ESDSContext ctx, java.lang.String installionName) This method returns the list of domains for a given installation.
ESDSLdapObject[]	ESDSGetEntriesManagedByUser(ESDSContext ctx, java.lang.String usermailid, java.lang.String[] types, java.util.Vector attrsToFetch) This API returns the list of entries the given mailuser owns for the given types.
ESDSAttributeValueList	ESDSGetEntry(ESDSContext context, java.lang.String dn, java.util.Vector attributeNames) This method looks up an entry in the directory.
java.util.Vector	ESDSGetInstallations(ESDSContext ctx) This method returns the list of installations.
java.lang.String[]	ESDSGetMailstoreConnectString(ESDSContext ctx, java.lang.String mailstoreDN) This method returns the mailstore connect info for a given mailstoredn.
java.lang.String[]	ESDSGetMailstoreConnectString(ESDSContext ctx, java.lang.String installation, java.lang.String globaldbname) This method returns the mailstore connect info for a given mailstore.
java.lang.String[]	ESDSGetMailstoreDBNames(ESDSContext ctx, java.lang.String installation) This method creates returns the list of global database names for a given installation.
java.lang.String[]	ESDSGetMailstoreGuestConnectInfo(ESDSContext ctx, java.lang.String mailstoreDN) This method returns the mailstore connect info for a given mailstoredn.
java.lang.String[]	ESDSGetMailstoreInfo(ESDSContext ctx, java.lang.String installation, java.lang.String globaldbname) This method returns the mailstore info for a given installation and global database name.
ESDSLdapObject	ESDSGetMailStoreMetaData(ESDSContext ctx, java.lang.String mailstoredn) This method returns the metadata for the given Mailstore DN.
ESDSAttributeValueList	ESDSGetMailUserDBParams(ESDSContext context) This method returns the mailstore attributes for a mailuser.
ESDSLdapObject	ESDSGetMailUserMetaData(ESDSContext context, java.lang.String domain) This method returns the metadata for a mailuser.
ESDSLdapObject	ESDSGetPrivateListMetaData(ESDSContext ctx) Deprecated.
java.lang.String[]	ESDSGetPrivateLists(ESDSContext ctx) Deprecated.
java.lang.String[]	ESDSGetPrivateLists(ESDSContext ctx, java.lang.String searchCriteria) Deprecated.
ESDSAttributeValueList[]	ESDSGetProcessDBParams(ESDSContext context, java.util.Vector mailstoredns) This method returns the mailstore attributes for a process.
java.util.Hashtable	ESDSGetProcessInstanceDBPoolParams(ESDSContext ctx, java.lang.String instanceName, java.lang.String mailStoreDn) Deprecated.
ESDSLdapObject	ESDSGetProcessMetaData(ESDSContext context, java.lang.String targetName) Deprecated.
java.util.Hashtable	ESDSGetPublicFolderAciForUser(ESDSContext context, java.lang.String memberName) Given a mail user, returns all the public folder aci's for the user.
java.util.Hashtable	ESDSGetPublicGroups(ESDSContext ctx, java.lang.String SearchCriteria, java.lang.String SubscriberDN)
java.util.Hashtable	ESDSGetPublicGroupsNotProvisioned(ESDSContext ctx, java.lang.String SubscriberDN)
java.util.Hashtable	ESDSGetPublicGroupsNotProvisioned(ESDSContext ctx, java.lang.String SubscriberDN, java.lang.String cnFilter)
java.util.Hashtable	ESDSGetRule(ESDSContext ctx, java.lang.String ruleType, java.lang.String instalOrDomainOrEmail) This method modifies an existing rule object in the directory.
java.util.Hashtable	ESDSGetSharedFolderAci(ESDSContext context, java.lang.String folderName) Given a folder, returns all it's members and their ACI's
java.util.Hashtable	ESDSGetSharedFolderAci(ESDSContext context, java.lang.String folderName, boolean fetchPublicAci) Given a folder, returns all it's members and their ACI's Folder ACIs due to DL membership will not be calculated when the system property oracle.mail.ldap.folder.dlmembership is set to false.
java.util.Hashtable	ESDSGetSharedFolderAciForUser(ESDSContext context, java.lang.String memberName) Given a member, returns all the aci's for that member to all folders he/she has subscribed to Folder ACIs due to DL membership will not be calculated when the system property oracle.mail.ldap.folder.dlmembership is set to false.
java.util.Hashtable	ESDSGetSharedFolderAciForUser(ESDSContext context, java.lang.String memberName, boolean fetchPublicAci) Given a member, returns all the aci's for that member to all folders he/she has subscribed to Folder ACIs due to DL membership will not be calculated when the system property oracle.mail.ldap.folder.dlmembership is set to false.
java.util.Hashtable	ESDSGetSharedFolderAciForUser(ESDSContext context, java.lang.String folderName, java.lang.String memberName) Given a member, returns all the aci's for that member for the given folder
java.util.Hashtable	ESDSGetSharedFolderAciForUser(ESDSContext context, java.lang.String folderName, java.lang.String memberName, boolean fetchPublicAci) Given a member, returns all the aci's for that member for the given folder Folder ACIs due to DL membership will not be calculated when the system property oracle.mail.ldap.folder.dlmembership is set to false.
ESDSAttributeValueList	ESDSGetSharedFolderCreatorsInfo(ESDSContext ctx, java.lang.String folderName) Given a folder, returns the creators info
ESDSAttributeValueList	ESDSGetSharedFolderCreatorsInfo(ESDSContext ctx, java.lang.String folderName, boolean ifDisplayName) Given a folder, returns the creators info
ESDSLdapObject	ESDSGetSharedFolderMetaData(ESDSContext context) This method returns the metadata for a shared folder.
java.lang.String[]	ESDSGetSubscribedDLs(ESDSContext ctx, java.lang.String userMailID) This method returns the list of DL's a user is subscribed to.
void	ESDSInitialization(ESDSContext ctx, int minSize, int initialSize, int maxSize, int incrementSize, int shrinkingTimeOutInterval, int timeOutInterval) This method will initialize the ldap pool.
boolean	ESDSIsAPartiallyCreatedEntry(ESDSContext ctx, java.lang.String installationName, java.lang.String entryType, java.lang.String entryName) This method checks to see if the entry is a valid one or not.
boolean	ESDSIsInheritedAciExists(ESDSContext context, ESDSLdapHandle handle, java.lang.String folder)
boolean	ESDSIsInheritedAciExists(ESDSContext context, ESDSLdapHandle handle, java.lang.String folder, java.lang.String member, java.util.Vector vectfolderAci, java.util.Vector vectRecursiveAci, java.util.Vector vectUserfolderAci, int flag)
boolean	ESDSIsInheritedAciExists(ESDSContext context, java.lang.String folderName, java.lang.String memberName)
int	ESDSLogoff(ESDSContext ctx) This method is called to log off.
ESDSContext	ESDSLogon(java.lang.String callerType, java.lang.String callerDN, java.lang.String oraHome) Authenticates a server or an applications to the directory and return the ESDSContext of the server or app.
ESDSContext	ESDSLogon(java.lang.String ldapHost, java.lang.String ldapPort, java.lang.String method, ESDSAuthObject logonParams) Authenticates a server or an applications to the directory and return the ESDSContext.
ESDSLdapObject	ESDSLookupContact(ESDSContext ctx, java.lang.String contactName) Deprecated.
ESDSLdapObject	ESDSLookupDistributionList(ESDSContext ctx, java.lang.String mailId) This method looks up a DL.
ESDSLdapObject	ESDSLookupDomain(ESDSContext ctx, java.lang.String domain) This method will lookup a given domain name and return an ESDSLdapObject.
ESDSLdapObject	ESDSLookupMailProcessConfig(ESDSContext ctx, java.lang.String host, java.lang.String oraHome, java.lang.String prodType, java.util.Vector attrsToFetch) Deprecated.
ESDSAttributeValueList	ESDSLookupMailStore(ESDSContext ctx, java.lang.String mailstoredn) This method returns the mailstore attributes for the given mailstoredn.
ESDSLdapObject	ESDSLookupMailUser(ESDSContext ctx, java.lang.String mailId) This method looks up a mailuser.
ESDSLdapObject	ESDSLookupMailUser(ESDSContext ctx, java.lang.String mailId, java.util.Vector attrsToFetch) This method looks up a mailuser.
ESDSLdapObject	ESDSLookupPrivateList(ESDSContext ctx, java.lang.String listName) Deprecated.
ESDSLdapObject	ESDSLookupProcessInstance(ESDSContext ctx, java.lang.String instanceDN) Deprecated.
ESDSLdapObject	ESDSLookupPublicAlias(ESDSContext ctx, java.lang.String aliasName, java.lang.String domain) This method looks up an alias object in the directory for the given domain.
ESDSAttributeValueList	ESDSLookupSharedFolder(ESDSContext context, java.lang.String folderName) This method returns all folder attribute values if the folder exists in LDAP, returns null if folder doesn't exist in LDAP.
void	ESDSManageDomainAdmins(ESDSContext ctx, java.lang.String mailid, java.lang.String domain, int operationType) Adds/Removes a mailuser to/from the domain admin list
void	ESDSModifyContactInfo(ESDSContext ctx, ESDSLdapObject contactinfo) Deprecated.
void	ESDSModifyDistributionList(ESDSContext ctx, java.lang.String mailOrName, ESDSLdapObject list, boolean ifPrivate) This method modifies a distribution list object in the directory.
java.util.Vector	ESDSModifyDLMembers(ESDSContext ctx, java.lang.String list, boolean ifPrivate, java.lang.String modificationType, java.lang.String memberType, java.util.Vector members) This method modifies the members of a dl.
void	ESDSModifyDomainPreferences(ESDSContext ctx, java.lang.String installationName, java.lang.String domainName, java.lang.String preferenceType, ESDSLdapObject preferences) This method modifies the domain preferences for a domain in the directory.
void	ESDSModifyEntry(ESDSContext ctx, java.lang.String dn, ESDSModifyData data) This method modifies an entry in the directory.
void	ESDSModifyMailProcessConfig(ESDSContext ctx, java.lang.String host, java.lang.String oraHome, java.lang.String prodType, ESDSLdapObject conf) Deprecated.
void	ESDSModifyMailStore(ESDSContext ctx, java.lang.String mailStoreDN, ESDSLdapObject mailStore) This method modifies a mailstore object in the directory.
void	ESDSModifyMailUser(ESDSContext ctx, java.lang.String mailId, ESDSLdapObject mailUser) This method modifies a mailuser in the directory.
void	ESDSModifyPrivateList(ESDSContext ctx, ESDSLdapObject list) Deprecated.
void	ESDSModifyProcess(ESDSContext ctx, java.lang.String targetName, ESDSLdapObject process) Deprecated.
void	ESDSModifyProcessInstance(ESDSContext ctx, java.lang.String instanceDN, ESDSLdapObject process) Deprecated.
void	ESDSModifyPublicAlias(ESDSContext ctx, java.lang.String aliasName, java.lang.String domain, ESDSLdapObject alias) This method modifies an alias object in the directory.
void	ESDSModifyRule(ESDSContext ctx, java.lang.String ruleType, java.lang.String instalOrDomainOrEmail, java.util.Vector ruleData) This method modifies an existing rule object in the directory.
void	ESDSModifySharedFolder(ESDSContext ctx, java.lang.String folderName, ESDSLdapObject folder) This method modifies a shared folder in the directory.
void	ESDSProvisionOIDGrpForMail(ESDSContext ctx, java.lang.String domain, java.lang.String oidGrpDN, ESDSLdapObject Attrs, boolean ifExists)
java.util.Hashtable	ESDSPublicGroupsAlreadyProvisioned(ESDSContext ctx, java.lang.String SubscriberDN)
java.util.Hashtable	ESDSPublicGroupsAlreadyProvisioned(ESDSContext ctx, java.lang.String SubscriberDN, java.lang.String mailcnFilter)
ESDSLdapObject[]	ESDSQueryContacts(ESDSContext ctx, java.lang.String searchCriteria, java.util.Vector attrsToFetch) Deprecated.
ESDSLdapObject[]	ESDSQueryPrivateLists(ESDSContext ctx, java.lang.String searchCriteria, java.util.Vector attrsToFetch) Deprecated.
java.util.Vector	ESDSQueryUsers(ESDSContext ctx, java.lang.String userQuery, java.lang.String domainName, int sizeLimit, boolean sortResults) This method queries the mailusers based on the search criteria.
java.util.Vector	ESDSQueryUsers(ESDSContext ctx, java.lang.String userQuery, java.lang.String domainName, int sizeLimit, java.lang.String sortingAttr, java.util.Vector attrsToFetch) This method queries the mailusers based on the search criteria.
void	ESDSRenameSharedFolder(ESDSContext context, java.lang.String oldFolderName, java.lang.String newFolderName) This method renames a shared folder in the directory.
void	ESDSRenameUserEmail(ESDSContext ctx, java.lang.String oldmailId, java.lang.String newmailId) This method renames a mailuser.
void	ESDSRepairCreatedDomain(ESDSContext ctx, java.lang.String installationName, java.lang.String domainName, java.lang.String parentDomain) This method completes the creation of a partially created email domain and the containers in the directory.
java.lang.String	ESDSResolveEmailID(ESDSContext ctx, java.lang.String mailId) This method resolves a mailID.
java.util.Hashtable	ESDSResolveEntry(ESDSContext ctx, java.lang.String entryName, java.lang.String entryType, java.lang.String resolutionType, boolean ifPrivate, boolean sortResultSet, int sizeLimit) Deprecated.
ESDSMemberList	ESDSResolveName(ESDSContext ctx, java.lang.String entryName, java.lang.String resolutionType, java.lang.String domainName, int sortResultSet, int sizeLimit) Deprecated.
ESDSMemberList	ESDSResolvePrivateList(ESDSContext ctx, java.lang.String listName, java.lang.String resolutionType) Deprecated.
java.util.Vector	ESDSSearchDLs(ESDSContext ctx, java.lang.String dlQueryString, java.lang.String domainName, int sizeLimit) This method queries for lists based on the given search criteria.
java.util.Vector	ESDSSearchDLs(ESDSContext ctx, java.lang.String dlQueryString, java.lang.String domainName, int sizeLimit, java.lang.String sortingAttr, java.util.Vector attrsToFetch) This method queries for lists based on the given search criteria.
java.util.Hashtable	ESDSSearchMembersInDL(ESDSContext ctx, java.lang.String dlEmailID, java.lang.String memberQueryString, java.lang.String memberType, int sizeLimit) This method looks up the given list, resolves it and returns only the members matching the query criteria.
java.util.Hashtable	ESDSSearchMembersInDL(ESDSContext ctx, java.lang.String dlEmailID, java.lang.String memberQueryString, java.lang.String memberType, int sizeLimit, java.util.Vector attrsToFetch) This method looks up the given list, resolves it and returns only the members matching the query criteria.
java.lang.String[]	ESDSSearchPublicAliases(ESDSContext ctx, java.lang.String searchCriteria, java.lang.String domain) This method searches for public aliases for the given domain depending on the search criteria.
java.util.Vector	ESDSSearchPublicAliases(ESDSContext ctx, java.lang.String query, java.lang.String domainName, int sizeLimit) This method searches for public aliases for the given domain depending on the search criteria.
java.util.Vector	ESDSSearchPublicAliases(ESDSContext ctx, java.lang.String query, java.lang.String domainName, int sizeLimit, java.lang.String sortingAttr, java.util.Vector attrsToFetch) This method searches for public aliases for the given domain depending on the search criteria.
void	ESDSSetSharedFolderAci(ESDSContext context, java.lang.String folderName, ESDSLdapObject folder) Given a user/dl/group and Shared folder ; set the aci of the user/dl/group
void	ESDSSetSharedFolderAci(ESDSContext context, java.lang.String folderName, ESDSLdapObject folder, int flags) Given a user/dl/group and Shared folder ; set the aci of the user/dl/group
void	ESDSSetUserObjectID(ESDSContext userCtx, long userid) This method updates the orclobjectid of the user in case of on demand database record creation of user
void	ESDSUpdatePubUserRefs(ESDSContext ctx, java.lang.String oldDN, java.lang.String newDN) This method updates all public user references when a public user is renamed This API needs to be called by the admin whenever the public user is renamed This API queries and updates all the public user references to the new DN.
java.lang.String[]	GetAllContacts(OESContext oesctx) Deprecated.
java.lang.String[]	GetAllPrivateLists(OESContext oesctx) Deprecated.
ESDSLdapObject	GetContactInfoMetaData(OESContext oesctx) Deprecated.
ESDSLdapObject	GetDistributionListMetaData(OESContext oesctx, java.lang.String domain) Deprecated.
ESDSAttributeValueList	GetEntry(java.lang.String dn, java.util.Vector attributeNames, ESDSLdapHandle conn)
ESDSLdapObject	GetMailUserMetaData(OESContext oesctx, java.lang.String domain) Deprecated.
java.util.Vector	getParentDomains(ESDSLdapHandle handle, java.lang.String domain, java.lang.String installdn)
ESDSLdapObject	GetPrivateListMetaData(OESContext oesctx) Deprecated.
ESDSAttributeValueList	inheritDefaultValues(ESDSLdapHandle handle, java.util.Vector parentDNs, java.lang.String entryType)
ESDSLdapObject	LookupContactInfo(OESContext oesctx, java.lang.String contactName) Deprecated.
ESDSLdapObject	LookupDistributionList(OESContext oesctx, java.lang.String emailId) Deprecated.
ESDSLdapObject	LookupMailUser(OESContext oesctx, java.lang.String emailId) Deprecated.
ESDSLdapObject	LookupPrivateList(OESContext oesctx, java.lang.String listName) Deprecated.
void	ModifyContactInfo(OESContext oesctx, ESDSLdapObject contactinfo) Deprecated.
void	ModifyDistributionList(OESContext oesctx, java.lang.String emailId, ESDSLdapObject dl) Deprecated.
java.util.Vector	ModifyDistributionListMembers(OESContext oesctx, java.lang.String emailId, java.lang.String modificationType, java.lang.String memberType, java.util.Vector members) Deprecated.
void	ModifyMailUser(OESContext oesctx, java.lang.String emailId, ESDSLdapObject mailUser) Deprecated.
void	modifyNestedDlParentAttr(ESDSContext ctx, java.lang.String modificationType, java.lang.String listDN, java.util.Vector parentsDlDNAttrList)
void	ModifyPrivateList(OESContext oesctx, ESDSLdapObject privatelist) Deprecated.
java.util.Hashtable	ResolveDistributionList(OESContext oesctx, java.lang.String emailId) Deprecated.
java.util.Vector	ResolvePrivateList(OESContext oesctx, java.lang.String listName, java.lang.String resolutionType) Deprecated.
java.lang.String[]	SearchContacts(OESContext oesctx, java.lang.String searchCriteria) Deprecated.
java.lang.String[]	SearchPrivateLists(OESContext oesctx, java.lang.String searchCriteria) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ESDSDirServerAccess

public ESDSDirServerAccess()

Constructor, Default debugmode is off

Parameters:

void -

ESDSDirServerAccess

public ESDSDirServerAccess(boolean debug)

Constructor for Debug Mode

Parameters:

debug - True if running in debug mode

ESDSDirServerAccess

public ESDSDirServerAccess(OESContext cx)

Constructor for Debug Mode, Default debugmode is off

Parameters:

cx - The OESContext, which is the global context for all applications

ESDSDirServerAccess

public ESDSDirServerAccess(OESContext cx,
                           boolean debug)

Constructor for Debug Mode

Parameters:

cx - The OESContext, which is the global context for all applications

debug - True if running in debug mode

Method Detail

ESDSLogon

public ESDSContext ESDSLogon(java.lang.String ldapHost,
                             java.lang.String ldapPort,
                             java.lang.String method,
                             ESDSAuthObject logonParams)
                      throws ESDSException

Authenticates a server or an applications to the directory and return the ESDSContext. It Creates one ldap connection here. Call ESDSInitialization to create the ldap connection pool.

Parameters:

ldapHost - LDAPHostname

ldapPort - LDAP Port

method - type of connection DS_LOGON_ANONYMOUS, DS_LOGON_SIMPLE, DS_LOGON_SSL, DS_LOGON_SASL defined in ESDSConstants

logonParams - Logonparams depends on the type of authentication method selected. If the method is DS_LOGON_ANONYMOUS, then it's null, if the method is DS_LOGON_SIMPLE, then set simple auth methods of ESDSAuthObject. Similar methods to be provided for SSL, and SASL. Pass the type of caller in the logon params (refer ESDSAuthObject)

Returns:

ESDSContext

ESDSLogon

public ESDSContext ESDSLogon(java.lang.String callerType,
                             java.lang.String callerDN,
                             java.lang.String oraHome)
                      throws ESDSException

Authenticates a server or an applications to the directory and return the ESDSContext of the server or app. It Creates one ldap connection here. This version of the Logon uses the iAS Repository API's to create the ldap connections. The caller must be running on the iAS environment in order to make this call. Call ESDSInitialization to create the ldap connection pool.
SSL Connection to LDAP - if system property oracle.mail.ldap.connectssl is set to "true", then it makes ssl connection to LDAP. SSL connection is supported only while running in IAS oracle home

Parameters:

callerType - The caller type

callerDN - DN of the server instance if the caller type is DS_CALLERTYPE_SERVER, else null

oracleHome - The full path for the oracle home.

Returns:

ESDSContext

ESDSClientLogon

public ESDSContext ESDSClientLogon(ESDSContext serverContext,
                                   java.lang.String method,
                                   ESDSAuthObject logonParams)
                            throws ESDSException

This method is going to be called when a server logons on on behalf of a client, say for example, imap for mailuser. In this scenario, imap will call logoon and init for itself and it will pass it's context to this method. This method will authenticate the mailuser and return the mailuser's context to the caller. When the user state is inactive, it thows an exception with "INVALID_EMAILID" error.

Parameters:

serverContext - The server's context

method - type of connection DS_LOGON_ANONYMOUS, DS_LOGON_SIMPLE, DS_LOGON_SSL, DS_LOGON_SASL

logonParams - Logonparams depends on the type of authentication method selected. If the method is DS_LOGON_ANONYMOUS, then it's null, if the method is DS_LOGON_SIMPLE, then it's set simple auth methods of ESDSAuthObject. Similar methods to be provided for SSL, and SASL. Pass the type of caller in the logon params (refer ESDSAuthObject, pass ESDSConstants.DS_CALLERTYPE_MAILUSER for the mailusers)

Returns:

ESDSContext the user context

ESDSClientLogon

public ESDSContext ESDSClientLogon(java.lang.String ldapHost,
                                   java.lang.String ldapPort,
                                   java.lang.String method,
                                   ESDSAuthObject logonParams)
                            throws ESDSException

This method is going to be called to logon a client (mailuser etc.) It will check if the client ctx has a key to pool, if not then will call connectAs repository API to logon as a APP type. Then it will compare the user password and return the user's context. The pool params will be read from the following system properties.
oracle.mail.ldap.ldapool_minsize oracle.mail.ldap.ldapool_initialsize oracle.mail.ldap.ldapool_maxsize oracle.mail.ldap.ldapool_incrementsize oracle.mail.ldap.ldapool_shrinkinterval oracle.mail.ldap.ldapool_timeoutinterval
When both host and port are given, it requires the following two properties to be set. oracle.mail.ldap.admin_dn oracle.mail.ldap.admin_password When the logon is successful, the caller gets it's context back. The caller needs to pass it's context to all the subsequent calls to DS API's.
When host and port are null, it will assume that it's running in an IAS environment. In ias environment, it needs to set the following system properties. oracle.mail.ldap.oracle_home For the connection pool, it uses the same system properties When the user state is inactive, it thows an exception with "INVALID_EMAILID" error.

Parameters:

ldapHost - LDAPHostname null while running in ias environment

ldapPort - LDAP Port null while running in ias environment

method - type of connection DS_LOGON_ANONYMOUS, DS_LOGON_SIMPLE, DS_LOGON_SSL, DS_LOGON_SASL

logonParams - Logonparams depends on the type of authentication method selected. If the method is DS_LOGON_ANONYMOUS, then it's null, if the method is DS_LOGON_SIMPLE, then set simple auth methods of ESDSAuthObject. Similar methods to be provided for SSL, and SASL. Pass the type of caller in the logon params (refer ESDSAuthObject, pass ESDSConstants.DS_CALLERTYPE_MAILUSER for mailusers )

Returns:

ESDSContext the user context

ESDSInitialization

public void ESDSInitialization(ESDSContext ctx,
                               int minSize,
                               int initialSize,
                               int maxSize,
                               int incrementSize,
                               int shrinkingTimeOutInterval,
                               int timeOutInterval)
                        throws ESDSException

This method will initialize the ldap pool. Must call ESDSLogon before this. Only the servers and apps can call this method.

Parameters:

ctx - The Server Context

minSize - Minimun Size of the connection pool

initialSize - Initial Size of the connection pool

maxSize - Maximum Size of the connection pool

incrementSize - Pool increment Size

shrinkingTimeOutInterval - Pool Srinkage Time In secs

timeOutInterval - Timeout Interval For Getting A Connection. In other words when all conns in pool are in use, if any incoming requests comes in, it will wait for max this amount of time (thread sleeps for this amount of time, but if a free conn is available within this time it gets notified, so only in worst case if no conns get freed up, this timeout comes into picture). The second scenario is, if the ldap server goes down, we try to reconnect, it will wait for timeout amount of time before it reconnects. Starting reconnect EBF: a new system property is defined - oracle.mail.ldap.reconnecttime to have the reconnect time in secs. If we experience any ldap server connection errors, it will wait for this amount of time and then try to reconnect. If set to 0, then will retry immediately without waiting.

Returns:

void

GetMailUserMetaData

public ESDSLdapObject GetMailUserMetaData(OESContext oesctx,
                                          java.lang.String domain)
                                   throws ESDSException

Deprecated.

This method returns the metadata for a mailuser. The metadata for a mailuser consists of the list of mandatory and optional attributes the caller needs to set in order to create a mailuser. It also contains information about all these attributes, for example the syntax, multiplicity of the attributes, the default values for attributes (if any default is set in the LDAP). When the caller sets the attribute value on this metadata object, a validation is done to ensure that the caller sets the value of an attribute which is present in that particular entry. In UI based applications, using the metadata, the caller can do any input validations for the data entered.

Parameters:

oesctx - The caller's OES context. This must have been an authenticated oes context.

domain - The domain under which users will be created. for eg, for us.oracle.com

Returns:

mailuser metadata

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

CreateMailUser

public void CreateMailUser(OESContext oesctx,
                           java.lang.String publicUserDN,
                           ESDSLdapObject mailuser)
                    throws ESDSException

Deprecated.

This method creates a mailuser in the directory. It also creates the user's INBOX and the user in the database. Caller must call GetMailUserMetaData before this. After retrieving the metadata, the user can set the value of an attribute in the following manner. The attribute value can be set using the setAttributeValue method of the ESDSLdapObject class.
Example: This example sets the value for the "telephonenumber" attribute.
This sets the value to the default values provided mdata.getDefaultValues() is not null
ESDSAttribMetaData mdata = ldapobj.getMetaData("telephonenumber");
ldapobj.setAttributeValue("telephonenumber", mdata.getDefaultValues());
This example sets a new set of values for the "telephonenumber".
Vector newVals = new Vector();
newVals.add("408 7394050");
newVals.add("650 7394050");
ldapobj.setAttributeValue("telephonenumber", newVals);

Parameters:

oesctx - The caller's OES context. This must have been an authenticated oes context.

publicUser - The public user dn. This is the public user at the organizational level. This user must have been created prior to creating the mailuser.

mailUser - The mail user attribute and values.

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

LookupMailUser

public ESDSLdapObject LookupMailUser(OESContext oesctx,
                                     java.lang.String emailId)
                              throws ESDSException

Deprecated.

This method looks up a mailuser. Returns the mailuser attribute values.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

emailId - The fully qualified emailid of the user. For ex., user1@oracle.com.

Returns:

ESDSLdapObject the mailuser (similar to metadata). The mailuser attributes can be retrieved as shown in the following example.
Example:
ESDSAttribMetaData mdata = ldapobj.getMetaData("telephonenumber");
Vector values = mdata.getDefaultValues(); The values vector contains strings, which are values of the telephonenumber for this user. This is null if no value is set for the telephonenumber attribute

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ModifyMailUser

public void ModifyMailUser(OESContext oesctx,
                           java.lang.String emailId,
                           ESDSLdapObject mailUser)
                    throws ESDSException

Deprecated.

This method modifies a mailuser in the directory.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

emailId - The fully qualified emailid of the user to be modified. For ex., user1@oracle.com.

mailUser - The new data for modification. It can be set using the modifyAttributeValue method of the ESDSLdapObject class. The caller needs to specify the type of modification. The list of allowed modifications are as follows.

• ESDSConstants.DS_MODIFY_ADD : This adds the given set of values to the existing values
• ESDSConstants.DS_MODIFY_DELETE : This deletes the given set of values from the existing values.
• ESDSConstants.DS_MODIFY_REPLACE: This replaces the existing values with these new set of values.

Example: This example adds two new values for the "telephonenumber" attribute.
Vector newVals = new Vector();
newVals.add("408 7394050");
newVals.add("650 7394050");
ldapobj.modifyAttributeValue("telephonenumber", newVals, ESDSConstants.DS_MODIFY_ADD);

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

DeleteMailUser

public void DeleteMailUser(OESContext oesctx,
                           java.lang.String emailId)
                    throws ESDSException

Deprecated.

This method deletes a mailuser from the directory and db. This also deletes all the references to this mailuser in the directory. If the ldap operation fails for some reasons half way, it marks the "orclMailCreationStatus" attribute value as "DeletionInProgress".

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

emailId - The fully qualified emailid of the user to be deleted. For ex., user1@oracle.com.

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

GetDistributionListMetaData

public ESDSLdapObject GetDistributionListMetaData(OESContext oesctx,
                                                  java.lang.String domain)
                                           throws ESDSException

Deprecated.

This method returns the metadata for a public distribution list (DL). The metadata for a distribution list consists of the list of mandatory and optional attributes the caller needs to set in order to create a list. It also contains information about all these attributes, for example the syntax , multiplicity of the attributes, the default values for attributes (if any default is set in the LDAP). When the caller sets the attribute value on this metadata object, a validation is done to ensure that the caller sets the value of an attribute which is present in that particular entry. In UI based applications, using the metadata, the caller can do any input validations for the data entered.

Parameters:

oesctx - The caller's OES context. This must have been an authenticated oes context.

domain - The domain under which DL will be created. for eg, for us.oracle.com

Returns:

distribution list metadata

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

CreateDistributionList

public java.util.Hashtable CreateDistributionList(OESContext oesctx,
                                                  ESDSLdapObject list,
                                                  java.util.Hashtable members)
                                           throws ESDSException

Deprecated.

This method creates a distribution list in the directory. At the time of creation the caller can add members to the list. Adding members to a list can also be done later using ModifyDistributionListMembers API. Caller must call GetDistributionListMetaData before this. After retrieving the metadata, the caller can set the value of an attribute in the following manner. The attribute value can be set using the setAttributeValue method of the ESDSLdapObject class.
Example: This example sets the value for the "mailhost" attribute.
This sets the value to the default values provided mdata.getDefaultValues() is not null
ESDSAttribMetaData mdata = ldapobj.getMetaData("mailhost");
ldapobj.setAttributeValue("mailhost", mdata.getDefaultValues());
This example sets a new set of values for the "mailhost".
Vector newVals = new Vector();
newVals.add("host1");
newVals.add("host2");
ldapobj.setAttributeValue("mailhost", newVals); If the ldap operation fails for some reasons half way, it marks the "orclMailCreationStatus" attribute value as "CreationtionInProgress".

Parameters:

oesctx - The caller's OES context. This must have been an authenticated oes context.

list - The DL attributes and values, the mail attribute must contain the fully qualified mailid for the distribution list for example, list1@oracle.com. The attribute valuea can be set as shown above.

members - A hashtable containing the members of the list. The key of the hashtable is a string representing the type of member, it can be one of the following.

• ESDSConstants.DS_USER for mailuser
• ESDSConstants.DS_LIST for a distribution list
• ESDSConstants.DS_ALIAS for an alias
• ESDSConstants.DS_FOREIGN for the foreign members. If the list is getting created in the domain oracle.com, any mail ids not belonging to the domain oracle.com are treated as foreign members.

The hashtable value is a vector of values (Strings). The hashtable can be NULL when no member is added at the time of creation.

Returns:

hashtable of elements that couldn't be added, key is type (one of the above) and value is a vector of values for that type. For ex:, if it failed to add user1@oracle.com of type ESDSConstants.DS_USER and user2@oracle.com of type ESDSConstants.DS_USER, then it would return a hashtable with key as ESDSConstants.DS_USER and value as a vector containing user1@oracle.com and user2@oracle.com

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

LookupDistributionList

public ESDSLdapObject LookupDistributionList(OESContext oesctx,
                                             java.lang.String emailId)
                                      throws ESDSException

Deprecated.

This method looks up a Distribution List. Returns the DL attribute values.
Note: This cannot be used to retrieve members of a DL, in order to get the list of members for a DL, the callers needs to call the ResolveDistributionList API.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

emailId - The fully qualified emailid of the DL.For ex., list1@oracle.com.

Returns:

ESDSLdapObject the DL (similar to metadata). The DL attributes can be retrieved as shown in the following example.
Example:
Vector values = ldapobj.getAttributeValue("mailhost") The values vector contains strings, which are values of the mailhost for this DL. This is null if no value is set for the mailhost attribute.

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ModifyDistributionList

public void ModifyDistributionList(OESContext oesctx,
                                   java.lang.String emailId,
                                   ESDSLdapObject dl)
                            throws ESDSException

Deprecated.

This method modifies a DL in the directory.
Modification of members of a list cannot be done using this API. The caller needs to use ModifyDistributionListMembers API for that purpose.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

emailId - The fully qualified emailid of the DL to be modified. For ex., list1@oracle.com.

dl - The new data for modification . It can be set using the modifyAttributeValue method of the ESDSLdapObject class. The caller needs to specify the type of modification. The list of allowed modifications are as follows.

• ESDSConstants.DS_MODIFY_ADD : This adds the given set of values to the existing values
• ESDSConstants.DS_MODIFY_DELETE : This deletes the given set of values from the existing values.
• ESDSConstants.DS_MODIFY_REPLACE: This replaces the existing values with these new set of values.

Example: This example adds two new values for the "mailhost" attribute.
Vector newVals = new Vector();
newVals.add("newhost");
ldapobj.modifyAttributeValue("mailhost", newVals, ESDSConstants.DS_MODIFY_ADD);

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

DeleteDistributionList

public void DeleteDistributionList(OESContext oesctx,
                                   java.lang.String emailId)
                            throws ESDSException

Deprecated.

This method deletes a Distribution List from the directory. This also deletes all the references to this DL in the directory. If the ldap operation fails for some reasons half way, it marks the "orclMailCreationStatus" attribute value as "DeletionInProgress".

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

emailId - The fully qualified emailid of the DL to be deleted. For ex., list1@oracle.com.

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ResolveDistributionList

public java.util.Hashtable ResolveDistributionList(OESContext oesctx,
                                                   java.lang.String emailId)
                                            throws ESDSException

Deprecated.

This method provides resolution of list. For example, given a list email address, this function returns the absolute members of the list. of the list.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

emailId - The fully qualified emailid of the DL to be resolved. For ex., list1@oracle.com.

Returns:

Hashtable containing list of resolved names. The key of the hashtable is a string representing the type of member, it can be one of the following.

• ESDSConstants.DS_USER for mailuser
• ESDSConstants.DS_LIST for a distribution list
• ESDSConstants.DS_ALIAS for an alias
• ESDSConstants.DS_FOREIGN for the foreign members. If the list belongs to the domain oracle.com, any mail ids not belonging to the domain oracle.com are treated as foreign members. The values would be a vector of Strings containing the mail ids.

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ModifyDistributionListMembers

public java.util.Vector ModifyDistributionListMembers(OESContext oesctx,
                                                      java.lang.String emailId,
                                                      java.lang.String modificationType,
                                                      java.lang.String memberType,
                                                      java.util.Vector members)
                                               throws ESDSException

Deprecated.

This method modifies the members of a DL in the directory. Using this, new members can be added/deleted to/from an existing DL.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

emailId - The fully qualified emailid of the DL to be modified. For ex., list1@oracle.com.

modificationType - The type of modification operation. The list of allowed modifications are as follows.

• ESDSConstants.DS_MODIFY_ADD : This adds the given set of values to the existing values
• ESDSConstants.DS_MODIFY_DELETE : This deletes the given set of values from the existing values.
• ESDSConstants.DS_MODIFY_REPLACE: This replaces the existing values with these new set of values.

memberType - The type of members for the modification operaion. The list of allowed membertypes are

• ESDSConstants.DS_USER for mailuser
• ESDSConstants.DS_LIST for a distribution list
• ESDSConstants.DS_ALIAS for an alias
• ESDSConstants.DS_FOREIGN for the foreign members. If the list belongs to the domain oracle.com, any mail ids not belonging to the domain oracle.com are treated as foreign members. The values would be a vector of Strings containing the mail ids.

members - The members to be added or deletd. Is a vector of string values depending on the type.

Returns:

vector of string, which are the list of members that couldn't be modified.

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

GetContactInfoMetaData

public ESDSLdapObject GetContactInfoMetaData(OESContext oesctx)
                                      throws ESDSException

Deprecated.

This method returns the metadata for a user's private address book contact info object. The metadata for a contact info consists of the list of mandatory and optional attributes the caller needs to set in order to create a contact info. It also contains information about all these attributes, for example the syntax, multiplicity of the attributes etc. When the caller sets the attribute value on this metadata object, a validation is done to ensure that the caller sets the value of an attribute which is present in that particular entry. In UI based applications, using the metadata, the caller can do any input validations for the data entered.

Parameters:

oesctx - The caller's OES context. This must have been an authenticated oes context belonging to the user logged on.

Returns:

contact info metadata

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

CreateContactInfo

public void CreateContactInfo(OESContext oesctx,
                              ESDSLdapObject contactinfo)
                       throws ESDSException

Deprecated.

This method creates a contact info in the directory for the user logged in. Caller must call GetContactInfoMetaData before this. After retrieving the metadata, the user can set the value of an attribute in the following manner. The attribute value can be set using the setAttributeValue method of the ESDSLdapObject class.
Example: This example sets the value for the "telephonenumber" attribute.
This sets the value to the default values provided mdata.getDefaultValues() is not null
ESDSAttribMetaData mdata = ldapobj.getMetaData("telephonenumber");
ldapobj.setAttributeValue("telephonenumber", mdata.getDefaultValues());
This example sets a new set of values for the "telephonenumber".
Vector newVals = new Vector();
newVals.add("408 7394050");
newVals.add("650 7394050");
ldapobj.setAttributeValue("telephonenumber", newVals);

Parameters:

oesctx - The caller's OES context. This must have been an authenticated oes context.

contactinfo - The contact info attribute and values.

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

LookupContactInfo

public ESDSLdapObject LookupContactInfo(OESContext oesctx,
                                        java.lang.String contactName)
                                 throws ESDSException

Deprecated.

This method looks up a contact for the mailuser logged in. Returns the contact info attribute values.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

contactName - The name of the contact in the user's addressbook.

Returns:

ESDSLdapObject the contact (similar to metadata). The contact attributes can be retrieved as shown in the following example.
Example:
Vector values = ldapobj.getAttributeValue("telephonenumber") The values vector contains strings, which are values of the telephonenumber for this user. This is null if no value is set for the telephonenumber attribute

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ModifyContactInfo

public void ModifyContactInfo(OESContext oesctx,
                              ESDSLdapObject contactinfo)
                       throws ESDSException

Deprecated.

This method modifies a contact info in the directory.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

contactinfo - The new data for modification. It can be set using the modifyAttributeValue method of the ESDSLdapObject class. The caller needs to specify the type of modification. The list of allowed modifications are as follows.

• ESDSConstants.DS_MODIFY_ADD : This adds the given set of values to the existing values
• ESDSConstants.DS_MODIFY_DELETE : This deletes the given set of values from the existing values.
• ESDSConstants.DS_MODIFY_REPLACE: This replaces the existing values with these new set of values.

Example: This example adds two new values for the "telephonenumber" attribute.
Vector newVals = new Vector();
newVals.add("408 7394050");
newVals.add("650 7394050");
ldapobj.modifyAttributeValue("telephonenumber", newVals, ESDSConstants.DS_MODIFY_ADD);

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

DeleteContactInfo

public void DeleteContactInfo(OESContext oesctx,
                              java.lang.String contactName)
                       throws ESDSException

Deprecated.

This method deletes a contact info from the directory. This also deletes all the references to this contact info in the user's private address book.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

contactName - The name of the contact to be deleted.

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

GetAllContacts

public java.lang.String[] GetAllContacts(OESContext oesctx)
                                  throws ESDSException

Deprecated.

This method retrieves all Contacts for the user logged on.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

Returns:

An array of strings containing the contact names

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

SearchContacts

public java.lang.String[] SearchContacts(OESContext oesctx,
                                         java.lang.String searchCriteria)
                                  throws ESDSException

Deprecated.

This method retrieves all Contacts for the user logged on for the given search criteria. The search criteria is the ldap filter. For ex., "name=t*" returns all the contacts starting with "t".

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

searchCriteria - The search criteria in the ldap filter format oes context.

Returns:

An array of strings containing the contact names

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

GetPrivateListMetaData

public ESDSLdapObject GetPrivateListMetaData(OESContext oesctx)
                                      throws ESDSException

Deprecated.

This method returns the metadata for a user's private list object. User's private lists are stored in the user's private address book and are accessible by that particular user only. The metadata for a private list consists of the list of mandatory and optional attributes the caller needs to set in order to create a contact info. It also contains information about all these attributes, for example the syntax, multiplicity of the attributes etc. When the caller sets the attribute value on this metadata object, a validation is done to ensure that the caller sets the value of an attribute which is present in that particular entry. In UI based applications, using the metadata, the caller can do any input validations for the data entered.

Parameters:

oesctx - The caller's OES context. This must have been an authenticated oes context belonging to the user logged on.

Returns:

private list metadata

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

CreatePrivateList

public void CreatePrivateList(OESContext oesctx,
                              ESDSLdapObject privatelist)
                       throws ESDSException

Deprecated.

This method creates a privatelist in the directory for the user logged in. Caller must call GetPrivateListMetaData before this. After retrieving the metadata, the user can set the value of an attribute in the following manner. The attribute value can be set using the setAttributeValue method of the ESDSLdapObject class.
Example: This example sets the value for the "telephonenumber" attribute.
This sets the value to the default values provided mdata.getDefaultValues() is not null
ESDSAttribMetaData mdata = ldapobj.getMetaData("telephonenumber");
ldapobj.setAttributeValue("telephonenumber", mdata.getDefaultValues());
This example sets a new set of values for the "telephonenumber".
Vector newVals = new Vector();
newVals.add("408 7394050");
newVals.add("650 7394050");
ldapobj.setAttributeValue("telephonenumber", newVals);

Parameters:

oesctx - The caller's OES context. This must have been an authenticated oes context.

privatelist - The private list attribute and values.

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

LookupPrivateList

public ESDSLdapObject LookupPrivateList(OESContext oesctx,
                                        java.lang.String listName)
                                 throws ESDSException

Deprecated.

This method looks up a private list for the mailuser logged in. Returns the private list attribute values.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

listName - The name of the private list in the user's addressbook.

Returns:

ESDSLdapObject the private list (similar to metadata). The private list attributes can be retrieved as shown in the following example.
Example:
Vector values = ldapobj.getAttributeValue("telephonenumber") The values vector contains strings, which are values of the telephonenumber for this user. This is null if no value is set for the telephonenumber attribute

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ModifyPrivateList

public void ModifyPrivateList(OESContext oesctx,
                              ESDSLdapObject privatelist)
                       throws ESDSException

Deprecated.

This method modifies a private list in the directory.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

privatelist - The new data for modification. It can be set using the modifyAttributeValue method of the ESDSLdapObject class. The caller needs to specify the type of modification. The list of allowed modifications are as follows.

• ESDSConstants.DS_MODIFY_ADD : This adds the given set of values to the existing values
• ESDSConstants.DS_MODIFY_DELETE : This deletes the given set of values from the existing values.
• ESDSConstants.DS_MODIFY_REPLACE: This replaces the existing values with these new set of values.

Example: This example adds two new values for the "telephonenumber" attribute.
Vector newVals = new Vector();
newVals.add("408 7394050");
newVals.add("650 7394050");
ldapobj.modifyAttributeValue("telephonenumber", newVals, ESDSConstants.DS_MODIFY_ADD);

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

DeletePrivateList

public void DeletePrivateList(OESContext oesctx,
                              java.lang.String listName)
                       throws ESDSException

Deprecated.

This method deletes a private list from the directory. This also deletes all the references to this list in the user's private address book.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

listName - The name of the private list to be deleted.

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

GetAllPrivateLists

public java.lang.String[] GetAllPrivateLists(OESContext oesctx)
                                      throws ESDSException

Deprecated.

This method retrieves all private lists for the user logged on.

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

Returns:

An array of strings containing the private lists

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

SearchPrivateLists

public java.lang.String[] SearchPrivateLists(OESContext oesctx,
                                             java.lang.String searchCriteria)
                                      throws ESDSException

Deprecated.

This method retrieves all private lists for the user logged on for the given search criteria. The search criteria is the ldap filter. For ex., "name=t*" returns all the contacts starting with "t".

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

searchCriteria - The search criteria in the ldap filter format oes context.

Returns:

An array of strings containing the private lists

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ResolvePrivateList

public java.util.Vector ResolvePrivateList(OESContext oesctx,
                                           java.lang.String listName,
                                           java.lang.String resolutionType)
                                    throws ESDSException

Deprecated.

This method resolves the list to the given resolution type. If it contains other aliases and dls, it would resolve the aliases and dls too. For ex., when resolutionType is "orclmailemail", it will resolve the given entry to the attribute "orclmailemail". When a private dl dl1 is resolved to the type "orclmailemail", it retruns all the mail ids contained in the dl1. If dl1 contains other dls and contacts, it resolves the included dls and contacts also to type "orclmailemail".

Parameters:

oescxt - The caller's OES context. This must have been an authenticated oes context.

listName - The name of the private list

resolutionType - The resolution type, which is the attribute name to resolve to

Returns:

A vector of strings containing the resolved values.

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ESDSManageDomainAdmins

public void ESDSManageDomainAdmins(ESDSContext ctx,
                                   java.lang.String mailid,
                                   java.lang.String domain,
                                   int operationType)
                            throws ESDSException

Adds/Removes a mailuser to/from the domain admin list

Parameters:

ctx - is the admin context

mailID - is the fully qualified email id of the user who is to be made the domain administrator

domain - is the domain name operationType: 0 make user a domain administrator 1 remove user from the domain administrator list

Returns:

void

ESDSAddEntry

public java.util.Vector ESDSAddEntry(ESDSContext ctx,
                                     ESDSAddData[] data)
                              throws ESDSException

This method adds an entry to the directory. This can add multiple entries at a time. Please refer ESDSAddData to see how to set the attributes for the entry to be added. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

data - The entries to be added

Returns:

Vector the list of dn's of entries that couldn't be added

ESDSAddEntry

public java.util.Vector ESDSAddEntry(ESDSContext ctx,
                                     ESDSAddData[] data,
                                     boolean toContinue)
                              throws ESDSException

This method adds an entry to the directory. This can add multiple entries at a time. Please refer ESDSAddData to see how to set the attributes for the entry to be added. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

data - The entries to be added

toContinue - If true, then continues adding ignoring the failures

Returns:

Vector the list of dn's of entries that couldn't be added

ESDSModifyEntry

public void ESDSModifyEntry(ESDSContext ctx,
                            java.lang.String dn,
                            ESDSModifyData data)
                     throws ESDSException

This method modifies an entry in the directory. This can modify multiple attributes of the same entry at a time. Please refer ESDSModifyData to see how to set the attributes and values for the modify operation. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

dn - The DN of the entry to be modified

data - The data to be modified

Returns:

void

ESDSDeleteEntry

public void ESDSDeleteEntry(ESDSContext ctx,
                            java.lang.String dn)
                     throws ESDSException,
                            javax.naming.NamingException

This method deletes an entry from the directory. Must call ESDSLogon before this.

Parameters:

context - The caller's context

dn - The DN of the entry to be modified

Returns:

void

ESDSQueryUsers

public java.util.Vector ESDSQueryUsers(ESDSContext ctx,
                                       java.lang.String userQuery,
                                       java.lang.String domainName,
                                       int sizeLimit,
                                       boolean sortResults)
                                throws ESDSException

This method queries the mailusers based on the search criteria. Must call ESDSLogon before this.

Parameters:

context - The caller's context

userQuery - The filter. For eg, t* for user names with "t*".

domainName - The domain name

sizeLimit - The no of results to be returned per iteration, if this is 0 or -1, then it retrieves all

sortResults - true if result is to be sorted

Returns:

the resolved vector is a vector of ESDSAttributeValueList. This method returns "mail", "targetdn" and "uid" attributes. For fetching other attributes, use the overloaded method.

ESDSQueryUsers

public java.util.Vector ESDSQueryUsers(ESDSContext ctx,
                                       java.lang.String userQuery,
                                       java.lang.String domainName,
                                       int sizeLimit,
                                       java.lang.String sortingAttr,
                                       java.util.Vector attrsToFetch)
                                throws ESDSException

This method queries the mailusers based on the search criteria. Must call ESDSLogon before this.

Parameters:

context - The caller's context

userQuery - The filter. For eg, t* for user names with "t*".

domainName - The domain name

sizeLimit - The no of results to be returned per iteration, if this is 0 or -1, then it retrieves all

sortingAttr - The name attribute for which results are to be sorted, this will be using server side sorting feature (provided server side ldap sorting is supported by OID). null implies no sorting

attrsToFetch - a vector containing list of attributes to fetch, when this is null, it fetches everything

Returns:

the resolved vector is a vector of ESDSAttributeValueList

ESDSResolveEntry

public java.util.Hashtable ESDSResolveEntry(ESDSContext ctx,
                                            java.lang.String entryName,
                                            java.lang.String entryType,
                                            java.lang.String resolutionType,
                                            boolean ifPrivate,
                                            boolean sortResultSet,
                                            int sizeLimit)
                                     throws ESDSException

Deprecated.

This method provides resolution of list, alias. For example, given a email address, may be a distribution list name, this function returns the absolute members of the list. Must call ESDSLogon before this.
DEPRECATED - ALIAS RESOLUTION CAN BE ACHIEVED BY USING ESDSLookupPublicAlias
DL Resolution (getting all members) can be achieved by calling ESDSSearchMembersInDL with memberQueryString as "*" and memberType as null

Parameters:

ctx - The caller's context

entryName - The string that needs to be resolved. If it's a public dl, then it should be the fully qualified email address of the dl.

entryType - The type of entry that is to be resolved, can be ESDSConstants.DS_LIST, ESDSConstants.DS_ALIAS

resolutionType - The type of entry that is to be resolved, eg, mail. Pass ESDSConstants.DS_MAIL for mail resolution

sortResultSet - Specifies whether the results will be sorted

sizeLimit - The no of results to be returned per iteration, if this is -1, then it retrieves all

Returns:

Hashtable containing list of resolved and unresolved names. The keys for the hashtable would be the attribute types, ESDSConstants. DS_USER, ESDSConstants.DS_LIST, ESDSConstants.DS_ALIAS, ESDSConstants.DS_UMATTRS and the values would be vector of Strings. For alias resolution, the key will be ESDSConstants.DS_MAIL and the value will be the email id

ESDSResolveName

public ESDSMemberList ESDSResolveName(ESDSContext ctx,
                                      java.lang.String entryName,
                                      java.lang.String resolutionType,
                                      java.lang.String domainName,
                                      int sortResultSet,
                                      int sizeLimit)
                               throws ESDSException

Deprecated.

This method provides a mailuseruser resolution. Must call ESDSLogon before this. DEPRECATED USE ESDSQueryUsers instead.

Parameters:

ctx - The caller's context

entryName - The string that needs to be resolved.

entryType - The type of entry that is to be resolved, eg., ESDSConstants.DS_RESOLUTION_MAILUSER

resolutionType - The type of entry that is to be resolved, eg, mail, * phoneno, if the type is ESDSConstants.DS_RESOLUTION_MAILUSER, it will search for mailusers given the search criteria, for this type, the search criteria is specified as the entryName param, for eg, "t*", returns a list of users whose mail or uid matches the filter t*

sortResultSet - Specifies how the results will be sorted

sizeLimit - The no of results to be returned per iteration, if this is 0, then it retrieves all

Returns:

ESDSMemberList containing list of resolved and unresolved names and * commonly used attributes, if type is ESDSConstants.DS_RESOLUTION_MAILUSER, then the resolved vector is a vector of ESDSAttributeValueList

ESDSSearchDLs

public java.util.Vector ESDSSearchDLs(ESDSContext ctx,
                                      java.lang.String dlQueryString,
                                      java.lang.String domainName,
                                      int sizeLimit)
                               throws ESDSException

This method queries for lists based on the given search criteria. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

dlQueryString - The filter. For eg, t* for list mailids with "t*".

domainName - The domain to search for the dl's

sizeLimit - The no of results to be returned per iteration, if this is <=0, then it retrieves all

Returns:

vector of ESDSLdapObjects (the dl attribs and values) This method returns all attributes

ESDSSearchDLs

public java.util.Vector ESDSSearchDLs(ESDSContext ctx,
                                      java.lang.String dlQueryString,
                                      java.lang.String domainName,
                                      int sizeLimit,
                                      java.lang.String sortingAttr,
                                      java.util.Vector attrsToFetch)
                               throws ESDSException

This method queries for lists based on the given search criteria. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

dlQueryString - The filter. For eg, t* for list mailids with "t*".

domainName - The domain to search for the dl's

sizeLimit - The no of results to be returned per iteration, if this is <=0, then it retrieves all

sortingAttr - The name attribute for which results are to be sorted, this will be using server side sorting feature (provided server side ldap sorting is supported by OID). null implies no sorting

attrsToFetch - a vector containing list of attributes to fetch, when this is null, it fetches everything

Returns:

vector of ESDSLdapObjects (the dl attribs and values)

ESDSGetSubscribedDLs

public java.lang.String[] ESDSGetSubscribedDLs(ESDSContext ctx,
                                               java.lang.String userMailID)
                                        throws ESDSException

This method returns the list of DL's a user is subscribed to.

Parameters:

context - The caller's context

userMailID - The fully qualified email id of the user

Returns:

String[], containing the mail id's of dl's

ESDSGetAttributes

public ESDSAttributeValueList[] ESDSGetAttributes(ESDSContext ctx,
                                                  java.lang.String filter,
                                                  java.util.Vector attributeNames)
                                           throws javax.naming.NamingException

This method searches the directory for the given filter and returns the value/values of attributes. This assumes that searchbase is root. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

filter - The search filter

attributeNames - Returning attributes

Returns:

attribute values for each search results. Returns all attribs.

ESDSGetAttributes

public ESDSAttributeValueList[] ESDSGetAttributes(ESDSContext ctx,
                                                  java.lang.String searchBase,
                                                  java.lang.String filter,
                                                  java.util.Vector attributeNames)
                                           throws javax.naming.NamingException

This method searches the directory for the given filter with the given searchbase and returns the value/values of attributes. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

searchBase - The search base

filter - The search filter

attributeNames - Returning attributes

Returns:

attribute values for each search results.

ESDSGetAttributes

public ESDSAttributeValueList[] ESDSGetAttributes(ESDSContext ctx,
                                                  java.lang.String searchBase,
                                                  java.lang.String filter,
                                                  java.util.Vector attributeNames,
                                                  javax.naming.directory.SearchControls ctl)
                                           throws javax.naming.NamingException

This method searches the directory for the given filter with the given searchbase and returns the value/values of attributes. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

searchBase - The search base

filter - The search filter

attributeNames - Returning attributes

Returns:

attribute values for each search results.

ESDSGetAttributes

public ESDSAttributeValueList[] ESDSGetAttributes(java.lang.String searchBase,
                                                  java.lang.String filter,
                                                  java.util.Vector attributeNames,
                                                  javax.naming.directory.SearchControls ctl,
                                                  ESDSLdapHandle conn)
                                           throws javax.naming.NamingException

This method searches the directory for the given filter with the given searchbase and returns the value/values of attributes. Must call ESDSLogon before this.

Parameters:

searchBase - The search base

filter - The search filter

attributeNames - Returning attributes

conn - The ldap conn

Returns:

attribute values for each search results.

ESDSGetEntry

public ESDSAttributeValueList ESDSGetEntry(ESDSContext context,
                                           java.lang.String dn,
                                           java.util.Vector attributeNames)
                                    throws javax.naming.NamingException

This method looks up an entry in the directory. Must call ESDSLogon before this.

Parameters:

context - The caller's context

dn - The DN of the entry

attributeNames - Returning attributes

Returns:

attribute values

GetEntry

public ESDSAttributeValueList GetEntry(java.lang.String dn,
                                       java.util.Vector attributeNames,
                                       ESDSLdapHandle conn)
                                throws javax.naming.NamingException

ESDSGetSharedFolderMetaData

public ESDSLdapObject ESDSGetSharedFolderMetaData(ESDSContext context)
                                           throws ESDSException

This method returns the metadata for a shared folder. Must call ESDSLogon before this.

Parameters:

context - The caller's context

Returns:

shared folder metadata

ESDSCreateSharedFolder

public void ESDSCreateSharedFolder(ESDSContext context,
                                   java.lang.String folderName,
                                   ESDSLdapObject folder)
                            throws ESDSException

This method creates a shared folder in the directory.

Parameters:

context - The caller's context

folderName - The shared folder name, enter in the format /shared/folder1/folder2, if shared and folder1 don't exist, it will create those first and then create folder2

folder - the folder params

Returns:

void

ESDSCreateSharedFolder

public void ESDSCreateSharedFolder(ESDSContext context,
                                   java.lang.String folderName,
                                   ESDSLdapObject folder,
                                   boolean ifPublic)
                            throws ESDSException

This method creates a shared folder in the directory.

Parameters:

context - The caller's context

folderName - The shared folder name, enter in the format /shared/folder1/folder2, if shared and folder1 don't exist, it will create those first and then create folder2

folder - the folder params

ifPublic - When this flag is true, this API will create a public folder. It will set the display name for the folders while creating.

Returns:

void

ESDSLookupSharedFolder

public ESDSAttributeValueList ESDSLookupSharedFolder(ESDSContext context,
                                                     java.lang.String folderName)
                                              throws ESDSException

This method returns all folder attribute values if the folder exists in LDAP, returns null if folder doesn't exist in LDAP.

Parameters:

context - The caller's context, must be a user context

folderName - The shared folder name, enter in the format /shared/folder1/folder2

Returns:

the attribute value pairs of the folder throws ESDSEXception in case of error

ESDSDeleteSharedFolder

public void ESDSDeleteSharedFolder(ESDSContext ctx,
                                   java.lang.String folderName)
                            throws ESDSException

This method deletes a shared folder from the directory. It deletes all the subfolder's for the given folder, also updates the orclmailfolderdn attrib wherever required.

Parameters:

context - The caller's context

folderName - The shared folder name to be deleted.

Returns:

void

ESDSModifySharedFolder

public void ESDSModifySharedFolder(ESDSContext ctx,
                                   java.lang.String folderName,
                                   ESDSLdapObject folder)
                            throws ESDSException

This method modifies a shared folder in the directory.

Parameters:

context - The caller's context

folder - The folder to be modified, please use modifyAttributeValue method of ESDSLdapObject to set the values for modification

Returns:

void

ESDSRenameSharedFolder

public void ESDSRenameSharedFolder(ESDSContext context,
                                   java.lang.String oldFolderName,
                                   java.lang.String newFolderName)
                            throws ESDSException

This method renames a shared folder in the directory.

Parameters:

context - The caller's context

oldFolderName - The folder that is to be renamed

newFolderName - The new folder name

Returns:

void

ESDSSetSharedFolderAci

public void ESDSSetSharedFolderAci(ESDSContext context,
                                   java.lang.String folderName,
                                   ESDSLdapObject folder)
                            throws ESDSException

Given a user/dl/group and Shared folder ; set the aci of the user/dl/group

Parameters:

context - The caller's context

folderName - The folder name

folder - The folder object, set aci using the setMembersACI method of the ESDSLdapObject class

Returns:

void

ESDSSetSharedFolderAci

public void ESDSSetSharedFolderAci(ESDSContext context,
                                   java.lang.String folderName,
                                   ESDSLdapObject folder,
                                   int flags)
                            throws ESDSException

Given a user/dl/group and Shared folder ; set the aci of the user/dl/group

Parameters:

context - The caller's context

folderName - The folder name

folder - The folder object, set aci using the setMembersACI method of the ESDSLdapObject class

Returns:

void

ESDSIsInheritedAciExists

public boolean ESDSIsInheritedAciExists(ESDSContext context,
                                        java.lang.String folderName,
                                        java.lang.String memberName)
                                 throws ESDSException

ESDSIsInheritedAciExists

public boolean ESDSIsInheritedAciExists(ESDSContext context,
                                        ESDSLdapHandle handle,
                                        java.lang.String folder,
                                        java.lang.String member,
                                        java.util.Vector vectfolderAci,
                                        java.util.Vector vectRecursiveAci,
                                        java.util.Vector vectUserfolderAci,
                                        int flag)
                                 throws ESDSException

ESDSIsInheritedAciExists

public boolean ESDSIsInheritedAciExists(ESDSContext context,
                                        ESDSLdapHandle handle,
                                        java.lang.String folder)
                                 throws ESDSException

ESDSGetSharedFolderAciForUser

public java.util.Hashtable ESDSGetSharedFolderAciForUser(ESDSContext context,
                                                         java.lang.String folderName,
                                                         java.lang.String memberName)
                                                  throws ESDSException

Given a member, returns all the aci's for that member for the given folder

Parameters:

context - The caller's context Folder ACIs due to DL membership will not be calculated when the system property oracle.mail.ldap.folder.dlmembership is set to false. When this property is not set or set to true, ACIs due to DL memberships will be computed.

folderName - The folder name

memberName - The mailid of the user

Returns:

Hashtable, where key is the foldername and value is a vector of all ACI's for that user, empty vector if no aci is present for any folder

ESDSGetSharedFolderAciForUser

public java.util.Hashtable ESDSGetSharedFolderAciForUser(ESDSContext context,
                                                         java.lang.String folderName,
                                                         java.lang.String memberName,
                                                         boolean fetchPublicAci)
                                                  throws ESDSException

Given a member, returns all the aci's for that member for the given folder Folder ACIs due to DL membership will not be calculated when the system property oracle.mail.ldap.folder.dlmembership is set to false. When this property is not set or set to true, ACIs due to DL memberships will be computed.

Parameters:

context - The caller's context

folderName - The folder name

memberName - The mailid of the user

fetchPublicAci - When true, then the public folder aci will also be returned

Returns:

Hashtable, where key is the foldername and value is a vector of all ACI's for that user, empty vector if no aci is present for any folder

ESDSGetPublicFolderAciForUser

public java.util.Hashtable ESDSGetPublicFolderAciForUser(ESDSContext context,
                                                         java.lang.String memberName)
                                                  throws ESDSException

Given a mail user, returns all the public folder aci's for the user.

Parameters:

context - The caller's context

memberName - The fully qualified mailid of the user

Returns:

Hashtable, where key is the foldername and value is a vector of all public folder ACI's. Null if there is no public folder in the system

ESDSGetSharedFolderAciForUser

public java.util.Hashtable ESDSGetSharedFolderAciForUser(ESDSContext context,
                                                         java.lang.String memberName)
                                                  throws ESDSException

Given a member, returns all the aci's for that member to all folders he/she has subscribed to Folder ACIs due to DL membership will not be calculated when the system property oracle.mail.ldap.folder.dlmembership is set to false. When this property is not set or set to true, ACIs due to DL memberships will be computed.

Parameters:

context - The caller's context

memberName - The mailid of the user

Returns:

Hashtable, where key is the foldername and value is a vector of all ACI's for that user. If the member has aci's set for the subfolder, but doesn't have any aci for the parent folders, then the aci value vector for the parent folders contain a vector with no element. Null if no aci is present for any folder

ESDSGetSharedFolderAciForUser

public java.util.Hashtable ESDSGetSharedFolderAciForUser(ESDSContext context,
                                                         java.lang.String memberName,
                                                         boolean fetchPublicAci)
                                                  throws ESDSException

Given a member, returns all the aci's for that member to all folders he/she has subscribed to Folder ACIs due to DL membership will not be calculated when the system property oracle.mail.ldap.folder.dlmembership is set to false. When this property is not set or set to true, ACIs due to DL memberships will be computed.

Parameters:

context - The caller's context

memberName - The mailid of the user

fetchPublicAci - When true, then the public folder aci will also be returned

Returns:

Hashtable, where key is the foldername and value is a vector of all ACI's for that user. If the member has aci's set for the subfolder, but doesn't have any aci for the parent folders, then the aci value vector for the parent folders contain a vector with no element. Null if no aci is present for any folder

ESDSGetSharedFolderAci

public java.util.Hashtable ESDSGetSharedFolderAci(ESDSContext context,
                                                  java.lang.String folderName)
                                           throws ESDSException

Given a folder, returns all it's members and their ACI's

Parameters:

context - The caller's context

folderName - The folder name

Returns:

Hashtable, where key is the username;usertype and value is a vector of all ACI's for that member. Example of a key is mailuser;tanaya@oracle.com or domain;us.oracle.com. Returns null if there is no aci set on this folder

ESDSGetSharedFolderAci

public java.util.Hashtable ESDSGetSharedFolderAci(ESDSContext context,
                                                  java.lang.String folderName,
                                                  boolean fetchPublicAci)
                                           throws ESDSException

Given a folder, returns all it's members and their ACI's Folder ACIs due to DL membership will not be calculated when the system property oracle.mail.ldap.folder.dlmembership is set to false. When this property is not set or set to true, ACIs due to DL memberships will be computed.

Parameters:

context - The caller's context

folderName - The folder name

fetchPublicAci - When true, then the public folder aci will also be returned

Returns:

Hashtable, where key is the username;usertype and value is a vector of all ACI's for that member. Example of a key is mailuser;tanaya@oracle.com or domain;us.oracle.com. Returns null if there is no aci set on this folder

ESDSGetSharedFolderCreatorsInfo

public ESDSAttributeValueList ESDSGetSharedFolderCreatorsInfo(ESDSContext ctx,
                                                              java.lang.String folderName)
                                                       throws ESDSException

Given a folder, returns the creators info

Parameters:

context - The caller's context

folderName - The folder name

Returns:

ESDSAttributeValueList, containing the mailstore info, and the db userid for the owner

ESDSGetSharedFolderCreatorsInfo

public ESDSAttributeValueList ESDSGetSharedFolderCreatorsInfo(ESDSContext ctx,
                                                              java.lang.String folderName,
                                                              boolean ifDisplayName)
                                                       throws ESDSException

Given a folder, returns the creators info

Parameters:

context - The caller's context

folderName - The folder name

ifDisplayName - When this flag is true, it will search for the folder based on the display name, so folderName MUST be the display name when this flag is true

Returns:

ESDSAttributeValueList, containing the mailstore info, and the db userid for the owner

ESDSLogoff

public int ESDSLogoff(ESDSContext ctx)
               throws ESDSException

This method is called to log off. Must call ESDSLogon before this. This closes the connection pool if the caller type is APP or SERVER. For other caller types, it doesn't close the pool.

Parameters:

context - The caller's context

Returns:

status code

ESDSGetMailUserMetaData

public ESDSLdapObject ESDSGetMailUserMetaData(ESDSContext context,
                                              java.lang.String domain)
                                       throws ESDSException

This method returns the metadata for a mailuser. Must call ESDSLogon before this.

Parameters:

context - The caller's context

domain - The domain under which users will be created. for eg, for us.oracle.com

Returns:

mailuser metadata

ESDSLookupMailUser

public ESDSLdapObject ESDSLookupMailUser(ESDSContext ctx,
                                         java.lang.String mailId)
                                  throws ESDSException

This method looks up a mailuser. Must call ESDSLogon before this.

Parameters:

context - The caller's context

mailId - The fully qualified email id of the user

Returns:

ESDSLdapObject the mailuser (similar to metadata)

ESDSLookupMailUser

public ESDSLdapObject ESDSLookupMailUser(ESDSContext ctx,
                                         java.lang.String mailId,
                                         java.util.Vector attrsToFetch)
                                  throws ESDSException

This method looks up a mailuser. Must call ESDSLogon before this.

Parameters:

context - The caller's context

mailId - The fully qualified email id of the user

attrsToFetch - A vector of strings containing the name of attributes to be returned.

Returns:

ESDSLdapObject the mailuser (similar to metadata)

ESDSResolveEmailID

public java.lang.String ESDSResolveEmailID(ESDSContext ctx,
                                           java.lang.String mailId)
                                    throws ESDSException

This method resolves a mailID. Must call ESDSLogon before this.

Parameters:

context - The caller's context

mailId - The fully qualified email id of the user

Returns:

ESDSLdapObject the mailuser (similar to metadata)

ESDSGetEntriesManagedByUser

public ESDSLdapObject[] ESDSGetEntriesManagedByUser(ESDSContext ctx,
                                                    java.lang.String usermailid,
                                                    java.lang.String[] types,
                                                    java.util.Vector attrsToFetch)
                                             throws ESDSException

This API returns the list of entries the given mailuser owns for the given types. For example, in order to find out the DLs owned/managed (moderator/approver/editor etc.) by the given user or to find out the newsgroups or public folders owned by the user, this API can be used.

Parameters:

ctx - The authenticated ESDSContext

usermailid - fully qalified email id of the mailuser

types, - the types of entries to be searched for, null searchs for all types (dls, newsgroups and public folders currently) Pass ESDSConstants.DS_LIST to find out dls the user is owner/moderator/approver/editor of, ESDSConstants.DS_NEWSGROUP to find out news groups the user is owner/moderator of, ESDSConstants.DS_FOLDER to find out public folders the user is owner of

attrsToFetch - a vector containing list of attributes to fetch for the matching entries, when this is null, it fetches all attributes

Returns:

an array of ESDSLdapObject each representing matching entries owned/managed by the given user for the given types. Null, if user does not own or manage anything

ESDSCreateMailUser

public void ESDSCreateMailUser(ESDSContext context,
                               java.sql.Connection conn,
                               java.lang.String publicUser,
                               ESDSLdapObject mailuser,
                               int provisioningType)
                        throws ESDSException

Deprecated.

This method creates a mailuser in the directory and db. This method has been deprecated. Please user ESDSCreateMailUser that takes domain as an input

Parameters:

context - The caller's context

conn - The JDBC Connection

publicUser - Thepublic user dn

mailUser - The mail user data

provisioningType - The user provisioning type
0 both in DB and LDAP
1 in ldap and marks the orclobjectid in LDAP as -1
2 in DB alone and update the LDAP (here the ldap user has already been created), here the assumption is that the LDAP entry has already been created. In this case, the API expects that orclobjectid is LDAP user entry -1, in case it's not -1, it throws ESDSJ_DUPLICATE_ENTRY error. This option also overwrites the mailstore dn of the user.
3 if mailstore id won, user is created in ldap only and objectid marked as -1, the database records for the user are created during login and delivery by imap/smtp/ojma

Returns:

void

ESDSCreateMailUser

public void ESDSCreateMailUser(ESDSContext context,
                               java.sql.Connection conn,
                               java.lang.String publicUser,
                               java.lang.String domain,
                               ESDSLdapObject mailuser,
                               int provisioningType)
                        throws ESDSException

This method creates a mailuser in the directory and db.

Parameters:

context - The caller's context

conn - The JDBC Connection

publicUser - The public user dn

domain - The domain where user is to be created

mailUser - The mail user data

provisioningType - The user provisioning type
0 both in DB and LDAP
1 in ldap and marks the orclobjectid in LDAP as -1
2 in DB alone and update the LDAP (here the ldap user has already been created), here the assumption is that the LDAP entry has already been created. In this case, the API expects that orclobjectid is LDAP user entry -1, in case it's not -1, it throws ESDSJ_DUPLICATE_ENTRY error. This option also overwrites the mailstore dn of the user.
3 if mailstore id won, user is created in ldap only and objectid marked as -1, the database records for the user are created during login and delivery by imap/smtp/ojma

Returns:

void

ESDSSetUserObjectID

public void ESDSSetUserObjectID(ESDSContext userCtx,
                                long userid)
                         throws ESDSException

This method updates the orclobjectid of the user in case of on demand database record creation of user

Parameters:

userCtx - The mailuser context

userid - userid of the user

Returns:

void

ESDSCreateMailUser

public void ESDSCreateMailUser(ESDSContext context,
                               java.lang.String publicUser,
                               ESDSLdapObject mailuser,
                               int provisioningType)
                        throws ESDSException

Deprecated.

This method creates a mailuser in the directory and db. This method has been deprecated. Please user ESDSCreateMailUser that takes domain as an input

Parameters:

context - The caller's context

publicUser - Thepublic user dn

mailUser - The mail user data

provisioningType - The user provisioning type
0 both in DB and LDAP
1 in ldap and marks the orclobjectid in LDAP as -1
2 in DB alone and update the LDAP (here the ldap user has already been created), here the assumption is that the LDAP entry has already been created. In this case, the API expects that orclobjectid is LDAP user entry -1, in case it's not -1, it throws ESDSJ_DUPLICATE_ENTRY error. This option also overwrites the mailstore dn of the user.

Returns:

void

ESDSCreateMailUser

public void ESDSCreateMailUser(ESDSContext context,
                               java.lang.String publicUser,
                               java.lang.String domain,
                               ESDSLdapObject mailuser,
                               int provisioningType)
                        throws ESDSException

This method creates a mailuser in the directory and db.

Parameters:

context - The caller's context

publicUser - The public user dn

domain - The domain where user has to be created

mailUser - The mail user data

provisioningType - The user provisioning type
0 both in DB and LDAP
1 in ldap and marks the orclobjectid in LDAP as -1
2 in DB alone and update the LDAP (here the ldap user has already been created), here the assumption is that the LDAP entry has already been created. In this case, the API expects that orclobjectid is LDAP user entry -1, in case it's not -1, it throws ESDSJ_DUPLICATE_ENTRY error. This option also overwrites the mailstore dn of the user.

Returns:

void

ESDSDeleteMailUser

public void ESDSDeleteMailUser(ESDSContext ctx,
                               java.sql.Connection conn,
                               java.lang.String mailUser,
                               int provisioningType)
                        throws ESDSException

This method deletes a mailuser.

Parameters:

cxt - The caller's context

conn - The jdbc connection

mailUser - The mail user to be deleted

provisioningType - The user deprovisioning type
ESDSConstants.DELETE_FROM_LDAP - deletes all mailuser footprints from LDAP and mail store data stays for archiving. With this option, user shadow entry is created in the DeletedUsers container
ESDSConstants.DELETE_FROM_MAILSTORE - deletes mailuser data from mailstore and the shadow entry from deleteusers container. If the mailid to be deleted does not exist under DeletedUsers container, then an ESDSException is thrown with ESDSConstants.ESDSJ_NO_SUCH_USER error

Throws:

ESDSException -

ESDSDeleteMailUser

public void ESDSDeleteMailUser(ESDSContext ctx,
                               java.lang.String mailUser,
                               int provisioningType)
                        throws ESDSException

This method deletes a mailuser.

Parameters:

cxt - The caller's context

mailUser - The mail user to be deleted

provisioningType - The user deprovisioning type
ESDSConstants.DELETE_FROM_LDAP - deletes all mailuser footprints from LDAP and mail store data stays for archiving. With this option, user shadow entry is created in the DeletedUsers container
ESDSConstants.DELETE_FROM_MAILSTORE - deletes mailuser data from mailstore and the shadow entry from deleteusers container. If the mailid to be deleted does not exist under DeletedUsers container, then an ESDSException is thrown with ESDSConstants.ESDSJ_NO_SUCH_USER error

Throws:

ESDSException -

ESDSRenameUserEmail

public void ESDSRenameUserEmail(ESDSContext ctx,
                                java.lang.String oldmailId,
                                java.lang.String newmailId)
                         throws ESDSException

This method renames a mailuser. It changes the email id to the new email id updates the userid in all folders including shared and public folders, also updates all references to the old email address. If the ldap operation fails for some reasons half way, it marks the "orclMailCreationStatus" attribute value as "RenameInProgress". Also updates the mail id of public user

Parameters:

cxt - The caller's ESDS context. This must have been an authenticated context.

oldmailId - The old fully qualified emailid of the user to be renamed.

newmailId - The new fully qualified emailid of the user to be renamed.

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ESDSUpdatePubUserRefs

public void ESDSUpdatePubUserRefs(ESDSContext ctx,
                                  java.lang.String oldDN,
                                  java.lang.String newDN)
                           throws ESDSException

This method updates all public user references when a public user is renamed This API needs to be called by the admin whenever the public user is renamed This API queries and updates all the public user references to the new DN. This API is reentrant and can be called again if operation failed for some reason halfway.

Parameters:

cxt - The caller's ESDS context. This must have been an authenticated context.

oldDN - The old DN of the public user

newDN - The new DN of the public user

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception. This API requires the targetdn attribute to be indexed, if it's not indexed, an exception is thrown.

ESDSModifyMailUser

public void ESDSModifyMailUser(ESDSContext ctx,
                               java.lang.String mailId,
                               ESDSLdapObject mailUser)
                        throws ESDSException

This method modifies a mailuser in the directory.

Parameters:

cxt - The caller's context

mailId - The mailid of the user to be modified

mailUser - The new data for modification, please use modifyAttributeValue method of ESDSLdapObject to set the values for modification

Returns:

void

ESDSLookupMailProcessConfig

public ESDSLdapObject ESDSLookupMailProcessConfig(ESDSContext ctx,
                                                  java.lang.String host,
                                                  java.lang.String oraHome,
                                                  java.lang.String prodType,
                                                  java.util.Vector attrsToFetch)
                                           throws ESDSException

Deprecated.

This method looks up the mailprocessconfig object for the given host, oracle home and process type (email or um).

Parameters:

ctx - The caller's context

host - The host name

orahome - The full path for ORACLE_HOME

prodType - The product name. It's the name of the container that's created under "cn=oracle_home" in the process DIT. For, email it's going to be EMailServer (ESDSConstants.PROD_ES)

attrsToFetch - The list of attributes to be fetched - Vector of Strings null if all attributes are to be fetched

Returns:

the mailprocessconfig object attributes and metadata. Attributes can be retrieved as shown in the following example.
Example:
Vector values = ldapobj.getAttributeValue("cn") The values vector contains strings, which are values of the cn This is null if no value is set for the "cn" attribute

ESDSModifyMailProcessConfig

public void ESDSModifyMailProcessConfig(ESDSContext ctx,
                                        java.lang.String host,
                                        java.lang.String oraHome,
                                        java.lang.String prodType,
                                        ESDSLdapObject conf)
                                 throws ESDSException

Deprecated.

This method modifies the mailprocessconfig object for the given host, oracle home and process type (email or um).

Parameters:

ctx - The caller's context

host - The host name

orahome - The full path for ORACLE_HOME

prodType - The product name. It's the name of the container that's created under "cn=oracle_home" in the process DIT. For, email it's going to be EMailServer (ESDSConstants.PROD_ES)

conf - The list of attributes with modification type to be modified. The new data can be set using the modifyAttributeValue method of the ESDSLdapObject class. The caller needs to specify the type of modification.

Returns:

void

ESDSGetProcessMetaData

public ESDSLdapObject ESDSGetProcessMetaData(ESDSContext context,
                                             java.lang.String targetName)
                                      throws ESDSException

Deprecated.

This method returns the metadata for a Process. Must call ESDSLogon before this.

Parameters:

context - The caller's context

targetName - The targetname

Returns:

process metadata

ESDSGetAllInstances

public ESDSAttributeValueList[] ESDSGetAllInstances(ESDSContext context,
                                                    java.lang.String targetName)
                                             throws ESDSException

Deprecated.

This method returns all the instances for the given targetname. Must call ESDSLogon before this.

Parameters:

context - The caller's context

targetname - the target name

Returns:

instance attributes
orclmailinstanceid,orclmailstatusup

ESDSGetAllTargets

public java.util.Vector ESDSGetAllTargets(ESDSContext context,
                                          java.lang.String installationName)
                                   throws ESDSException

Deprecated.

This method returns all the targetnames for the given installation. Must call ESDSLogon before this.

Parameters:

context - The caller's context

installationname - the installation name

ESDSCreateProcess

public java.lang.String ESDSCreateProcess(ESDSContext ctx,
                                          java.lang.String targetName,
                                          ESDSLdapObject process)
                                   throws ESDSException

Deprecated.

This method creates a process instance in the directory. - Inherits default values from the default instance - Construct DN - If different values are given as input params for the new process, override the default values. - Add process - Modify the mailstore entry - Add entry to the ProcessInstance container for this installation

Parameters:

ctx - The caller's context

targetName - The process name

process - The Process object

Returns:

process dn

ESDSDeleteProcess

public void ESDSDeleteProcess(ESDSContext ctx,
                              java.lang.String processDN)
                       throws ESDSException

Deprecated.

This method deletes a process instance in the directory.

Parameters:

ctx - The caller's context

processDN - The Process DN

Returns:

void

ESDSModifyProcess

public void ESDSModifyProcess(ESDSContext ctx,
                              java.lang.String targetName,
                              ESDSLdapObject process)
                       throws ESDSException

Deprecated.

This method modifies a process instance in the directory. Also modifies the mailstore entry if mailstore attribute is changed

Parameters:

ctx - The caller's context

targetName - The process name

process - The Process object, please use modifyAttributeValue method of ESDSLdapObject to set the values for modification

Returns:

void

ESDSLookupProcessInstance

public ESDSLdapObject ESDSLookupProcessInstance(ESDSContext ctx,
                                                java.lang.String instanceDN)
                                         throws ESDSException

Deprecated.

This method modifies a process instance in the directory. Also modifies the mailstore entry if mailstore attribute is changed

Parameters:

ctx - The caller's context

targetName - The process name

process - The Process object, please use modifyAttributeValue method of ESDSLdapObject to set the values for modification

Returns:

the instance attributes and metadata

ESDSModifyProcessInstance

public void ESDSModifyProcessInstance(ESDSContext ctx,
                                      java.lang.String instanceDN,
                                      ESDSLdapObject process)
                               throws ESDSException

Deprecated.

This method modifies a process instance in the directory. Also modifies the mailstore entry if mailstore attribute is changed

Parameters:

ctx - The caller's context

instanceDN - The process DN

process - The Process object, please use modifyAttributeValue method of ESDSLdapObject to set the values for modification

Returns:

void

ESDSGetProcessInstanceDBPoolParams

public java.util.Hashtable ESDSGetProcessInstanceDBPoolParams(ESDSContext ctx,
                                                              java.lang.String instanceName,
                                                              java.lang.String mailStoreDn)
                                                       throws ESDSException

Deprecated.

This method returns db pool parameters for a process instance for a given mailstore.

Parameters:

ctx - The caller's context

instanceName - The process instance name, eg: hostname:installname:IMAP:12345

mailStoreDn - The dn of the mailstore which is being configured

Returns:

poolParams A hashtable for the DB connection pool parameters for this mailstore, key is the ldap attribute name (all lowercase) and value is an Integer. Possible ldap attributes are orclmailprocessdbminconn, orclmailprocessdbmaxconn, orclmailprocessdbincrconn and orclmaildbtimeout

ESDSConfigureProcessInstanceDBPool

public void ESDSConfigureProcessInstanceDBPool(ESDSContext ctx,
                                               java.lang.String instanceName,
                                               java.lang.String mailStoreDn,
                                               java.util.Hashtable poolParams)
                                        throws ESDSException

Deprecated.

This method modifies a process instance in the directory. Also modifies the mailstore entry if mailstore attribute is changed

Parameters:

ctx - The caller's context

instanceName - The process instance name, eg: hostname:installname:IMAP:12345

mailStoreDn - The dn of the mailstore which is being configured

poolParams - The DB connection pool parameters for this mailstore key is the ldap attribute name (all lowercase) and value is an Integer. Possible ldap attributes are orclmailprocessdbminconn, orclmailprocessdbmaxconn, orclmailprocessdbincrconn and orclmaildbtimeout

Returns:

void

ESDSGetInstallations

public java.util.Vector ESDSGetInstallations(ESDSContext ctx)
                                      throws ESDSException

This method returns the list of installations.

Parameters:

ctx - The caller's context

Returns:

Vector of installation names, null if none

ESDSGetDomains

public java.util.Vector ESDSGetDomains(ESDSContext ctx,
                                       java.lang.String installionName)
                                throws ESDSException

This method returns the list of domains for a given installation.

Parameters:

ctx - The caller's context

installationName - The name of the installation

Returns:

Vector of domains for the given installation name.

ESDSCreateDomain

public void ESDSCreateDomain(ESDSContext ctx,
                             java.lang.String installationName,
                             java.lang.String domainName,
                             java.lang.String parentDomain)
                      throws ESDSException

This method creates a domain object in the directory. Also creates the default containers

Parameters:

ctx - The caller's context

installationName - The installation name

domainName - The domain name

parentDomain - The parent domain name, if it's a top level domain, then "", if it's a subdomain, then the parent domain name, for eg, for us.oracle.com domain creation, while creating the com domain, this param value will be "", for oracle, it will be "com" and for us it will be "oracle.com"

Returns:

void

ESDSRepairCreatedDomain

public void ESDSRepairCreatedDomain(ESDSContext ctx,
                                    java.lang.String installationName,
                                    java.lang.String domainName,
                                    java.lang.String parentDomain)
                             throws ESDSException

This method completes the creation of a partially created email domain and the containers in the directory.

Parameters:

ctx - The caller's context

installationName - The installation name

domainName - The domain name

parentDomain - The parent domain name, if it's a top level domain, then "", if it's a subdomain, then the parent domain name, for eg, for us.oracle.com domain creation, while creating the com domain, this param value will be "", for oracle, it will be "com" and for us it will be "oracle.com"

Returns:

void

ESDSIsAPartiallyCreatedEntry

public boolean ESDSIsAPartiallyCreatedEntry(ESDSContext ctx,
                                            java.lang.String installationName,
                                            java.lang.String entryType,
                                            java.lang.String entryName)
                                     throws ESDSException

This method checks to see if the entry is a valid one or not.

Parameters:

ctx - The caller's context

installationName - The installation name

entryType - ESDSConstants.DS_DOMAIN for checking if domain is partially created or not. This is the only type supported in 9.0.2

entryName - The name of the entry, the domain name is entryType is ESDSConstants.DS_DOMAIN

Returns:

boolean true if the domain is partially created, false otherwise

ESDSDeleteDomain

public void ESDSDeleteDomain(ESDSContext ctx,
                             java.lang.String installationName,
                             java.lang.String domainName)
                      throws ESDSException

This method deletes the partially created email domain. This API requires that the partially created domain contains only entries a fresh newly created domain is supposed to have, in other word, it must be an empty domain with no users/DLs/shared folders/aliases/foreign entries in it. Also, the domain to be deleted should be the buttom most domain, for example, the domain oracle.com cannot be deleted if it contains a domain "us" (us.oracle.com) in it. Admin tool needs to take care of that fact that, if the domain com is partially created, then it should never let the user create a domain oracle.com underneath.

Parameters:

ctx - The caller's context

installationName - The installation name

domainName - The domain name

Returns:

void

ESDSGetDomainPreferences

public ESDSLdapObject ESDSGetDomainPreferences(ESDSContext ctx,
                                               java.lang.String installationName,
                                               java.lang.String domainName,
                                               java.lang.String preferenceType)
                                        throws ESDSException

This method returns the domain preferences depending on the type of pref.

Parameters:

ctx - The caller's context

installationName - The installation name

domainName - The domain name

preferenceType - The preference type, ESDSConstants.DS_USER or ESDSConstants.DS_LIST, ESDSConstants.DS_DOMAIN for domain

Returns:

the preference object metadata for the given type

ESDSModifyDomainPreferences

public void ESDSModifyDomainPreferences(ESDSContext ctx,
                                        java.lang.String installationName,
                                        java.lang.String domainName,
                                        java.lang.String preferenceType,
                                        ESDSLdapObject preferences)
                                 throws ESDSException

This method modifies the domain preferences for a domain in the directory.

Parameters:

ctx - The caller's context

installationName - The installation name

domainName - The complete domain name, for eg, oracle.com

preferenceType - The type of preference, ESDSConstants.DS_USER for mailuser, ESDSConstants.DS_LIST for list ESDSConstants.DS_DOMAIN for domain

preferences - The new set of preferences, please use modifyAttributeValue method of ESDSLdapObject to set the values for modification

Returns:

void

ESDSGetAllMailStores

public java.lang.String[] ESDSGetAllMailStores(ESDSContext ctx,
                                               java.lang.String installationName)
                                        throws ESDSException

This method returns all the mailstore dns for the given installation. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

installationname - the installation name

Returns:

an array of mailstore dns

ESDSGetAllMailStores

public java.lang.String[] ESDSGetAllMailStores(ESDSLdapHandle handle,
                                               java.lang.String installationName)
                                        throws ESDSException

ESDSGetMailStoreMetaData

public ESDSLdapObject ESDSGetMailStoreMetaData(ESDSContext ctx,
                                               java.lang.String mailstoredn)
                                        throws ESDSException

This method returns the metadata for the given Mailstore DN. Must call ESDSLogon before this.

Parameters:

context - The caller's context

mailstore - dn

Returns:

mailstore data and metadata

ESDSModifyMailStore

public void ESDSModifyMailStore(ESDSContext ctx,
                                java.lang.String mailStoreDN,
                                ESDSLdapObject mailStore)
                         throws ESDSException

This method modifies a mailstore object in the directory.

Parameters:

ctx - The caller's context

mailStoreDN - The Mailstore DN

mailStore - The mailstore attributes

Returns:

void

ESDSDeleteMailStore

public void ESDSDeleteMailStore(ESDSContext ctx,
                                java.lang.String installationName,
                                java.lang.String domainName,
                                java.lang.String mailStore)
                         throws ESDSException

This method deletes a mailstore object in the directory. Also delete this reference from everywhere

Parameters:

ctx - The caller's context

installationName - The installation name

domainName - The domain name

mailStore - The mailstore

Returns:

void

ESDSGetDLMetaData

public ESDSLdapObject ESDSGetDLMetaData(ESDSContext context,
                                        java.lang.String domain)
                                 throws ESDSException

This method returns the metadata for a DL Must call ESDSLogon before this.

Parameters:

context - The caller's context

Returns:

DL metadata

ESDSCreateDistributionList

public java.util.Hashtable ESDSCreateDistributionList(ESDSContext ctx,
                                                      ESDSLdapObject list,
                                                      boolean ifPrivate,
                                                      java.util.Hashtable members)
                                               throws ESDSException

Deprecated.

This method creates a distribution list object in the directory. The list can be a public list or a private list. If it's a public list, it gets created in the public part of the mailserver container. And if it's a private list, it will be created under the user's private addressbook. This API has been deprecated, please use the overloaded version of ESDSCreateDistributionList

Parameters:

ctx - The caller's context

list - The dl attributes and values, the mail attribute should contain the fully qualified mailid if a public dl

ifPrivate - true if a private list, false if a public list

members - The members of the list. The key of the hashtable is the type of member, it can be ESDSConstants.DS_USER for mailuser, DS_LIST for a list, DS_ALIAS for an alias, DS_UMATTR for phone no, sms, device id etc and DS_FOREIGN for the foreign entries. value is a vector of values.

Returns:

hashtable of elements that couldn't be added, key is type and value is a vector of values

ESDSCreateDistributionList

public java.util.Hashtable ESDSCreateDistributionList(ESDSContext ctx,
                                                      ESDSLdapObject list,
                                                      java.lang.String domain,
                                                      java.util.Hashtable members)
                                               throws ESDSException

This method creates a public distribution list object in the directory.

Parameters:

ctx - The caller's context

list - The dl attributes and values, the mail attribute should contain the fully qualified mailid if a public dl

domain - Name of the domain where DL is created

members - The members of the list. The key of the hashtable is the type of member, it can be ESDSConstants.DS_USER for mailuser, DS_LIST for a list, DS_ALIAS for an alias, DS_UMATTR for phone no, sms, device id etc and DS_FOREIGN for the foreign entries. value is a vector of values.

Returns:

hashtable of elements that couldn't be added, key is type and value is a vector of String values

Throws:

throws - error if owner mailid is invalid

ESDSLookupDistributionList

public ESDSLdapObject ESDSLookupDistributionList(ESDSContext ctx,
                                                 java.lang.String mailId)
                                          throws ESDSException

This method looks up a DL. Must call ESDSLogon before this.

Parameters:

context - The caller's context

mailId - The fully qualified email id of the DL

Returns:

ESDSLdapObject the DL (similar to metadata)

ESDSModifyDistributionList

public void ESDSModifyDistributionList(ESDSContext ctx,
                                       java.lang.String mailOrName,
                                       ESDSLdapObject list,
                                       boolean ifPrivate)
                                throws ESDSException

This method modifies a distribution list object in the directory.

Parameters:

ctx - The caller's context

mailOrName - The mailid of the list

list - The dl object

ifPrivate - if it's a private or a public list

Returns:

void

ESDSModifyDLMembers

public java.util.Vector ESDSModifyDLMembers(ESDSContext ctx,
                                            java.lang.String list,
                                            boolean ifPrivate,
                                            java.lang.String modificationType,
                                            java.lang.String memberType,
                                            java.util.Vector members)
                                     throws ESDSException

This method modifies the members of a dl.

Parameters:

ctx - The caller's context

list - The fully qualified email id of the dl if a public dl, and the dl name if a private dl

ifPrivate - true if a private list, false if a public list

members - The members of the list. The key of the hashtable is the type of member, it can be ESDSConstants.DS_USER for mailuser, DS_LIST for a list, DS_ALIAS for an alias, and DS_FOREIGN for the foreign entries. value is a vector of values.

Returns:

the list that couldn't be modified

ESDSDeleteDistributionList

public void ESDSDeleteDistributionList(ESDSContext ctx,
                                       java.lang.String listName,
                                       boolean ifPrivate)
                                throws ESDSException

This method deletes a dl. It also deletes all references.

Parameters:

ctx - The caller's context

listName - The fully qualified emailid of the DL

ifPrivate - true if a private list, false if a public list

Returns:

void

ESDSSearchMembersInDL

public java.util.Hashtable ESDSSearchMembersInDL(ESDSContext ctx,
                                                 java.lang.String dlEmailID,
                                                 java.lang.String memberQueryString,
                                                 java.lang.String memberType,
                                                 int sizeLimit,
                                                 java.util.Vector attrsToFetch)
                                          throws ESDSException

This method looks up the given list, resolves it and returns only the members matching the query criteria. The piecewise fetches hold on to the ldap connection. Hence, while using this feature, it's suggested to use a dedicated context (which does not interfere with the app connection pool). Note: The member search criteria is not applied to sub dls.

Parameters:

ctx - The caller's context

dlEmailID - The fully qualified email address of the dl.

memberQueryString - The query string for member search, "*" if all members are to be fetched.

memberType - The type of member to search for ESDSConstants.DS_USER, ESDSConstants.DS_LIST, ESDSConstants.DS_ALIAS ESDSConstants.DS_FOREIGN When member type is null, it fetches all members

sizeLimit - The no of results to be returned per iteration, if this is 0, then it retrieves all

attrsToFetch - Vector of Strings containing member attribute names that are to be fetched. Null means fetch all member attributes

Returns:

Hashtable containing list of resolved members for the DL and their attributes. The keys for the hashtable would be the attribute types, ESDSConstants. DS_USER, ESDSConstants.DS_LIST, ESDSConstants.DS_ALIAS and values would be Vector of ESDSLdapObject, where each one represents a member. null if no matching members are found

ESDSSearchMembersInDL

public java.util.Hashtable ESDSSearchMembersInDL(ESDSContext ctx,
                                                 java.lang.String dlEmailID,
                                                 java.lang.String memberQueryString,
                                                 java.lang.String memberType,
                                                 int sizeLimit)
                                          throws ESDSException

This method looks up the given list, resolves it and returns only the members matching the query criteria. The piecewise fetches hold on to the ldap connection. Hence, while using this feature, it's suggested to use a dedicated context (which does not interfere with the app connection pool). Note: The member search criteria is not applied to sub dls. This API returns both active and inacive members

Parameters:

ctx - The caller's context

dlEmailID - The fully qualified email address of the dl.

memberQueryString - The query string for member search, "*" if all members are to be fetched.

memberType - The type of member to search for ESDSConstants.DS_USER, ESDSConstants.DS_LIST, ESDSConstants.DS_ALIAS ESDSConstants.DS_FOREIGN When member type is null, it fetches all members

sizeLimit - The no of results to be returned per iteration, if this is 0, then it retrieves all

Returns:

Hashtable containing list of resolved members for the DL. The keys for the hashtable would be the attribute types, ESDSConstants. DS_USER, ESDSConstants.DS_LIST, ESDSConstants.DS_ALIAS, ESDSConstants.DS_FOREIGN and values would be Vector of String containing email ids of members (name in case of alias). null if no matching members are found

ESDSGetAliasMetaData

public ESDSLdapObject ESDSGetAliasMetaData(ESDSContext ctx,
                                           java.lang.String domain)
                                    throws ESDSException

This method returns the metadata for a DL Must call ESDSLogon before this.

Parameters:

context - The caller's context

domain - The domain name, eg us.oracle.com

Returns:

alias metadata

ESDSCreatePublicAlias

public void ESDSCreatePublicAlias(ESDSContext ctx,
                                  ESDSLdapObject alias,
                                  java.lang.String domain)
                           throws ESDSException

ESDSModifyPublicAlias

public void ESDSModifyPublicAlias(ESDSContext ctx,
                                  java.lang.String aliasName,
                                  java.lang.String domain,
                                  ESDSLdapObject alias)
                           throws ESDSException

This method modifies an alias object in the directory.

Parameters:

ctx - The caller's context

aliasName - The alias alias

domain - The domain name

alias - The alias object please use modifyAttributeValue method of ESDSLdapObject to set the values for modification

Returns:

void

ESDSSearchPublicAliases

public java.lang.String[] ESDSSearchPublicAliases(ESDSContext ctx,
                                                  java.lang.String searchCriteria,
                                                  java.lang.String domain)
                                           throws ESDSException

This method searches for public aliases for the given domain depending on the search criteria.

Parameters:

ctx - The caller's context

searchCriteria - * for all, a* for alias names starting with a and so on

domain - The domain in which the search is to be performed

Returns:

String[] containing the name of the aliases, null if the search result is empty

ESDSSearchPublicAliases

public java.util.Vector ESDSSearchPublicAliases(ESDSContext ctx,
                                                java.lang.String query,
                                                java.lang.String domainName,
                                                int sizeLimit)
                                         throws ESDSException

This method searches for public aliases for the given domain depending on the search criteria.

Parameters:

ctx - The caller's context

query - * for all, a* for alias names starting with a and so on

domainName - The domain in which the search is to be performed

sizeLimit - The no of results to be returned per iteration, if this is 0 or -1, then it retrieves all

Returns:

a vector of ESDSAttributeValueList This returns all attributes

ESDSSearchPublicAliases

public java.util.Vector ESDSSearchPublicAliases(ESDSContext ctx,
                                                java.lang.String query,
                                                java.lang.String domainName,
                                                int sizeLimit,
                                                java.lang.String sortingAttr,
                                                java.util.Vector attrsToFetch)
                                         throws ESDSException

This method searches for public aliases for the given domain depending on the search criteria.

Parameters:

ctx - The caller's context

query - * for all, a* for alias names starting with a and so on

domainName - The domain in which the search is to be performed

sizeLimit - The no of results to be returned per iteration, if this is 0 or -1, then it retrieves all

sortingAttr - The name attribute for which results are to be sorted, this will be using server side sorting feature (provided server side ldap sorting is supported by OID). null implies no sorting

attrsToFetch - a vector containing list of attributes to fetch, when this is null, it fetches everything

Returns:

a vector of ESDSAttributeValueList

ESDSLookupPublicAlias

public ESDSLdapObject ESDSLookupPublicAlias(ESDSContext ctx,
                                            java.lang.String aliasName,
                                            java.lang.String domain)
                                     throws ESDSException

This method looks up an alias object in the directory for the given domain.

Parameters:

ctx - The caller's context

aliasName - The alias

domain - The domain in which the alias is to be looked up

Returns:

void

ESDSDeletePublicAlias

public void ESDSDeletePublicAlias(ESDSContext ctx,
                                  java.lang.String aliasName,
                                  java.lang.String domain)
                           throws ESDSException

This method deletes an alias object in the directory. Also deletes the references

Parameters:

ctx - The caller's context

aliasName - The alias

Returns:

void

ESDSGetContactInfoMetaData

public ESDSLdapObject ESDSGetContactInfoMetaData(ESDSContext ctx)
                                          throws ESDSException,
                                                 javax.naming.NamingException

Deprecated.

This method will return the list of mandatory and optional attributes for the contactinfo entry and the metadata associated with the contact info object (the attribute name, syntax etc.).

Parameters:

ctx: - The mailuser context.

ESDSCreateContactInfo

public void ESDSCreateContactInfo(ESDSContext ctx,
                                  ESDSLdapObject contactinfo)
                           throws ESDSException,
                                  javax.naming.NamingException

Deprecated.

This method will create a contact info in the directory. This method would fill in the owner attribute. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

contactinfo: - The contact info object, this will contain the contactinfo attributes and values.

ESDSModifyContactInfo

public void ESDSModifyContactInfo(ESDSContext ctx,
                                  ESDSLdapObject contactinfo)
                           throws ESDSException,
                                  javax.naming.NamingException

Deprecated.

This method will modify the given contact info in the directory.

Parameters:

ctx: - The mailuser context.

contactinfo: - The contact info object, this will contain the contactinfo attributes and values. Use modifyAttributeValue method of In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name". ESDSLdapObject to set the values for modification and the modification type.

ESDSDeleteContactInfo

public void ESDSDeleteContactInfo(ESDSContext ctx,
                                  java.lang.String contactName)
                           throws ESDSException,
                                  javax.naming.NamingException

Deprecated.

This method will delete the given contact info and it's refrences in other private DL's.In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

contactName: - The name of the contact to be deleted.

ESDSGetContacts

public java.lang.String[] ESDSGetContacts(ESDSContext ctx)
                                   throws ESDSException,
                                          javax.naming.NamingException

Deprecated.

This method retrieves all Contacts for the given user.In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

Returns:

the name of contacts

ESDSGetContacts

public java.lang.String[] ESDSGetContacts(ESDSContext ctx,
                                          java.lang.String searchCriteria)
                                   throws ESDSException,
                                          javax.naming.NamingException

Deprecated.

This method retrieves all Contacts for the given user for the given search criteria. The search criteria will be the ldap filter. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

Returns:

the name of contacts

ESDSQueryContacts

public ESDSLdapObject[] ESDSQueryContacts(ESDSContext ctx,
                                          java.lang.String searchCriteria,
                                          java.util.Vector attrsToFetch)
                                   throws ESDSException

Deprecated.

This method retrieves all Contacts for the given user for the given search criteria. The search criteria will be the ldap filter. It fetches the values of attributes in attrsToFetch. When attrsToFetch is null, it retrieves all attributes. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

searchCriteria: - The ldap search filter (name=* for all contacts)

attrsToFetch: - Vector of Strings containing name of attributes whose value is to be fetched.

Returns:

the attribute/values of contacts

ESDSLookupContact

public ESDSLdapObject ESDSLookupContact(ESDSContext ctx,
                                        java.lang.String contactName)
                                 throws ESDSException,
                                        javax.naming.NamingException

Deprecated.

This method retrieves all attributes of the given contact. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

Returns:

the contact attributes, null if not found

ESDSGetPrivateListMetaData

public ESDSLdapObject ESDSGetPrivateListMetaData(ESDSContext ctx)
                                          throws ESDSException,
                                                 javax.naming.NamingException

Deprecated.

This method will return the list of mandatory and optional attributes for the contactinfo entry and the metadata associated with the contact info object (the attribute name, syntax etc.).

Parameters:

ctx: - The mailuser context.

ESDSCreatePrivateList

public void ESDSCreatePrivateList(ESDSContext ctx,
                                  ESDSLdapObject list)
                           throws ESDSException,
                                  javax.naming.NamingException

Deprecated.

This method will create a private list in the directory. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

list: - The list object, this will contain the list attributes and values.

ESDSModifyPrivateList

public void ESDSModifyPrivateList(ESDSContext ctx,
                                  ESDSLdapObject list)
                           throws ESDSException,
                                  javax.naming.NamingException

Deprecated.

This method will modify the given private list.In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

list: - The list object, this will contain the contactinfo attributes and values. Use modifyAttributeValue method of ESDSLdapObject to set the values for modification and the modification type.

ESDSDeletePrivateList

public void ESDSDeletePrivateList(ESDSContext ctx,
                                  java.lang.String list)
                           throws ESDSException,
                                  javax.naming.NamingException

Deprecated.

This method will delete the given private list and it's refrences in other private DL's. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

list: - The name of the contact to be deleted.

ESDSGetPrivateLists

public java.lang.String[] ESDSGetPrivateLists(ESDSContext ctx)
                                       throws ESDSException,
                                              javax.naming.NamingException

Deprecated.

This method retrieves all private lists for the given user. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

Returns:

the name of contacts

ESDSGetPrivateLists

public java.lang.String[] ESDSGetPrivateLists(ESDSContext ctx,
                                              java.lang.String searchCriteria)
                                       throws ESDSException,
                                              javax.naming.NamingException

Deprecated.

This method retrieves all private lists for the given user for the given search criteria. The search criteria will be the ldap filter. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

Returns:

the name of contacts

ESDSLookupPrivateList

public ESDSLdapObject ESDSLookupPrivateList(ESDSContext ctx,
                                            java.lang.String listName)
                                     throws ESDSException,
                                            javax.naming.NamingException

Deprecated.

This method retrieves all attributes of the given list. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

Returns:

the name of list

ESDSQueryPrivateLists

public ESDSLdapObject[] ESDSQueryPrivateLists(ESDSContext ctx,
                                              java.lang.String searchCriteria,
                                              java.util.Vector attrsToFetch)
                                       throws ESDSException

Deprecated.

This method retrieves all Private Lists for the given user for the given search criteria. The search criteria will be the ldap filter. It fetches the values of attributes in attrsToFetch. When attrsToFetch is null, it retrieves all attributes. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

searchCriteria: - The ldap search filter (name=* for all Lists)

attrsToFetch: - Vector of Strings containing name of attributes whose value is to be fetched.

Returns:

the attribute/values of lists

ESDSResolvePrivateList

public ESDSMemberList ESDSResolvePrivateList(ESDSContext ctx,
                                             java.lang.String listName,
                                             java.lang.String resolutionType)
                                      throws ESDSException,
                                             javax.naming.NamingException

Deprecated.

This API would resolve the list to the given resolution type. If it contains other aliases and dls, it would resolve the aliases and dls too. The memberlist returned would contain the resolved and unresolved entries. In order to address backward compatibility issue [name is no longer mandatory in 905, when system property oracle.mail.addressbook.mapnametoid is set to "true", "orcladdressbookid" will be returned for "name".

Parameters:

ctx: - The mailuser context.

listName: - The name of the list to be resolved

resolutionType: - The resolution type, which is the attribute name

Returns:

the list of resolved and unresolved entries.

ESDSCreateRule

public void ESDSCreateRule(ESDSContext ctx,
                           java.lang.String ruleType,
                           java.lang.String instalOrDomainOrEmail,
                           java.util.Vector ruleData)
                    throws ESDSException

This method creates a Rule object in the directory.

Parameters:

ctx - The caller's context

ruleType - Type of the rule, ESDSConstants.DS_DOMAIN for domain rules, ESDSConstants.DS_INSTALLATION for installation rules, ESDSConstants.DS_USER for user rules

instalOrDomainName - The installation name if a installation rule the domain name if a domain rule, eg. us.oracle.com and the fully qualified email id of the user if a user rule.

ruleData - The rule data

Returns:

void

ESDSModifyRule

public void ESDSModifyRule(ESDSContext ctx,
                           java.lang.String ruleType,
                           java.lang.String instalOrDomainOrEmail,
                           java.util.Vector ruleData)
                    throws ESDSException

This method modifies an existing rule object in the directory.

Parameters:

ctx - The caller's context

ruleType - Type of the rule, ESDSConstants.DS_DOMAIN for domain rules, ESDSConstants.DS_INSTALLATION for installation rules, ESDSConstants.DS_USER for user rules

instalOrDomainOrEmail - The installation name if a installation rule the domain name if a domain rule, eg. us.oracle.com and the fully qualified email id of the user if a user rule.

ruleData - The new rule data. The old rule data will be replaced by this one.

Returns:

void

ESDSDeleteRule

public void ESDSDeleteRule(ESDSContext ctx,
                           java.lang.String ruleType,
                           java.lang.String instalOrDomainOrEmail)
                    throws ESDSException

This method deletes an existing rule object in the directory.

Parameters:

ctx - The caller's context

ruleType - Type of the rule, ESDSConstants.DS_DOMAIN for domain rules, ESDSConstants.DS_INSTALLATION for installation rules, ESDSConstants.DS_USER for user rules

instalOrDomainOrEmail - The installation name if a installation rule the domain name if a domain rule, eg. us.oracle.com and the fully qualified email id of the user if a user rule.

Returns:

void

ESDSGetRule

public java.util.Hashtable ESDSGetRule(ESDSContext ctx,
                                       java.lang.String ruleType,
                                       java.lang.String instalOrDomainOrEmail)
                                throws ESDSException

This method modifies an existing rule object in the directory.

Parameters:

ctx - The caller's context

ruleType - Type of the rule, ESDSConstants.DS_DOMAIN for domain rules, ESDSConstants.DS_INSTALLATION for installation rules, ESDSConstants.DS_USER for user rules

instalOrDomainOrEmail - The installation name if a installation rule the domain name if a domain rule, eg. us.oracle.com and the fully qualified email id of the user if a user rule.

Returns:

Hashtable containing the rule data (key is ESDSConstants.DS_RULE value is a Vector of Strings) and the mailstore dn's (key is ESDSConstants.DS_MAILSTORE and value is a Vector of Strings). If there is no rule, then the hashtable contains only the mailstore dn's

ESDSGetDBUserID

public int ESDSGetDBUserID(ESDSContext ctx,
                           java.lang.String mailid)
                    throws ESDSException

This method returns the database userid of an email user.

Parameters:

ctx - The caller's context

mailid - The fully qualified email id of the mailuser

Returns:

int The DB userid

ESDSGetProcessDBParams

public ESDSAttributeValueList[] ESDSGetProcessDBParams(ESDSContext context,
                                                       java.util.Vector mailstoredns)
                                                throws ESDSException

This method returns the mailstore attributes for a process. Must call ESDSLogon before this.

Parameters:

context - The caller's context

mailstoredns - Vector containing mailstore dn's

Returns:

attribute values for each mailstore

ESDSGetMailUserDBParams

public ESDSAttributeValueList ESDSGetMailUserDBParams(ESDSContext context)
                                               throws ESDSException

This method returns the mailstore attributes for a mailuser. Must call ESDSLogon before this.

Parameters:

context - The caller's context

Returns:

attribute values for user's mailstore

ESDSLookupMailStore

public ESDSAttributeValueList ESDSLookupMailStore(ESDSContext ctx,
                                                  java.lang.String mailstoredn)
                                           throws ESDSException

This method returns the mailstore attributes for the given mailstoredn. Must call ESDSLogon before this.

Parameters:

ctx - The caller's context

mailstoredn - The mailstore dn

Returns:

the mailstore attribute and values

ESDSGetMailstoreDBNames

public java.lang.String[] ESDSGetMailstoreDBNames(ESDSContext ctx,
                                                  java.lang.String installation)
                                           throws ESDSException

This method creates returns the list of global database names for a given installation.

Parameters:

ctx - The caller's DS context. This must have been an authenticated context.

installation - The installation name

Returns:

an array of global database names

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ESDSGetMailstoreInfo

public java.lang.String[] ESDSGetMailstoreInfo(ESDSContext ctx,
                                               java.lang.String installation,
                                               java.lang.String globaldbname)
                                        throws ESDSException

This method returns the mailstore info for a given installation and global database name. The first element of the array is the SID, 2nd one is the username, 3rd one is the password, 4th one is the db host and 5th one is the db port.

Parameters:

ctx - The caller's DS context. This must have been an authenticated context.

installation - The installation name

globaldbname - The global database name

Returns:

an array of strings

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ESDSGetMailstoreGuestConnectInfo

public java.lang.String[] ESDSGetMailstoreGuestConnectInfo(ESDSContext ctx,
                                                           java.lang.String mailstoreDN)
                                                    throws ESDSException

This method returns the mailstore connect info for a given mailstoredn. The first element of the array is the username, 2nd one is the password, and the 3rd one is the DB connect string. This database user is a less privileged user (not es_mail).

Parameters:

ctx - The caller's DS context. This must have been an authenticated context.

mailstoreDN - The DN of the mailstore

Returns:

an array of strings

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ESDSGetMailstoreConnectString

public java.lang.String[] ESDSGetMailstoreConnectString(ESDSContext ctx,
                                                        java.lang.String mailstoreDN)
                                                 throws ESDSException

This method returns the mailstore connect info for a given mailstoredn. The first element of the array is the username, 2nd one is the password, and the 3rd one is the DB connect string.

Parameters:

ctx - The caller's DS context. This must have been an authenticated context.

mailstoreDN - The DN of the mailstore

Returns:

an array of strings

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

ESDSGetMailstoreConnectString

public java.lang.String[] ESDSGetMailstoreConnectString(ESDSContext ctx,
                                                        java.lang.String installation,
                                                        java.lang.String globaldbname)
                                                 throws ESDSException

This method returns the mailstore connect info for a given mailstore. The first element of the array is the username, 2nd one is the password, and the 3rd one is the DB connect string.

Parameters:

ctx - The caller's DS context. This must have been an authenticated context.

installation - The installation name

globaldbname - The global database name

Returns:

an array of strings

Throws:

ESDSException - Throws ESDSException if any error is encountered. The getMessage method can be used to retrieve error message from this exception.

modifyNestedDlParentAttr

public void modifyNestedDlParentAttr(ESDSContext ctx,
                                     java.lang.String modificationType,
                                     java.lang.String listDN,
                                     java.util.Vector parentsDlDNAttrList)
                              throws ESDSException

inheritDefaultValues

public ESDSAttributeValueList inheritDefaultValues(ESDSLdapHandle handle,
                                                   java.util.Vector parentDNs,
                                                   java.lang.String entryType)

getParentDomains

public java.util.Vector getParentDomains(ESDSLdapHandle handle,
                                         java.lang.String domain,
                                         java.lang.String installdn)
                                  throws ESDSException

ESDSGetAllSubscribers

public java.util.Hashtable ESDSGetAllSubscribers(ESDSContext ctx)
                                          throws ESDSException

ESDSGetPublicGroups

public java.util.Hashtable ESDSGetPublicGroups(ESDSContext ctx,
                                               java.lang.String SearchCriteria,
                                               java.lang.String SubscriberDN)
                                        throws ESDSException

ESDSGetPublicGroupsNotProvisioned

public java.util.Hashtable ESDSGetPublicGroupsNotProvisioned(ESDSContext ctx,
                                                             java.lang.String SubscriberDN)
                                                      throws ESDSException

ESDSPublicGroupsAlreadyProvisioned

public java.util.Hashtable ESDSPublicGroupsAlreadyProvisioned(ESDSContext ctx,
                                                              java.lang.String SubscriberDN)
                                                       throws ESDSException

ESDSGetPublicGroupsNotProvisioned

public java.util.Hashtable ESDSGetPublicGroupsNotProvisioned(ESDSContext ctx,
                                                             java.lang.String SubscriberDN,
                                                             java.lang.String cnFilter)
                                                      throws ESDSException

ESDSPublicGroupsAlreadyProvisioned

public java.util.Hashtable ESDSPublicGroupsAlreadyProvisioned(ESDSContext ctx,
                                                              java.lang.String SubscriberDN,
                                                              java.lang.String mailcnFilter)
                                                       throws ESDSException

ESDSProvisionOIDGrpForMail

public void ESDSProvisionOIDGrpForMail(ESDSContext ctx,
                                       java.lang.String domain,
                                       java.lang.String oidGrpDN,
                                       ESDSLdapObject Attrs,
                                       boolean ifExists)
                                throws ESDSException

ESDSDeProvisionOIDGrp

public void ESDSDeProvisionOIDGrp(ESDSContext ctx,
                                  java.lang.String domain,
                                  java.lang.String grpMailid)
                           throws ESDSException

ESDSLookupDomain

public ESDSLdapObject ESDSLookupDomain(ESDSContext ctx,
                                       java.lang.String domain)
                                throws ESDSException

This method will lookup a given domain name and return an ESDSLdapObject.

Parameters:

ctx - ESDSContext

domain - Name of the domain

Returns:

ESDSLdapObject representing the domain

Throws:

ESDSException - if any error occurs