| java.lang.Object
 com.sun.addressbook.ABStore
com.sun.addressbook.ldap.LdapABStore
| LdapABStore | | public class LdapABStore extends ABStore (Code) | | Ldap Adapter Address Book Store implementation: encapsulates the
commands to be carried out on the address book.
Required properties are:
ab.host - Ldap server host name.
ab.port - Ldap server port name.
ab.ldap.authId - Authentication dn for the administrator of Address book.
ab.ldap.authPw - Password of the admin of the address book.
ab.ldap.dirSearchBase - Searchbase of the iMS directory. e.g. o=iplanet.com .
ab.ldap.pabSearchBase - SearchBase of the address book tree. e.g. o=pab .
ab.userName - User id of the address book user.
Optional properties
ab.ldap.lang - locale of the user. Defaults to LdapABConstants.LANG.
ab.ldap.connPoolMin - Initial number of connections in the ldap
connection pool. This defaults to
LdapABConstants.CONNPOOL_MIN.
ab.ldap.connPoolMax - Maximum size of the connection pool. Above this
value, new requests block till a connection is
freed up. Defaults to LdapABConstants.CONNPOOL_MAX.
ab.ldap.timeout - Specifies the maximum number of milliseconds to
wait for the reults before timing out. Defaults to
LdapABConstants.CONN_TIMEOUT.
iMS Ldap has stores only a single set of address fields. It is assumed that
the address maps to home address. If it has to map to business address, the
business address will have to be stored into the home address fields. The attributes
stored in the iMS address book are: ln, cn, fn, description, homeStreet, homeCity,
homeState, homeZip, homeCountry, bp, fp, hp, mp, pp, dob, uri, memberofpab,
memberofpabgroup, em.
|
| Method Summary | |
| void | LDAPClose(LDAPConnection ld)
Close LDAP Connection. | | LDAPConnection | LDAPConnect()
Get a LDAP connection to LDAP Database. | | public void | closeAddressBook(AddressBook ab)
Method to close a currently opened address book. | | public void | closePool()
Close the connection pool to the address book store and remove it from
the connection pool table. | | public void | connect()
Connect to the address book server and create a connection pool for the
server if not already present. | | public String | createAB()
Create an address book if one doesnt exist beforehand. | | public void | disconnect()
| | public String[] | getAddressBooks()
Get the list of address books id's of the user. | | protected String | getDefaultAbID()
Method to get the user's default address book id. | | protected String | getFullPabSearchBase()
| | protected String | getPabLang()
| | public void | init(ABSession session)
Initializes and verifies the properties passed, required by the ldap
store. | | public boolean | isConnected()
Checks if we are able to get a valid non-null connection from the
connection pool table. | | public AddressBook | openAddressBook(String abID)
Method to retrieve a address book from the backend service. |
| LDAPClose | | void LDAPClose(LDAPConnection ld)(Code) | | Close LDAP Connection.
Parameters:
LDAPConnection - object to return to the connection pool. |
| LDAPConnect | | LDAPConnection LDAPConnect()(Code) | | Get a LDAP connection to LDAP Database.
LDAPConnection object obtained from the connection pool. |
| closeAddressBook | | public void closeAddressBook(AddressBook ab) throws ABStoreException(Code) | | Method to close a currently opened address book. In this case,
there is nothing to do to close the address book.
Parameters:
ab - A specific address book.
exception:
ABStoreException - if unable to close the specified calendar |
| closePool | | public void closePool() throws ABStoreException(Code) | | Close the connection pool to the address book store and remove it from
the connection pool table.
exception:
ABStoreException - if unable to connect to back end service. |
| connect | | public void connect() throws ABStoreException(Code) | | Connect to the address book server and create a connection pool for the
server if not already present.
As the iMS Address Book needs admin authentication instead of user
auth, the connect doesnt need to authenticate the credentials
of the user.
exception:
ABStoreException - if unable to connect to back end service. |
| createAB | | public String createAB() throws ABStoreException(Code) | | Create an address book if one doesnt exist beforehand.
Create this user's paburi, ou and pab entries.
addressBookId - the id of the address book that got created.
exception:
ABStoreException - if unable to connect to back end service. |
| disconnect | | public void disconnect() throws ABStoreException(Code) | | No connection specific stuff happens in ldap adapter, so no need
to do anything here
exception:
ABStoreException - if unable to connect to back end service. |
| getDefaultAbID | | protected String getDefaultAbID() throws ABStoreException(Code) | | Method to get the user's default address book id. This returns the
first address book id encountered in the search.
The address book id corresponding to the authenticated user. |
| getFullPabSearchBase | | protected String getFullPabSearchBase()(Code) | | |
| init | | public void init(ABSession session) throws MissingPropertiesException, ABStoreException(Code) | | Initializes and verifies the properties passed, required by the ldap
store. Also establishes a connection pool if one hasnt been instantiated
earlier. For the list of properties refer to the properties listed in the
class description.
|
| isConnected | | public boolean isConnected() throws ABStoreException(Code) | | Checks if we are able to get a valid non-null connection from the
connection pool table.
boolean indicating whether the address book is connected.
exception:
ABStoreException - if unable to connect to back end service. |
| openAddressBook | | public AddressBook openAddressBook(String abID) throws ABStoreException(Code) | | Method to retrieve a address book from the backend service.
Parameters:
abID - A specific address book ID The specified address book
exception:
ABStoreException - if unable to load the specified calendar |
|
|