oracle.mail.ldap
Class ESDSProcess

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

public class ESDSProcess

extends java.lang.Object

Constructor Summary

ESDSProcess(ESDSAccess esdsAccess)

Method Summary

java.util.Vector	addGroupInstance(java.util.Vector instanceDNs, java.lang.String processGroupName) This method takes a list of instance DNs and the process group names.
void	clearInstanceParameters(java.lang.String instanceDN) This method will clear all the values set for the target/instance.
java.lang.String	create(java.lang.String targetDN, ESDSLdapObject process) This method creates an instance for a process with the given target DN.
java.lang.String	createInstanceLike(java.lang.String instanceDN) This method creates an instance with the same attributes as those set in the given instance DN.
void	delete(java.lang.String instanceDN) This method deletes an instance represented by the given instance DN.
ESDSLdapObject[]	getAllInstances(java.lang.String targetDN, java.util.Vector attrsToFetch) This method gets all instances for the given process target DN.
java.util.Hashtable	getAllMailstoreParams(java.lang.String target, java.lang.String iasInstanceName) This method fetches all the mailstores associated with a given target and iAS instance and all relevant mailstore related parameters.
java.util.Hashtable	getAllMailstoreParams(java.lang.String target, java.lang.String hostName, java.lang.String oracleHome) This method fetches all the mailstores associated with a given target and a hostname-Oracle home and all relevant mailstore related parameters.
java.lang.String[]	getAllProcessGroups(java.lang.String prodType) This method returns names of all process groups.
java.util.Hashtable	getAllProductInstalls(java.lang.String prodType) This method returns the list of host names and their corresponding Oracle home values for the given product type(for email, its EMailServer).
java.lang.String	getAppServerHost(java.lang.String iasInstanceName) This method accepts an iAS instance name and returns the mid-tier host name associated with that iAS instance.
java.lang.String	getAppServerName(java.lang.String hostName, java.lang.String oracleHome) This method returns iAS instance name, given the host name and full path to Oracle home.
java.lang.String	getAppServerOracleHome(java.lang.String iasInstanceName) This method accepts an iAS instance name and returns the Oracle home associated with that iAS instance.
java.util.Vector	getAppServerTargets(java.lang.String iasInstanceName) This method returns all the target names available for a given iAS instance.
ESDSLdapObject[]	getGroupInstances(java.lang.String processGroupName, java.util.Vector attrsToFetch) This method gets all instances of a process target for a given process group name.
java.lang.String	getInstanceName(java.lang.String instanceDN) This method can be used to get the instance name given the instance DN.
ESDSLdapObject	getMetaData(java.lang.String DN) Deprecated.
ESDSLdapObject	getMetaData(java.lang.String DN, java.util.Vector attrsToFetch) Deprecated.
java.lang.String[]	getMidtierHosts(java.lang.String procType) This method returns all the hostnames of the mid-tiers that have a target entry in the DIT.
java.util.Vector	getOracleHomeTargets(java.lang.String hostName, java.lang.String oracleHome) This method returns all the target names available for the given hostname and Oracle home.
java.lang.String[]	getSMTPInsertOrder(java.lang.String instance) This method gets the mailstores associated with an instance/target with the returned mailstores ordered as per their insert order.
java.lang.String	getTargetDN(java.lang.String targetName, java.lang.String iasInstanceName) This method returns the DN of the target for the given target name and iAS instance name.
java.lang.String	getTargetDN(java.lang.String hostName, java.lang.String oraHome, java.lang.String targetName) This method returns the DN of the target for the given host and ORACLE_HOME.
java.lang.String	getTargetName(java.lang.String targetDN) This method can be used to get the target name given the target DN.
ESDSLdapObject	lookup(java.lang.String DN) This method can be used to lookup the attribute values in a process target or instance.
ESDSLdapObject	lookup(java.lang.String DN, java.util.Vector attrsToFetch) This method can be used to lookup the attribute values in a process target or instance.
ESDSLdapObject	lookupInstance(java.lang.String instanceDN, java.util.Vector attrsToFetch) Deprecated.
ESDSAttributeValueList	lookupMailstore(java.lang.String mailstore, java.util.Vector attrsToFetch) This method looks up a mailstore and returns the specified attributes
ESDSLdapObject	lookupMidtierGlobals(java.lang.String hostName, java.lang.String oraHome, java.util.Vector attrsToFetch) This method looks up the cn=mailProcessConfig entry for a given hostname and Oracle home and will return the requested attributes.
ESDSLdapObject	lookupMidtierGlobals(java.lang.String iasInstanceName, java.util.Vector attrsToFetch) This method looks up the cn=mailProcessConfig entry for a given iAS instance name and will return the requested attributes.
void	modify(java.lang.String processDN, ESDSLdapObject process) This method modifies a process target or instance in the directory.
void	modifyMailstore(java.lang.String mailstoreDN, ESDSModifyData mod) This method modifies a mailstore entry
void	modifyMidtierGlobals(java.lang.String iasInstanceName, ESDSLdapObject mtGlobals) This method modifies the mid-tier global attribute values stored in the cn=mailprocessconfig entry corresponding to the given iAS instance name.
void	modifyMidtierGlobals(java.lang.String hostName, java.lang.String oraHome, ESDSLdapObject mtGlobals) This method modifies the mid-tier global attribute values stored in the cn=mailprocessconfig entry corresponding to the given hostname and Oracle home.
java.util.Vector	modifyProcessMailstoreParams(java.lang.String target, java.lang.String iasInstanceName, java.util.Hashtable modData) This method modifies the instance entries of a target under a mailstore with the modification data provided.
java.util.Vector	modifyProcessMailstoreParams(java.lang.String target, java.lang.String hostName, java.lang.String oraHome, java.util.Hashtable modData) This method modifies the instance entries of a target under a mailstore with the modification data provided.
java.util.Vector	removeFromGroupInstance(java.util.Vector instanceDNs, java.lang.String processGroupName) This method takes a list of instance DNs and the process group name.
java.util.Vector	updateSMTPInsertOrder(java.lang.String[] mailstoreDNs, java.lang.String instance) This method updates the SMTP insert order value in instance/target entries under a mailstore.

