oracle.mail.ldap
Class ESDSLdapObject

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

public final class ESDSLdapObject

extends java.lang.Object

This class helps the caller set the attribute names and values for the Mail Related LDAP entry.

Constructor Summary

ESDSLdapObject(java.lang.String objType)

Method Summary

ESDSAddData[]	getAddEntryData()
java.util.Vector	getAttributeValue(java.lang.String attribName) This method returns the value of an attribute.
byte[]	getBinaryAttributeValue(java.lang.String attributeName) This method returns the value of a binary attribute.
java.lang.String	getDN()
java.util.Vector	getMandatoryAttribs() This method returns the mandatory attributes for an object, for example, mailuser, process, mailstore etc.
ESDSAttribMetaData	getMetaData(java.lang.String attribName) This method returns the meta data associated with an attribute.
ESDSModifyData	getModifyData()
ESDSLdapObject	getNewInstance()
java.util.Vector	getObjClasses()
java.lang.String	getObjectType()
java.util.Vector	getOptionalAttribs() This method returns the optional attributes for an object, for example, mailuser, process, mailstore etc.
void	modifyAttributeValue(java.lang.String attribName, java.util.Vector attribValues, java.lang.String modType) This method is used to set the attribute values and the modification type (ESDSConstants.DS_MODIFY_ADD, ESDSConstants.DS_MODIFY_REPLACE, ESDSConstants.DS_MODIFY_DELETE).
void	modifyBinaryAttributeValue(java.lang.String attribName, byte[] attribValue, java.lang.String modType) This method is used to set the attribute value for a binary attribute for the given modification type (ESDSConstants.DS_MODIFY_ADD, ESDSConstants.DS_MODIFY_REPLACE, ESDSConstants.DS_MODIFY_DELETE).
void	modifyMembersACI(java.lang.String memberType, java.lang.String memberName, java.lang.String membersACI, java.lang.String modificationType) This method sets the ACI for a member
void	setAttributeValue(java.lang.String attribName, java.lang.String attribValue) This method is used to set the attribute values for an add operation.
void	setAttributeValue(java.lang.String attribName, java.util.Vector attribValues) This method is used to set the attribute values for an add operation.
void	setBinaryAttributeValue(java.lang.String attribName, byte[] attribValue) This method is used to set the values of a binary attribute for an add operation.
void	setMandatoryAttribs(java.util.Vector mandAttribs)
void	setMembersACI(java.lang.String memberType, java.lang.String memberName, java.lang.String membersACI) This method sets the ACI for a member
void	setMetaData(java.util.Hashtable mData)
void	setMetaData(java.lang.String attribName, ESDSAttribMetaData mData)
void	setOptionalAttribs(java.util.Vector optAttribs)

Methods inherited from class java.lang.Object

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

Constructor Detail

ESDSLdapObject

public ESDSLdapObject(java.lang.String objType)

Method Detail

getNewInstance

public ESDSLdapObject getNewInstance()

getObjClasses

public java.util.Vector getObjClasses()

getObjectType

public java.lang.String getObjectType()

setMandatoryAttribs

public void setMandatoryAttribs(java.util.Vector mandAttribs)

setOptionalAttribs

public void setOptionalAttribs(java.util.Vector optAttribs)

setMetaData

public void setMetaData(java.util.Hashtable mData)

setMetaData

public void setMetaData(java.lang.String attribName,
                        ESDSAttribMetaData mData)

setMembersACI

public void setMembersACI(java.lang.String memberType,
                          java.lang.String memberName,
                          java.lang.String membersACI)
                   throws ESDSException

This method sets the ACI for a member

Parameters:

memberName - The unique id of the Member, for mailusers mailid, for dls mailid, for groups name like ou,o,dc,l,cn or cn and for domains the domain name, like oracle.com

memberType - For mailusers DS_MAILUSER, for dls DS_DISTRIBUTION_LIST, for domains DS_DOMAIN

membersACI - The aci String

Returns:

void

modifyMembersACI

