oracle.mail.ldap
Class ESDSProcessPolicy

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

public class ESDSProcessPolicy

extends java.lang.Object

Constructor Summary

ESDSProcessPolicy(ESDSAccess esdsAccess)

Method Summary

void	createArchivingFilter(ESDSLdapObject archivefilter) This method creates a archiving filter.
void	createArchivingPolicy(ESDSLdapObject archivePolicy) This method creates a archiving filter.
void	createProcessFilter(ESDSLdapObject filter) This method creates a filter.
void	deleteArchivingPolicy(java.lang.String policyName) This method deleted the given archiving policy.
void	deleteProcessFilter(java.lang.String name) This method deleted the given filter.
static java.lang.String[]	ESDSGetAllArchivingPolicies(ESDSDirServerAccess access, ESDSLdapHandle handle) This method returns names of all archive policies in the system.
static java.util.Hashtable	ESDSGetArchivingHashtable(ESDSDirServerAccess access, ESDSLdapHandle handle) This method returns names of all archive policies in the system.
ESDSLdapObject[]	getAllArchivingFilters(java.util.Vector attrs) This method returns all archive filters in the system.
ESDSLdapObject[]	getAllArchivingPolicies(java.util.Vector attrs) This method returns all archive policies in the system.
ESDSLdapObject[]	getAllProcessFilters(java.util.Vector attrs) This method returns all process filters in the system.
ESDSLdapObject	getArchivingFilterMetaData() This method returns the metadata for archive filter.
ESDSLdapObject[]	getArchivingPolicies(java.lang.String nameFilter, java.util.Vector attrs) This method returns the archive policies in the system.
ESDSLdapObject	getArchivingPolicyMetaData() This method returns the metadata for archive filter.
ESDSLdapObject	getProcessFilter(java.lang.String name, java.util.Vector attrs) This method returns all process filters in the system.
ESDSLdapObject	getProcessFilterInstanceMetaData() This method returns the metadata for process filter instance.
ESDSLdapObject	getProcessFilterMetaData() This method returns the metadata for process filter.
ESDSLdapObject[]	getProcessFilterParamsForProc(java.lang.String procDN, java.util.Vector attrs) This method gets the filters and all parameters including instance specific parameters applicable for the given process dn.
ESDSLdapObject[]	getProcessFilters(java.lang.String filter, java.util.Vector attrs) This method returns all process filters in the system matching the query.
void	modifyArchivingPolicy(ESDSLdapObject archivingPolicy) This method modifies the given ar policy.
void	modifyProcessFilter(ESDSLdapObject filter) This method modifies the given filter.
void	modifyProcessFilterParamsForProc(java.lang.String filterName, java.lang.String procDN, ESDSLdapObject instanceParams) This method modifies the server specific parameters for the given filter for the given process entry.
void	setProcessFilterForProc(java.lang.String filterName, java.lang.String procDN, ESDSLdapObject instanceParams) This method sets given filter for the given process entry.
void	setUserArchivingPolicy(java.lang.String usermailid, java.lang.String policyName)
void	unsetProcessFilterForProc(java.lang.String filterName, java.lang.String procDN) This method unsets the given filter for the given process entry.
void	unsetUserArchivingPolicy(java.lang.String usermailid)

Methods inherited from class java.lang.Object

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

Constructor Detail

ESDSProcessPolicy

public ESDSProcessPolicy(ESDSAccess esdsAccess)
                  throws ESDSException

Parameters:

oesCtx - An authenticated app context

Throws:

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

Method Detail

getProcessFilterMetaData

public ESDSLdapObject getProcessFilterMetaData()
                                        throws ESDSException

This method returns the metadata for process filter. This method will return the list of mandatory and optional attributes for the filter entry and the metadata associated with the filter object. The metadata for a filter consists of the list of mandatory & optional attributes the caller needs to set in order to create a filter. 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.

Returns:

an ESDSLdapObject representing the process filter entry.

Throws:

ESDSException - if any error is encountered

getAllProcessFilters

public ESDSLdapObject[] getAllProcessFilters(java.util.Vector attrs)
                                      throws ESDSException

This method returns all process filters in the system.

Parameters:

attrs - list of attributes to fetch - a Vector of String

Returns:

an array of ESDSLdapObject, each ESDSLdapObject represents a process filter entry. Returns null if no filter is defined.

Throws:

ESDSException - if any error is encountered

getProcessFilters

