oracle.mail.ldap
Class ESDSUtil

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

public final class ESDSUtil

extends java.lang.Object

This class contains utilities reqd for ESDS.

Field Summary

static int	DB_ONLY
static int	LDAP_AND_DB
static int	LDAP_AND_DB_IF_UP
static int	LDAP_ONLY

Constructor Summary

ESDSUtil()

Method Summary

static void	changeCreationStatus(ESDSDirServerAccess acc, ESDSContext ctx, java.lang.String dn, java.lang.String newStatus, java.lang.String modType) Changes the creation status attribute of the given entry to the given value.
static boolean	containsSpecialCharsInDN(java.lang.String dn) Deprecated.
static javax.naming.Name	convertStrToJNDIName(java.lang.String str)
static java.lang.String[]	convertToStringArray(java.util.Vector vect)
static java.util.Vector	convertToVector(java.lang.String[] arr)
void	createUser(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, java.sql.Connection dbconn, java.lang.String publicuserdn, java.lang.String publicuserGUID, ESDSAddData mailuser, java.lang.String domain, int operationType, boolean debugMode, boolean baseusermod) Creates a mailuser.
void	createUserValidation(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, ESDSAddData data, java.lang.String domain, int provisioningType, boolean debugMode)
void	deleteUser(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, ESDSAttributeValueList user, boolean debugMode, boolean baseusermod) Deletes a mailuser and cleans up all user references.
void	deleteUserValidation(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, ESDSAttributeValueList user, boolean debugMode)
static boolean	equalVector(java.util.Vector vect1, java.util.Vector vect2) Checks if two vectors are equal assuming that all elements are String objects.
static java.lang.String	escapeSpecialCharsInFilter(java.lang.String fltr) This method escapes the special character in the value part of the filter as per ldap rfc.
static java.lang.String	getNamingAttrVal(ESDSDirServerAccess acc, ESDSContext ctx, java.lang.String dn)
static java.lang.String	getNamingAttrVal(java.lang.String dn) Deprecated.
static java.lang.String	getParentDN(java.lang.String dn)
static void	handleDeprovRepovEvent(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, java.lang.String mailid, boolean debugMode)
static boolean	ifDeprovRepovEvent(ESDSAttributeValueList user)
void	ifDuplicateMailid(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, java.lang.String mailid, boolean debugMode)
static boolean	isSpecialChar(char c)
static java.lang.String	jndiSpCharEsp(java.lang.String dn) Deprecated.
static void	modifyUser(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, ESDSAttributeValueList mailuser, ESDSModifyData usermoddata) Modifies the given a mailuser.
static java.lang.String	normalizeDN(java.lang.String str)
static java.lang.String	quoteSpecialCharsInDN(java.lang.String dn) Deprecated. This checks only the rdn and escapes any special character present in rdn portion of the dn.
static java.lang.String	quoteSpecialCharsInName(java.lang.String attrVal)
static java.lang.String	removeJndiSpCharEsp(java.lang.String dn)
void	renameUser(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, java.sql.Connection dbconn, ESDSAttributeValueList mailuser, java.lang.String newmailId, boolean debugMode, boolean baseusermode) Renames the given a mailuser.
void	renameUserValidation(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, ESDSAttributeValueList mailuser, java.lang.String newmailId, boolean debugMode)
void	updateBaseUserRef(ESDSDirServerAccess access, ESDSLdapHandle ldapconn, java.lang.String oldDN, java.lang.String newDN, boolean debugMode) Updates the baseuser reference for the given mailuser.
static boolean	vectorContains(java.util.Vector vect, java.lang.String val)

Methods inherited from class java.lang.Object

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

Field Detail

LDAP_AND_DB

public static final int LDAP_AND_DB

LDAP_ONLY

public static final int LDAP_ONLY

DB_ONLY

public static final int DB_ONLY

LDAP_AND_DB_IF_UP

public static final int LDAP_AND_DB_IF_UP

Constructor Detail

ESDSUtil

public ESDSUtil()

Method Detail

vectorContains

public static boolean vectorContains(java.util.Vector vect,
                                     java.lang.String val)

normalizeDN

public static java.lang.String normalizeDN(java.lang.String str)

convertToStringArray

public static java.lang.String[] convertToStringArray(java.util.Vector vect)

convertToVector

public static java.util.Vector convertToVector(java.lang.String[] arr)

equalVector

public static boolean equalVector(java.util.Vector vect1,
                                  java.util.Vector vect2)

Checks if two vectors are equal assuming that all elements are String objects. Case is ignored when comparing the String objects.

changeCreationStatus

public static void changeCreationStatus(ESDSDirServerAccess acc,
                                        ESDSContext ctx,
                                        java.lang.String dn,
                                        java.lang.String newStatus,
                                        java.lang.String modType)

Changes the creation status attribute of the given entry to the given value. This can be used to add, replace or delete the value of the attribute.

getParentDN

public static java.lang.String getParentDN(java.lang.String dn)

isSpecialChar

public static boolean isSpecialChar(char c)

quoteSpecialCharsInName

public static java.lang.String quoteSpecialCharsInName(java.lang.String attrVal)

escapeSpecialCharsInFilter

public static java.lang.String escapeSpecialCharsInFilter(java.lang.String fltr)