public void modifyMembersACI(java.lang.String memberType,
                             java.lang.String memberName,
                             java.lang.String membersACI,
                             java.lang.String modificationType)
                      throws ESDSException

This method sets the ACI for a member

Parameters:

memberName - The unique id of the Member, for mailusers mailid, for dls mailid, for groups name like ou,o,dc,l,cn or cn and for domains the domain name, like oracle.com

memberType - For mailusers mailusers, for dls dl, for groups group for domains domain

membersACI - The aci String

modificationType - The modification type

Returns:

void

getMandatoryAttribs

public java.util.Vector getMandatoryAttribs()

This method returns the mandatory attributes for an object, for example, mailuser, process, mailstore etc.

Parameters:

void -

Returns:

the mandatory attributes

getOptionalAttribs

public java.util.Vector getOptionalAttribs()

This method returns the optional attributes for an object, for example, mailuser, process, mailstore etc.

Parameters:

void -

Returns:

the optional attributes

getMetaData

public ESDSAttribMetaData getMetaData(java.lang.String attribName)
                               throws ESDSException

This method returns the meta data associated with an attribute.

Parameters:

m_dsContext - The caller's context

Returns:

attribute meta data

getAttributeValue

public java.util.Vector getAttributeValue(java.lang.String attribName)
                                   throws ESDSException

This method returns the value of an attribute. For getting values of a binary attribute, use getBinaryAttributeValue

Parameters:

attribName - The name of the attribute

Returns:

The values of the attribute, null if not found. Returns Vector of Strings

getBinaryAttributeValue

public byte[] getBinaryAttributeValue(java.lang.String attributeName)
                               throws ESDSException

This method returns the value of a binary attribute.

Parameters:

attributeName - The name of the attribute

Returns:

The values of the attribute, null if not found. Returns byte[]

setAttributeValue

public void setAttributeValue(java.lang.String attribName,
                              java.util.Vector attribValues)
                       throws ESDSException

This method is used to set the attribute values for an add operation.

Parameters:

attribName - The name of the attribute

attribValues - The values of the attribute, Vector of Strings

Returns:

void

setAttributeValue

public void setAttributeValue(java.lang.String attribName,
                              java.lang.String attribValue)
                       throws ESDSException

This method is used to set the attribute values for an add operation. When this method is called multiple times, it keeps adding values to the same attribute. For eg., if it's called twice setAttributeValue("mail","1") and setAttributeValue("mail","2"), then it adds values "1" and "2" to the same "mail" attribute.

Parameters:

attribName - The name of the attribute

attribValue - The value of the attribute

Returns:

void

setBinaryAttributeValue

public void setBinaryAttributeValue(java.lang.String attribName,
                                    byte[] attribValue)
                             throws ESDSException

This method is used to set the values of a binary attribute for an add operation.

Parameters:

attribName - The name of the attribute

attribValue - The value of the attribute,byte[]

Returns:

void

getAddEntryData

public ESDSAddData[] getAddEntryData()

getModifyData

public ESDSModifyData getModifyData()

modifyAttributeValue

public void modifyAttributeValue(java.lang.String attribName,
                                 java.util.Vector attribValues,
                                 java.lang.String modType)
                          throws ESDSException

This method is used to set the attribute values and the modification type (ESDSConstants.DS_MODIFY_ADD, ESDSConstants.DS_MODIFY_REPLACE, ESDSConstants.DS_MODIFY_DELETE).

Parameters:

attribName - The name of the attribute

attribValues - The values of the attribute

modType - The type of modification

Returns:

void

modifyBinaryAttributeValue

public void modifyBinaryAttributeValue(java.lang.String attribName,
                                       byte[] attribValue,
                                       java.lang.String modType)
                                throws ESDSException

This method is used to set the attribute value for a binary attribute for the given modification type (ESDSConstants.DS_MODIFY_ADD, ESDSConstants.DS_MODIFY_REPLACE, ESDSConstants.DS_MODIFY_DELETE).

Parameters:

attribName - The name of the attribute

attribValue - The binary attr value, in byte[]

modType - The type of modification

Returns:

void

getDN

public java.lang.String getDN()