public ESDSLdapObject[] getProcessFilters(java.lang.String filter,
                                          java.util.Vector attrs)
                                   throws ESDSException

This method returns all process filters in the system matching the query.

Parameters:

filter - the query string - has to be a valid filter

attrs - list of attributes to fetch - a Vector of String

Returns:

an array of ESDSLdapObject, each ESDSLdapObject represents a process filter entry. Returns null if no filter is defined.

Throws:

ESDSException - if any error is encountered

getProcessFilter

public ESDSLdapObject getProcessFilter(java.lang.String name,
                                       java.util.Vector attrs)
                                throws ESDSException

This method returns all process filters in the system.

Parameters:

name - The name of the filter

attrs - list of attributes to fetch - a Vector of String

Returns:

an ESDSLdapObject representing the process filter entry. throws ESDSException(ESDSConstants.ESDSJ_NO_SUCH_ENTRY) if this filter is not found

Throws:

ESDSException - if any error is encountered

createProcessFilter

public void createProcessFilter(ESDSLdapObject filter)
                         throws ESDSException

This method creates a filter.

Parameters:

filter - The filter parameters

Returns:

void

Throws:

ESDSException - if any error is encountered

modifyProcessFilter

public void modifyProcessFilter(ESDSLdapObject filter)
                         throws ESDSException

This method modifies the given filter.

Parameters:

filter - The filter parameters for modification

Returns:

void

Throws:

ESDSException - if any error is encountered

deleteProcessFilter

public void deleteProcessFilter(java.lang.String name)
                         throws ESDSException

This method deleted the given filter. When this method is invoked, the references for processes serving this filter will also be deleted.

Parameters:

name - The name of filter to be deleted

Returns:

void

Throws:

ESDSException - if any error is encountered

getProcessFilterInstanceMetaData

public ESDSLdapObject getProcessFilterInstanceMetaData()
                                                throws ESDSException

This method returns the metadata for process filter instance. This method will return the list of mandatory and optional attributes for the filter instance entry and the metadata associated with the filter instance object. The metadata consists of the list of mandatory & optional attributes the caller needs to set in order to create an instance specific entry. 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.

Returns:

an ESDSLdapObject representing the process instance for filter entry.

Throws:

ESDSException - if any error is encountered

setProcessFilterForProc

public void setProcessFilterForProc(java.lang.String filterName,
                                    java.lang.String procDN,
                                    ESDSLdapObject instanceParams)
                             throws ESDSException

This method sets given filter for the given process entry. This API can be used for setting filter at process instance level, process target level or mailprocessconfig level.

Parameters:

filterName - Name of the filter

procDN - name DN of process instance or process target or mailprocessconfig

instanceParams - instance specific parameters for the filter

Returns:

void

Throws:

ESDSException - if any error is encountered

unsetProcessFilterForProc

public void unsetProcessFilterForProc(java.lang.String filterName,
                                      java.lang.String procDN)
                               throws ESDSException

This method unsets the given filter for the given process entry. This API can be used for unsetting filter at process instance level, process target level or mailprocessconfig level.

Parameters:

filterName - Name of the filter

procDN - name DN of process instance or process target or mailprocessconfig

Returns:

void

Throws:

ESDSException - if any error is encountered

modifyProcessFilterParamsForProc

public void modifyProcessFilterParamsForProc(java.lang.String filterName,
                                             java.lang.String procDN,
                                             ESDSLdapObject instanceParams)
                                      throws ESDSException

This method modifies the server specific parameters for the given filter for the given process entry. This API can be used for modifying properties for process instance level, process target level or mailprocessconfig level.

Parameters:

filterName - Name of the filter

procDN - name DN of process instance or process target or mailprocessconfig

instanceParams - instance specific parameters for the filter for modification

Returns:

void

Throws:

ESDSException - if any error is encountered

getProcessFilterParamsForProc

public ESDSLdapObject[] getProcessFilterParamsForProc(java.lang.String procDN,
                                                      java.util.Vector attrs)
                                               throws ESDSException

This method gets the filters and all parameters including instance specific parameters applicable for the given process dn. This API takes care of the inheritance logic.

Parameters:

procDN - name DN of process instance or process target or mailprocessconfig

attrs - list of attributes to fetch - a Vector of String. If attribute is not present at the instance level, it will fetch it from the filter level if it's set there.

Returns:

list of filters and the parameters applicable for the given process dn

