oracle.mail
Class OESUserFactory

java.lang.Object
  |
  +--oracle.mail.OESUserFactory

public class OESUserFactory

extends java.lang.Object

This singleton stores Email application settings and data. This is also the access point for getting any OES User. The OES User stores preferences and data for an Email user.
Currently, you can only get a user within an IAS environment using the user's DN (getOCSUserFromDN). Sample code to get an OES User: <quote>OCSUserFactory ocsUserFactory = OCSUserFactory.getInstance();
OCSUser ocsUser = userFactory.getOCSUserFromDN...
OESUserFactory oesUserFactory = OESUserFactory.getInstance();
OESUser oesUser = oesUserFactory.getOESUser...</quote>

Method Summary

OESUser	getEmailUser(java.lang.String host, int port, java.lang.String user, java.lang.String password) This factory method takes in a hostname, port, user's full email address, user's password.
OESUser[]	getEmailUserList(oracle.collabsuite.OCSUser ocsUser) This method has not been implemented.
OESUser	getFirstValidEmailUser(oracle.collabsuite.OCSUser ocsUser) This factory method takes in a authenticated OCSUser and returns the first available OESUser object for the OCSUser.
static OESUserFactory	getInstance() Get the singleton
OESUser	getOESUser(java.lang.String mail) This method returns a user given the user's email address.
OESUser	getOESUser(java.lang.String emailAddress, java.lang.String password) This method has not been implemented.
java.lang.String[]	getValidEmailAddresses(oracle.collabsuite.OCSUser ocsUser) This method takes in an authenticated OCSUser and returns all valid Oracle Email addresses for the OCSUser.
static void	main(java.lang.String[] argv)
OESUser[]	searchEmailUsers(java.lang.String criteria, java.lang.String domain, int limit)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OESUserFactory getInstance()

Get the singleton

getEmailUser

public OESUser getEmailUser(java.lang.String host,
                            int port,
                            java.lang.String user,
                            java.lang.String password)
                     throws java.lang.Exception

This factory method takes in a hostname, port, user's full email address, user's password. For a OJMA mailstor, the following two properties have to be set: oracle.mail.ldap.admin_dn=<dn for the umadmin or orcladmin> oracle.mail.ldap.admin_password

Parameters:

user - user's email address

password - user's email password

host - ldap hostname for ojma; imap hostname for imap

port - ldap port for ojma; imap hostname for imap

getOESUser

public OESUser getOESUser(java.lang.String emailAddress,
                          java.lang.String password)
                   throws OESException

This method has not been implemented. This method authenticates a user given the user's email address and password

Parameters:

emailAddress - user's email address

password - user's email password

getOESUser

public OESUser getOESUser(java.lang.String mail)
                   throws OESException

This method returns a user given the user's email address. This method should only be used by trusted application. It will be based on the service to service authentication mechanism.

Parameters:

emailAddress - user's email address

getFirstValidEmailUser

public OESUser getFirstValidEmailUser(oracle.collabsuite.OCSUser ocsUser)
                               throws java.lang.Exception

This factory method takes in a authenticated OCSUser and returns the first available OESUser object for the OCSUser.

Parameters:

ocsUser - the public user generated by OCSUserFactory

Returns:

OES User, null if the OCS User does not have any valid email accounts.

getValidEmailAddresses

public java.lang.String[] getValidEmailAddresses(oracle.collabsuite.OCSUser ocsUser)
                                          throws java.lang.Exception

This method takes in an authenticated OCSUser and returns all valid Oracle Email addresses for the OCSUser.

Parameters:

ocsUser - the public user generated by OCSUserFactory

Returns:

email addresses, null if the OCS User does not have any valid email accounts.

getEmailUserList

public OESUser[] getEmailUserList(oracle.collabsuite.OCSUser ocsUser)
                           throws java.lang.Exception

This method has not been implemented. This factory method takes in a authenticated OCSUser and returns the list of OESUser objects for the OCSUser.

Parameters:

ocsUser - the public user generated by OCSUserFactory

Returns:

OESUser array - In OCS Email, each public user can have several email accounts associated with it. This call returns all email accounts associated with a public user.

searchEmailUsers

public OESUser[] searchEmailUsers(java.lang.String criteria,
                                  java.lang.String domain,
                                  int limit)
                           throws java.lang.Exception

main

public static void main(java.lang.String[] argv)