Return-Path: Delivered-To: apmail-directory-commits-archive@www.apache.org Received: (qmail 26959 invoked from network); 31 Jan 2011 15:37:43 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 31 Jan 2011 15:37:43 -0000 Received: (qmail 11887 invoked by uid 500); 31 Jan 2011 15:37:43 -0000 Delivered-To: apmail-directory-commits-archive@directory.apache.org Received: (qmail 11831 invoked by uid 500); 31 Jan 2011 15:37:41 -0000 Mailing-List: contact commits-help@directory.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@directory.apache.org Delivered-To: mailing list commits@directory.apache.org Received: (qmail 11824 invoked by uid 99); 31 Jan 2011 15:37:40 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 31 Jan 2011 15:37:40 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 31 Jan 2011 15:37:38 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 7AA3123889F7; Mon, 31 Jan 2011 15:37:17 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1065653 - in /directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap: codec/BasicControlDecorator.java model/message/controls/BasicControl.java Date: Mon, 31 Jan 2011 15:37:17 -0000 To: commits@directory.apache.org From: akarasulu@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110131153717.7AA3123889F7@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: akarasulu Date: Mon Jan 31 15:37:17 2011 New Revision: 1065653 URL: http://svn.apache.org/viewvc?rev=1065653&view=rev Log: cleaning up and documenting BasicControl and its IDecorator Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/codec/BasicControlDecorator.java directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/model/message/controls/BasicControl.java Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/codec/BasicControlDecorator.java URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/codec/BasicControlDecorator.java?rev=1065653&r1=1065652&r2=1065653&view=diff ============================================================================== --- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/codec/BasicControlDecorator.java (original) +++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/codec/BasicControlDecorator.java Mon Jan 31 15:37:17 2011 @@ -32,15 +32,23 @@ import org.apache.directory.shared.ldap. /** - * A decorator for an opaque control where we know nothing about encoded values. + * A decorator for handling opaque Control objects where we know nothing about + * their encoded value. These Controls are generated by default when an + * {@link IControlFactory} for them has not been registered with the + * {@link ILdapCodecService}. * * @author Apache Directory Project * @version $Rev$, $Date$ */ public class BasicControlDecorator extends ControlDecorator { - private ILdapCodecService codec; - + /** + * Creates a new instance of BasicControlDecorator, decorating a + * {@link BasicControl}. + * + * @param codec The LDAP codec service. + * @param control The {@link BasicControl} to decorate. + */ public BasicControlDecorator( ILdapCodecService codec, BasicControl control ) { super( codec, control ); Modified: directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/model/message/controls/BasicControl.java URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/model/message/controls/BasicControl.java?rev=1065653&r1=1065652&r2=1065653&view=diff ============================================================================== --- directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/model/message/controls/BasicControl.java (original) +++ directory/shared/trunk/ldap/src/main/java/org/apache/directory/shared/ldap/model/message/controls/BasicControl.java Mon Jan 31 15:37:17 2011 @@ -20,11 +20,15 @@ package org.apache.directory.shared.ldap.model.message.controls; +import org.apache.directory.shared.ldap.codec.ILdapCodecService; import org.apache.directory.shared.ldap.model.message.Control; /** - * A Control base class. + * A simple implementation of the {@link Control} interface with storage for + * the OID and the criticality properties. When a {@link ILdapCodecService} + * implementation does not have specific control factories available, hence + * the control is unrecognized, it creates instances of this control for them. * * @author Apache Directory Project */ @@ -49,6 +53,19 @@ public class BasicControl implements Con /** + * Creates a Control with a specific OID, and criticality set. + * + * @param oid The OID of this Control. + * @param criticality true if this Control is critical, false otherwise. + */ + public BasicControl( String oid, boolean criticality ) + { + this.oid = oid; + this.criticality = criticality; + } + + + /** * Get the OID * * @return A string which represent the control oid