Methods inherited from class java.lang.Object

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

Constructor Detail

ESDSProcess

public ESDSProcess(ESDSAccess esdsAccess)
            throws ESDSException

Parameters:

esdsAccess - An authenticated ESDSAccess object

Throws:

ESDSException - Throws this exception if the context passed in is not a valid app context

Method Detail

getAppServerTargets

public java.util.Vector getAppServerTargets(java.lang.String iasInstanceName)
                                     throws ESDSException

This method returns all the target names available for a given iAS instance. The names are returned in a Vector.

Parameters:

iasInstanceName - Name of the iAS instance

Returns:

Vector containing target names

Throws:

ESDSException - if any error is encountered

getOracleHomeTargets

public java.util.Vector getOracleHomeTargets(java.lang.String hostName,
                                             java.lang.String oracleHome)
                                      throws ESDSException

This method returns all the target names available for the given hostname and Oracle home. The names are returned in a Vector.

Parameters:

hostName - Name of the mid-tier host

oracleHome - Full path of the Oracle home on that host

Returns:

Vector containing target names

Throws:

ESDSException - if any error is encountered

getTargetDN

public java.lang.String getTargetDN(java.lang.String targetName,
                                    java.lang.String iasInstanceName)
                             throws ESDSException

This method returns the DN of the target for the given target name and iAS instance name.

Parameters:

targetName - The name of the target

iasInstanceName - The iAS instance name

Returns:

DN of the target

Throws:

ESDSException -

getTargetDN

public java.lang.String getTargetDN(java.lang.String hostName,
                                    java.lang.String oraHome,
                                    java.lang.String targetName)
                             throws ESDSException

This method returns the DN of the target for the given host and ORACLE_HOME.

Parameters:

hostName - The middle-tier host name

oraHome - The middle tier ORACLE HOME(full path)

targetName - The name of the target

Returns:

DN of the target

Throws:

ESDSException -

getTargetName

public java.lang.String getTargetName(java.lang.String targetDN)
                               throws ESDSException

This method can be used to get the target name given the target DN.

Parameters:

targetDN - DN of the target

Returns:

Name of the target

Throws:

ESDSException - if any error is encountered

getMetaData

public ESDSLdapObject getMetaData(java.lang.String DN,
                                  java.util.Vector attrsToFetch)
                           throws ESDSException

Deprecated.

This method returns the metadata for a process target/instance. The metadata will contain the list of mandatory and optional attributes for the given process target/instance, for example, the syntax, multiplicity of the attributes, the default values of the attributes(if any default is set in OiD). 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:

