Mailing-List: contact dev-help@directory.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Apache Directory Developers List" <dev@directory.apache.org>
Received-SPF: pass (athena.apache.org: domain of akarasulu@gmail.com
 designates 74.125.44.28 as permitted sender)
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=gamma;
        h=message-id:date:from:sender:to:subject:in-reply-to:mime-version
         :content-type:references:x-google-sender-auth;
        b=ifjxQCjvKxtCEFz9IJlzRO/gubJTn99lYgVR2w5JKIM5YJR0jOsPsu7OE4+QBCSh/f
         5xUryoHlsh3c+5aZy604Kwk2YaaVR0pSHSW7EpzWoT688C5uzU0YGZKufWM6+s/ptZ+e
         om2mdMpTcV8UjzvCFDM/+FH+yimob46x31B+w=
Message-ID: <a32f6b020808011002pfa502ct805044222335f8ca@mail.gmail.com>
Date: Fri, 1 Aug 2008 13:02:32 -0400
From: "Alex Karasulu" <akarasulu@apache.org>
Sender: akarasulu@gmail.com
To: dev@directory.apache.org
Subject: Re: svn commit: r681463 - in
 /directory/apacheds/branches/bigbang/core/src/main/java/org/apache/directory/server/core/changelog:
 ChangeLog.java DefaultChangeLog.java
In-Reply-To: <20080731195803.2F5C3238889C@eris.apache.org>
MIME-Version: 1.0
Content-Type: multipart/alternative;
	boundary="----=_Part_7670_26768938.1217610152175"
References: <20080731195803.2F5C3238889C@eris.apache.org>

------=_Part_7670_26768938.1217610152175
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

On Thu, Jul 31, 2008 at 3:58 PM, <kayyagari@apache.org> wrote:

> Author: kayyagari
> Date: Thu Jul 31 12:58:02 2008
> New Revision: 681463
>
> URL: http://svn.apache.org/viewvc?rev=681463&view=rev
> Log:
> made the changelog partition suffix configurable
> included the default values for the same
>
> +    void setPartitionSuffix( String suffix );
> +


This is a DN I take it?


>
> +    void setRevOuSuffix( String revOuSuffix );
> +


This is not a DN?  Is it the value of the ou attribute?  There is no
javadocs here.  Please do not add interface methods without javadocs.

>
>
> +    void setTagOuSuffix( String tagOuSuffix );
>


Without Javadocs to help understand I think these names are not very
intuitive especially since suffix is usually used to mean the base DN of a
partition attached to the DIT: the namingContext.  Perhaps
setRevisionsContainerValue() and setTagContainerValue() or
setRevisionsContainerName() and setTagContainerName() might be best.  Don't
know but it's better than using suffix.

Providing a DN may be an issue because then your container has to allow the
presence of the rdn value.  Might give too much freedom where you want to
constrain.

Please add some documentation so these new interface methods better
understood: we cannot accept undocumented code in general but with key
interfaces that are part of an SPI in ApacheDS it's even more unacceptible.
Please don't make a habit of this.

Alex

------=_Part_7670_26768938.1217610152175
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

<div dir="ltr"><br><div class="gmail_quote">On Thu, Jul 31, 2008 at 3:58 PM,  <span dir="ltr">&lt;<a href="mailto:kayyagari@apache.org">kayyagari@apache.org</a>&gt;</span> wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
Author: kayyagari<br>
Date: Thu Jul 31 12:58:02 2008<br>
New Revision: 681463<br>
<br>
URL: <a href="http://svn.apache.org/viewvc?rev=681463&amp;view=rev" target="_blank">http://svn.apache.org/viewvc?rev=681463&amp;view=rev</a><br>
Log:<br>
made the changelog partition suffix configurable<br>
included the default values for the same<br>
<br>
+ &nbsp; &nbsp;void setPartitionSuffix( String suffix );<br>
+</blockquote><div><br>This is a DN I take it?<br>&nbsp;</div><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"><br>
+ &nbsp; &nbsp;void setRevOuSuffix( String revOuSuffix );<br>
+</blockquote><div><br>This is not a DN?&nbsp; Is it the value of the ou attribute?&nbsp; There is no javadocs here.&nbsp; Please do not add interface methods without javadocs.&nbsp; <br>&nbsp;<blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
<br>
+ &nbsp; &nbsp;void setTagOuSuffix( String tagOuSuffix );<br>
</blockquote><br>
<br>Without Javadocs to help understand I think these names are not very intuitive especially since suffix is usually used to mean the base DN of a partition attached to the DIT: the namingContext.&nbsp; Perhaps setRevisionsContainerValue() and setTagContainerValue() or setRevisionsContainerName() and setTagContainerName() might be best.&nbsp; Don&#39;t know but it&#39;s better than using suffix.&nbsp; <br>
<br>Providing a DN may be an issue because then your container has to allow the presence of the rdn value.&nbsp; Might give too much freedom where you want to constrain.<br></div></div><br>Please add some documentation so these new interface methods better understood: we cannot accept undocumented code in general but with key interfaces that are part of an SPI in ApacheDS it&#39;s even more unacceptible.&nbsp; Please don&#39;t make a habit of this.<br>
<br>Alex<br><br><br>
</div>

------=_Part_7670_26768938.1217610152175--