This method escapes the special character in the value part of the filter as per ldap rfc. Any layer constructing filters must invoke this API For example, if you are constructing a filter as "mail=" + user_mailid, then you should use this API as "mail=" + escapeSpecialCharsInFilter(user_mailid). If your filter is "mail=" + val + "*", then you need to call it as "mail=" + escapeSpecialCharsInFilter(val) + "*"

quoteSpecialCharsInDN

public static java.lang.String quoteSpecialCharsInDN(java.lang.String dn)

Deprecated. This checks only the rdn and escapes any special character present in rdn portion of the dn.

getNamingAttrVal

public static java.lang.String getNamingAttrVal(java.lang.String dn)

Deprecated.

getNamingAttrVal

public static java.lang.String getNamingAttrVal(ESDSDirServerAccess acc,
                                                ESDSContext ctx,
                                                java.lang.String dn)
                                         throws ESDSException

containsSpecialCharsInDN

public static boolean containsSpecialCharsInDN(java.lang.String dn)

Deprecated.

jndiSpCharEsp

public static java.lang.String jndiSpCharEsp(java.lang.String dn)

Deprecated.

removeJndiSpCharEsp

public static java.lang.String removeJndiSpCharEsp(java.lang.String dn)

createUser

public void createUser(ESDSDirServerAccess access,
                       ESDSLdapHandle ldapconn,
                       java.sql.Connection dbconn,
                       java.lang.String publicuserdn,
                       java.lang.String publicuserGUID,
                       ESDSAddData mailuser,
                       java.lang.String domain,
                       int operationType,
                       boolean debugMode,
                       boolean baseusermod)
                throws java.lang.Exception

Creates a mailuser. Validations are performed outside this API

Parameters:

ldapconn - JNDI connection

dbconn - JDBC connection

publicuserdn - public user dn

mailuser - mailuser attributes

domain - Email domain

operationType -
ESDSUtil.LDAP_AND_DB Both in DB and LDAP, if mailstore is down, error out
ESDSUtil.LDAP_AND_DB_IF_UP Both in DB and LDAP, if mailstore is down, mark orclobjectid to -1
ESDSUtil.LDAP_ONLY Only in LDAP and mark orclobjectid to -1
ESDSUtil.DB_ONLY Only in mailstore and update orclobjectid. This expects entry in LDAP to exist

deleteUser

public void deleteUser(ESDSDirServerAccess access,
                       ESDSLdapHandle ldapconn,
                       ESDSAttributeValueList user,
                       boolean debugMode,
                       boolean baseusermod)
                throws ESDSException

Deletes a mailuser and cleans up all user references.

Parameters:

dirctx - JNDI connection

mailuser - mailuser attributes

user - original user attr/val list

debugMode - debug flag

baseusermod - flag indicating if baseuser mail att mod is reqd or not

modifyUser

public static void modifyUser(ESDSDirServerAccess access,
                              ESDSLdapHandle ldapconn,
                              ESDSAttributeValueList mailuser,
                              ESDSModifyData usermoddata)
                       throws ESDSException

Modifies the given a mailuser.

Parameters:

dirctx - JNDI connection

mailuser - mailuser attributes

renameUser

public void renameUser(ESDSDirServerAccess access,
                       ESDSLdapHandle ldapconn,
                       java.sql.Connection dbconn,
                       ESDSAttributeValueList mailuser,
                       java.lang.String newmailId,
                       boolean debugMode,
                       boolean baseusermode)
                throws ESDSException

Renames the given a mailuser.

Parameters:

dirctx - JNDI connection

dbconn - JDBC connection

mailuser - mailuser attributes

newmailid - new email id

updateBaseUserRef

public void updateBaseUserRef(ESDSDirServerAccess access,
                              ESDSLdapHandle ldapconn,
                              java.lang.String oldDN,
                              java.lang.String newDN,
                              boolean debugMode)
                       throws ESDSException

Updates the baseuser reference for the given mailuser.

Parameters:

olddn - Old baseuser dn

newdn - new baseuser dn

createUserValidation

public void createUserValidation(ESDSDirServerAccess access,
                                 ESDSLdapHandle ldapconn,
                                 ESDSAddData data,
                                 java.lang.String domain,
                                 int provisioningType,
                                 boolean debugMode)
                          throws ESDSException

deleteUserValidation

public void deleteUserValidation(ESDSDirServerAccess access,
                                 ESDSLdapHandle ldapconn,
                                 ESDSAttributeValueList user,
                                 boolean debugMode)
                          throws ESDSException

renameUserValidation

public void renameUserValidation(ESDSDirServerAccess access,
                                 ESDSLdapHandle ldapconn,
                                 ESDSAttributeValueList mailuser,
                                 java.lang.String newmailId,
                                 boolean debugMode)
                          throws ESDSException

ifDuplicateMailid

public void ifDuplicateMailid(ESDSDirServerAccess access,
                              ESDSLdapHandle ldapconn,
                              java.lang.String mailid,
                              boolean debugMode)
                       throws ESDSException

ifDeprovRepovEvent

public static boolean ifDeprovRepovEvent(ESDSAttributeValueList user)
                                  throws java.lang.Exception

handleDeprovRepovEvent

public static void handleDeprovRepovEvent(ESDSDirServerAccess access,
                                          ESDSLdapHandle ldapconn,
                                          java.lang.String mailid,
                                          boolean debugMode)
                                   throws ESDSException

convertStrToJNDIName

public static javax.naming.Name convertStrToJNDIName(java.lang.String str)
                                              throws ESDSException