DN - The DN of the target/instance

attrsToFetch - required attributes for the target/instance

Returns:

ESDSLdapObject representing the target

Throws:

ESDSException - Throws ESDSException if any error is encountered

getMetaData

public ESDSLdapObject getMetaData(java.lang.String DN)
                           throws ESDSException

Deprecated.

This method returns the metadata for a process target/instance. The metadata will contain the list of mandatory and optional attributes for the given process target/instance, for example, the syntax, multiplicity of the attributes, the default values of the attributes(if any default is set in OiD). 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:

DN - The DN of the target/instance

Returns:

ESDSLdapObject representing the target

Throws:

ESDSException - Throws ESDSException if any error is encountered

getAllInstances

public ESDSLdapObject[] getAllInstances(java.lang.String targetDN,
                                        java.util.Vector attrsToFetch)
                                 throws ESDSException

This method gets all instances for the given process target DN. It also fetches the attribute values of the process instances. For each instance, if the attribute value is set in the instance or is inherited from the parent can be found out from the ESDSAttribMetaData.inheritedFromParent method. The list of attribute values to be fetched can be specified in the attrsToFetch vector.

Parameters:

targetDN - The DN of the target

attrsToFetch - A vector of strings containing the list of attribute names whose values are to be fetched

Returns:

array of ESDSLdapObject each containing attribute names and their values. Returns null if no instances found

Throws:

ESDSException - Throws ESDSException if any error is encountered

getAppServerName

public java.lang.String getAppServerName(java.lang.String hostName,
                                         java.lang.String oracleHome)
                                  throws ESDSException

This method returns iAS instance name, given the host name and full path to Oracle home.

Parameters:

hostName - Name of mid-tier host

oracleHome - Full path to Oracle home

Returns:

String iAS instance name corresponding to host and Oracle home

Throws:

ESDSException - if any error is encountered

getAppServerHost

public java.lang.String getAppServerHost(java.lang.String iasInstanceName)
                                  throws ESDSException

This method accepts an iAS instance name and returns the mid-tier host name associated with that iAS instance.

Parameters:

iasInstanceName - Name of the iAS instance

Returns:

String Host name of the instance

Throws:

ESDSException - if any error is encountered

getAppServerOracleHome

public java.lang.String getAppServerOracleHome(java.lang.String iasInstanceName)
                                        throws ESDSException

This method accepts an iAS instance name and returns the Oracle home associated with that iAS instance.

Parameters:

iasInstanceName - Name of the iAS instance

Returns:

String Full path of Oracle home of the instance

Throws:

ESDSException - if any error is encountered

create

public java.lang.String create(java.lang.String targetDN,
                               ESDSLdapObject process)
                        throws ESDSException

This method creates an instance for a process with the given target DN. - Inherits default values from the default instance - Constructs the instance DN - If different values are given as input parameters for the new process, override the new values - Add the new process - Modify the mailstore entry

Parameters:

targetDN - The DN of the target

process - An ESDSLdapObject representing the new process

Returns:

String containing the DN of the new instance

Throws:

ESDSException - Throws ESDSException if any error is encountered

delete

public void delete(java.lang.String instanceDN)
            throws ESDSException

This method deletes an instance represented by the given instance DN.

Parameters:

instanceDN - DN of the instance to be deleted

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered

modify

public void modify(java.lang.String processDN,
                   ESDSLdapObject process)
            throws ESDSException

This method modifies a process target or instance in the directory. This also modifies the mailstore entry if the mailstore attribute is changed. This API figures out whether a target or an instance needs to be modified from the value of the DN passed and does the modification accordingly. Additionally, this method takes of inheritance while setting values also. i.e. if an attribute being set is the same as the value in the parent(s) then the value in the entry being modified is just cleared. NOTE: This functionality is available only for regular attributes and not for binary attributes. Also, ESDSProcess.modify() does not adjust the inbound smtp server's queue insert order when the mailstore references are created/removed. The caller's are advised to use the method ESDSProcess.updateInsertOrder() after the modify() returns successfully to set the insert order

Parameters:

processDN - DN to be modified. Can be target or instance DN

process - An ESDSLdapObject representing the modified process

Returns:

void

Throws:

ESDSException - Throws ESDSException if any error is encountered

lookupInstance

