Return-Path: X-Original-To: apmail-directory-dev-archive@www.apache.org Delivered-To: apmail-directory-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 817DC11074 for ; Tue, 13 May 2014 03:38:32 +0000 (UTC) Received: (qmail 50882 invoked by uid 500); 13 May 2014 03:38:32 -0000 Delivered-To: apmail-directory-dev-archive@directory.apache.org Received: (qmail 50835 invoked by uid 500); 13 May 2014 03:38:32 -0000 Mailing-List: contact dev-help@directory.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "Apache Directory Developers List" Delivered-To: mailing list dev@directory.apache.org Received: (qmail 50828 invoked by uid 99); 13 May 2014 03:38:32 -0000 Received: from minotaur.apache.org (HELO minotaur.apache.org) (140.211.11.9) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 13 May 2014 03:38:32 +0000 Received: from localhost (HELO mail-ve0-f172.google.com) (127.0.0.1) (smtp-auth username elecharny, mechanism plain) by minotaur.apache.org (qpsmtpd/0.29) with ESMTP; Tue, 13 May 2014 03:38:31 +0000 Received: by mail-ve0-f172.google.com with SMTP id oz11so10020387veb.31 for ; Mon, 12 May 2014 20:38:30 -0700 (PDT) MIME-Version: 1.0 X-Received: by 10.58.186.207 with SMTP id fm15mr26132074vec.4.1399952310804; Mon, 12 May 2014 20:38:30 -0700 (PDT) Reply-To: elecharny@apache.org Received: by 10.58.128.1 with HTTP; Mon, 12 May 2014 20:38:30 -0700 (PDT) In-Reply-To: <536FB6ED.6010303@gmail.com> References: <536FB6ED.6010303@gmail.com> Date: Tue, 13 May 2014 05:38:30 +0200 Message-ID: Subject: Re: LdapConnectionTemplate From: Emmanuel Lecharny To: Apache Directory Developers List Content-Type: multipart/alternative; boundary=047d7b67594c3027cd04f93fcc8d --047d7b67594c3027cd04f93fcc8d Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Hi Lucas, I took a bit of time looking at the LdapTemplate implementation. First thing, it's neat. The code is formatted, the Javadoc is mostly present (only a few public methods javadoc are lacking AFAICT, like the ModelFactory interface, this is better than a lot of the classes we have in the server :-) Btw, what we currently do is to add the following Javadoc for methods implementing an interface's method : /** * {@inheritDoc} */ That helps those looking at the code as they know where to look for the javadoc. As a core LDAP developper, I'm not sure that I will ever use this class, but I see the benefit a user make, especially for the search/lookup methods. For the other use case, like add or delete, it's less visible, except that the user will not have to take care of the connection management (moving back the connection to the poll). Overall, great and useful addition ! I guess that we will need to add some pages in the user guide now ;-) (well, the API user guide needs a hell lot of love, we have very little atm :/) Thanks a lot ! =E2=80=8B --047d7b67594c3027cd04f93fcc8d Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable
Hi Lucas,

I took a b= it of time looking at the LdapTemplate implementation. First thing, it'= s neat. The code is formatted, the Javadoc is mostly present (only a few pu= blic methods javadoc are lacking AFAICT, like the ModelFactory interface, t= his is better than a lot of the classes we have in the server :-) Btw, what= we currently do is to add the following Javadoc for methods implementing a= n interface's method :

=C2=A0=C2=A0=C2=A0 /**
=C2=A0=C2=A0=C2=A0=C2=A0 * {@inheritDoc}
= =C2=A0=C2=A0=C2=A0=C2=A0 */

That helps those looking at t= he code as they know where to look for the javadoc.=C2=A0
As a core LDAP developper, I'm not sure that I will ever use th= is class, but I see the benefit a user make, especially for the search/look= up methods. For the other use case, like add or delete, it's less visib= le, except that the user will not have to take care of the connection manag= ement (moving back the connection to the poll).

Overall, great and useful addition !

I guess that we= will need to add some pages in the user guide now ;-) (well, the API user = guide needs a hell lot of love, we have very little atm :/)

Thanks a lot !
=E2=80=8B
--047d7b67594c3027cd04f93fcc8d--