Throws:

ESDSException - if any error is encountered

getArchivingFilterMetaData

public ESDSLdapObject getArchivingFilterMetaData()
                                          throws ESDSException

This method returns the metadata for archive filter. This method will return the list of mandatory and optional attributes for the archive filter entry and the metadata associated with the filter object. The metadata for a filter consists of the list of mandatory & optional attributes the caller needs to set in order to create a filter. 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.

Returns:

an ESDSLdapObject representing the process filter entry.

Throws:

ESDSException - if any error is encountered

createArchivingFilter

public void createArchivingFilter(ESDSLdapObject archivefilter)
                           throws ESDSException

This method creates a archiving filter.

Parameters:

filter - The filter parameters

Returns:

void

Throws:

ESDSException - if any error is encountered

getArchivingPolicyMetaData

public ESDSLdapObject getArchivingPolicyMetaData()
                                          throws ESDSException

This method returns the metadata for archive filter. This method will return the list of mandatory and optional attributes for the archive filter entry and the metadata associated with the filter object. The metadata for a filter consists of the list of mandatory & optional attributes the caller needs to set in order to create a filter. 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.

Returns:

an ESDSLdapObject representing the process filter entry.

Throws:

ESDSException - if any error is encountered

createArchivingPolicy

public void createArchivingPolicy(ESDSLdapObject archivePolicy)
                           throws ESDSException

This method creates a archiving filter.

Parameters:

filter - The filter parameters

Returns:

void

Throws:

ESDSException - if any error is encountered

getAllArchivingFilters

public ESDSLdapObject[] getAllArchivingFilters(java.util.Vector attrs)
                                        throws ESDSException

This method returns all archive filters in the system.

Parameters:

attrs - list of attributes to fetch - a Vector of String

Returns:

an array of ESDSLdapObject, each ESDSLdapObject represents a process filter entry. Returns null if no filter is defined.

Throws:

ESDSException - if any error is encountered

getAllArchivingPolicies

public ESDSLdapObject[] getAllArchivingPolicies(java.util.Vector attrs)
                                         throws ESDSException

This method returns all archive policies in the system.

Parameters:

attrs - list of attributes to fetch - a Vector of String

Returns:

an array of ESDSLdapObject, each ESDSLdapObject represents a process filter entry. Returns null if no filter is defined.

Throws:

ESDSException - if any error is encountered

ESDSGetAllArchivingPolicies

public static java.lang.String[] ESDSGetAllArchivingPolicies(ESDSDirServerAccess access,
                                                             ESDSLdapHandle handle)
                                                      throws ESDSException

This method returns names of all archive policies in the system.

Parameters:

handle - - the LDAP connection

Returns:

an array of String containing policy names

Throws:

ESDSException - if any error is encountered

ESDSGetArchivingHashtable

public static java.util.Hashtable ESDSGetArchivingHashtable(ESDSDirServerAccess access,
                                                            ESDSLdapHandle handle)
                                                     throws ESDSException

This method returns names of all archive policies in the system.

Parameters:

handle - - the LDAP connection

Returns:

a hashtable with key containing policy name(String) and value containing int representation of policy

Throws:

ESDSException - if any error is encountered

getArchivingPolicies

public ESDSLdapObject[] getArchivingPolicies(java.lang.String nameFilter,
                                             java.util.Vector attrs)
                                      throws ESDSException

This method returns the archive policies in the system.

Returns:

an array of ESDSLdapObject, each ESDSLdapObject represents a process policy entry. Returns null if no filter is defined.

Throws:

ESDSException - if any error is encountered

setUserArchivingPolicy

public void setUserArchivingPolicy(java.lang.String usermailid,
                                   java.lang.String policyName)
                            throws ESDSException

unsetUserArchivingPolicy

public void unsetUserArchivingPolicy(java.lang.String usermailid)
                              throws ESDSException

deleteArchivingPolicy

public void deleteArchivingPolicy(java.lang.String policyName)
                           throws ESDSException

This method deleted the given archiving policy.

Parameters:

name - The name of filter to be deleted

Returns:

void

Throws:

ESDSException - if any error is encountered

modifyArchivingPolicy

public void modifyArchivingPolicy(ESDSLdapObject archivingPolicy)
                           throws ESDSException

This method modifies the given ar policy.

Parameters:

archivingPolicy - parameters for modification

Returns:

void

Throws:

ESDSException - if any error is encountered