public ESDSLdapObject lookupInstance(java.lang.String instanceDN,
                                     java.util.Vector attrsToFetch)
                              throws ESDSException

Deprecated.

This method looks up a process in the directory.

Parameters:

instanceDN - DN of the instance to be looked up

attrsToFetch - A vector containing list of attribute names whose values are to be fetched

Returns:

process The process instance object. Returns null if instance not found

Throws:

ESDSException - Throws ESDSException if any error is encountered

getAllProductInstalls

public java.util.Hashtable getAllProductInstalls(java.lang.String prodType)
                                          throws ESDSException

This method returns the list of host names and their corresponding Oracle home values for the given product type(for email, its EMailServer).

Parameters:

prodType - The product name for which the list of middle-tier host and Oracle homes are to be returned

Returns:

Hashtable containing a list of host names and their corresponding Oracle homes. Key is the host name and value is a vector of Strings containing the full Oracle home paths. Returns an empty hashtable if no product installations found

Throws:

ESDSException - Throws ESDSException if any error is encountered

getAllProcessGroups

public java.lang.String[] getAllProcessGroups(java.lang.String prodType)
                                       throws ESDSException

This method returns names of all process groups. If no group exists, then this method returns null.

Parameters:

prodType - The product name for which the process groups are needed

Returns:

Array of String objects containing process group names

Throws:

ESDSException - Throws ESDSException if any error is encountered

getGroupInstances

public ESDSLdapObject[] getGroupInstances(java.lang.String processGroupName,
                                          java.util.Vector attrsToFetch)
                                   throws ESDSException

This method gets all instances of a process target for a given process group name. It also fetches the attribute values of the process instances. For each instance, if the attribute value is set in the instance or is inherited can be found out from the ESDSAttributeMetaData.inheritedFromParent method. The list of attribute values to be fetched can be specified in the attrsToFetch vector.

Parameters:

processGroupName - The process group name

attrsToFetch - Vector of String objects containing list of attribute names whose values are to be fetches for each instance

Returns:

Array of EDSLdapObject objects representing process instances

Throws:

ESDSException - Throws ESDSException if any error is encountered

addGroupInstance

public java.util.Vector addGroupInstance(java.util.Vector instanceDNs,
                                         java.lang.String processGroupName)
                                  throws ESDSException

This method takes a list of instance DNs and the process group names. In case the instance is not a member of that group, it adds the instance to given group.

Parameters:

instanceDNs - Vector of String objects containing the instance DNs to be added to the process group

processGroupName - Name of the process group

Returns:

Vector containing list of DNs which were not added to the group

Throws:

ESDSException - Throws ESDSException if any error is encountered

removeFromGroupInstance

public java.util.Vector removeFromGroupInstance(java.util.Vector instanceDNs,
                                                java.lang.String processGroupName)
                                         throws ESDSException

This method takes a list of instance DNs and the process group name. In case the instance is a member of that group, it removes the instance from the given group.

Parameters:

instanceDNs - Vector of String objects containing the instance DNs to be removed from the process group

processGroupName - Name of the process group

Returns:

Vector containing list of DNs which were not removed from the group

Throws:

ESDSException - Throws ESDSException if any error is encountered

lookupMidtierGlobals

public ESDSLdapObject lookupMidtierGlobals(java.lang.String hostName,
                                           java.lang.String oraHome,
                                           java.util.Vector attrsToFetch)
                                    throws ESDSException

This method looks up the cn=mailProcessConfig entry for a given hostname and Oracle home and will return the requested attributes. Since the only values stored at this level are mid-tier level global values, this method should be used only for those attributes and values.

Parameters:

hostName - String containing the hostname of the mid-tier for which the global values are needed

oraHome - String containing the Oracle home on the mid-tier for which the global values are needed

attrsToFetch - Vector containing the attributes that need to be fetched. Cannot be null and should have at least one value

Throws:

ESDSException - if any error is encountered

lookupMidtierGlobals

public ESDSLdapObject lookupMidtierGlobals(java.lang.String iasInstanceName,
                                           java.util.Vector attrsToFetch)
                                    throws ESDSException

This method looks up the cn=mailProcessConfig entry for a given iAS instance name and will return the requested attributes. Since the only values stored at this level are mid-tier level global values, this method should be used only for those attributes and values.

Parameters:

iasInstanceName - String containing the iAS instance name of the mid-tier for which the global values are needed

attrsToFetch - Vector containing the attributes that need to be fetched

Throws:

ESDSException - if any error is encountered

modifyMidtierGlobals

public void modifyMidtierGlobals(java.lang.String hostName,
                                 java.lang.String oraHome,
                                 ESDSLdapObject mtGlobals)
                          throws ESDSException

This method modifies the mid-tier global attribute values stored in the cn=mailprocessconfig entry corresponding to the given hostname and Oracle home. This method should be used only to modify mid-tier global level values. If a value is being set at the mid-tier level, then this API will ensure that the corresponding attributes for all entries under the cn=mailprocessconfig entry will be cleared.

Parameters:

hostName - String containing the hostname of the mid-tier for which the global values are needed

oraHome - String containing the Oracle home on the mid-tier for which the global values are needed

mtGlobals - ESDSLdapObject containing the modify data

Throws:

ESDSException - if any error is encountered

modifyMidtierGlobals

public void modifyMidtierGlobals(java.lang.String iasInstanceName,
                                 ESDSLdapObject mtGlobals)
                          throws ESDSException

This method modifies the mid-tier global attribute values stored in the cn=mailprocessconfig entry corresponding to the given iAS instance name. This method should be used only to modify mid-tier global level values. If a value is being set at the mid-tier level, then this API will ensure that the corresponding attributes for all entries under the cn=mailprocessconfig entry will be cleared.

Parameters:

iasInstanceName - String containing the iAS instance name of the mid-tier for which the global values are needed

oraHome - String containing the Oracle home on the mid-tier for which the global values are needed

mtGlobals - ESDSLdapObject containing the modify data

Throws:

ESDSException - if any error is encountered

updateSMTPInsertOrder

public java.util.Vector updateSMTPInsertOrder(java.lang.String[] mailstoreDNs,
                                              java.lang.String instance)
                                       throws ESDSException

This method updates the SMTP insert order value in instance/target entries under a mailstore. The mailstoreDNs input parameter is an ordered array representing the insert order. This method should be called only for SMTP inbound instances.

Parameters:

mailstoreDNs - Order array of mailstore DNs

instance - The instance name

Returns:

Vector containing the mailstores that could not be updated

Throws:

ESDSException - with error code 10017, if no instances with empty orclmailstoredn is found; relevant ESDSException is thrown if any other error is encountered.

getInstanceName

public java.lang.String getInstanceName(java.lang.String instanceDN)
                                 throws ESDSException

This method can be used to get the instance name given the instance DN.

Parameters:

instanceDN - DN of the instance

Returns:

Name of the instance

Throws:

ESDSException - if any error is encountered

getSMTPInsertOrder

public java.lang.String[] getSMTPInsertOrder(java.lang.String instance)
                                      throws ESDSException

This method gets the mailstores associated with an instance/target with the returned mailstores ordered as per their insert order. This method should be called only for SMTP inbound instances. In case of incorrect values in the DIT, there might be null values in the returned array. This should be handled by callers.

Parameters:

instance - The name of the instance

Returns:

String[] of mailstore DNs arranged in the insert order

Throws:

ESDSException - if any error occurs

getAllMailstoreParams

public java.util.Hashtable getAllMailstoreParams(java.lang.String target,
                                                 java.lang.String iasInstanceName)
                                          throws ESDSException

This method fetches all the mailstores associated with a given target and iAS instance and all relevant mailstore related parameters.

Parameters:

target - Name of the target

iasInstanceName - Name of the iAS instance

Returns:

Hashtable containing mailstore DN as the key and ESDSAttributeValueList for each mailstore associated with any instance of the target

Throws:

ESDSException - if any error is encountered

getAllMailstoreParams

public java.util.Hashtable getAllMailstoreParams(java.lang.String target,
                                                 java.lang.String hostName,
                                                 java.lang.String oracleHome)
                                          throws ESDSException

This method fetches all the mailstores associated with a given target and a hostname-Oracle home and all relevant mailstore related parameters.

Parameters:

target - Name of the target

hostName - Name of the mid-tier host

oracleHome - Oracle home on the mid-tier(full path)

Returns:

Hashtable containing mailstore DN as the key and ESDSAttributeValueList for each mailstore associated with any instance of the target

Throws:

ESDSException - if any error is encountered

modifyProcessMailstoreParams

public java.util.Vector modifyProcessMailstoreParams(java.lang.String target,
                                                     java.lang.String iasInstanceName,
                                                     java.util.Hashtable modData)
                                              throws ESDSException

This method modifies the instance entries of a target under a mailstore with the modification data provided.

Parameters:

target - Name of the target

iasInstanceName - iAS instance name of the target

modData - A hashtable with the key as the mailstore DN and the value as an ESDSModifyData object

Returns:

Vector containing all mailstores that could not be updated

Throws:

ESDSException - if any error is encountered

modifyProcessMailstoreParams

public java.util.Vector modifyProcessMailstoreParams(java.lang.String target,
                                                     java.lang.String hostName,
                                                     java.lang.String oraHome,
                                                     java.util.Hashtable modData)
                                              throws ESDSException

This method modifies the instance entries of a target under a mailstore with the modification data provided.

Parameters:

target - Name of the target

hostName - iAS instance name of the mid-tier host

oraHome - Oracle home on the mid-tier(full path)

modData - A hashtable with the key as the mailstore DN and the value as an ESDSModifyData object

Returns:

Vector containing all mailstores that could not be updated

Throws:

ESDSException - if any error is encountered

lookupMailstore

public ESDSAttributeValueList lookupMailstore(java.lang.String mailstore,
                                              java.util.Vector attrsToFetch)
                                       throws ESDSException

This method looks up a mailstore and returns the specified attributes

Parameters:

mailstore - Name of the mailstore

attrsToFetch - Vector containing the attributes to be fetched

Returns:

ESDSAttributeValueList representing the mailstore

Throws:

ESDSException - if any error is encountered

modifyMailstore

public void modifyMailstore(java.lang.String mailstoreDN,
                            ESDSModifyData mod)
                     throws ESDSException

This method modifies a mailstore entry

Parameters:

mailstoreDN - DN of the mailstore to be modified

mod - Object containing the modification data

Throws:

ESDSException - if any error is encountered

getMidtierHosts

public java.lang.String[] getMidtierHosts(java.lang.String procType)
                                   throws ESDSException

This method returns all the hostnames of the mid-tiers that have a target entry in the DIT.

Parameters:

processType - The email server process type(like imap, smtp_in etc). These are defined as constants in the ESDSConstants class.

Returns:

String[] containing the hostnames

Throws:

ESDSException - if any error is encountered

lookup

public ESDSLdapObject lookup(java.lang.String DN)
                      throws ESDSException

This method can be used to lookup the attribute values in a process target or instance. This method will take of inheritance for both the target and the instance.

Parameters:

DN - The DN of the entry being looked up. Should be either a process target or instance

Returns:

An ESDSLdapObject with all the populated attributes of the entry and its parent and parent's parent(depending on whether the DN is a target or instance)

Throws:

ESDSException - if any error is encountered

lookup

public ESDSLdapObject lookup(java.lang.String DN,
                             java.util.Vector attrsToFetch)
                      throws ESDSException

This method can be used to lookup the attribute values in a process target or instance. This method will take of inheritance for both the target and the instance.

Parameters:

DN - The DN of the entry being looked up. Should be either a process target or instance

attrsToFetch - The list of required attributes for target/instance

Returns:

An ESDSLdapObject with all the populated attributes of the entry and its parent and parent's parent(depending on whether the DN is a target or instance)

Throws:

ESDSException - if any error is encountered

clearInstanceParameters

public void clearInstanceParameters(java.lang.String instanceDN)
                             throws ESDSException

This method will clear all the values set for the target/instance. While the mandatory attributes cannot be cleared, amongst the optional attributes, orclmailstatusup is the only attribute that is not cleared. It was decided that filters associated with this instance will not be cleared, but all mailstore associations of this instance will be cleared and changed to reflect the corresponding target's mailstores.

Parameters:

instanceDN -

Throws:

ESDSException -

createInstanceLike

public java.lang.String createInstanceLike(java.lang.String instanceDN)
                                    throws ESDSException

This method creates an instance with the same attributes as those set in the given instance DN. Only attributes set at the instance level in the given instance are set in the newly created instance. Mailstore associations and filter associations of the given instance are retained in the new instance. In case of smtp_in instances the orclmailsmtpinsertorder attribute values also preserved correctly for the new instance.

Parameters:

instanceDN - The instance to be "created like"

Returns:

The DN of the newly created instance

Throws:

ESDSException - if any error is encountered