directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From akaras...@apache.org
Subject svn commit: rev 56418 - incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc
Date Tue, 02 Nov 2004 21:20:54 GMT
Author: akarasulu
Date: Tue Nov  2 13:20:53 2004
New Revision: 56418

Modified:
   incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccDecoder.java
   incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccEncoder.java
   incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccProvider.java
Log:
made changes to encoder interfaces

Modified: incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccDecoder.java
==============================================================================
--- incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccDecoder.java
(original)
+++ incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccDecoder.java
Tue Nov  2 13:20:53 2004
@@ -289,8 +289,7 @@
      * @param a_in the input stream to read and decode PDU bytes from
      * @return org.apache.ldap.common.berlib.snacc.ldap_v3.LDAPMessage snacc stub instance
      */
-    public Object decode( Object a_lock, InputStream a_in )
-        throws ProviderException
+    public Object decode( Object a_lock, InputStream a_in ) throws ProviderException
     {
 		LDAPMessage l_message = new LDAPMessage() ;
         BERDecoder l_decoder = new BERDecoder( a_in ) ;

Modified: incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccEncoder.java
==============================================================================
--- incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccEncoder.java
(original)
+++ incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccEncoder.java
Tue Nov  2 13:20:53 2004
@@ -1,193 +1,5 @@
 /*
- *                                 Apache License
- *                           Version 2.0, January 2004
- *                        http://www.apache.org/licenses/
- *
- *   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
- *
- *   1. Definitions.
- *
- *      "License" shall mean the terms and conditions for use, reproduction,
- *      and distribution as defined by Sections 1 through 9 of this document.
- *
- *      "Licensor" shall mean the copyright owner or entity authorized by
- *      the copyright owner that is granting the License.
- *
- *      "Legal Entity" shall mean the union of the acting entity and all
- *      other entities that control, are controlled by, or are under common
- *      control with that entity. For the purposes of this definition,
- *      "control" means (i) the power, direct or indirect, to cause the
- *      direction or management of such entity, whether by contract or
- *      otherwise, or (ii) ownership of fifty percent (50%) or more of the
- *      outstanding shares, or (iii) beneficial ownership of such entity.
- *
- *      "You" (or "Your") shall mean an individual or Legal Entity
- *      exercising permissions granted by this License.
- *
- *      "Source" form shall mean the preferred form for making modifications,
- *      including but not limited to software source code, documentation
- *      source, and configuration files.
- *
- *      "Object" form shall mean any form resulting from mechanical
- *      transformation or translation of a Source form, including but
- *      not limited to compiled object code, generated documentation,
- *      and conversions to other media types.
- *
- *      "Work" shall mean the work of authorship, whether in Source or
- *      Object form, made available under the License, as indicated by a
- *      copyright notice that is included in or attached to the work
- *      (an example is provided in the Appendix below).
- *
- *      "Derivative Works" shall mean any work, whether in Source or Object
- *      form, that is based on (or derived from) the Work and for which the
- *      editorial revisions, annotations, elaborations, or other modifications
- *      represent, as a whole, an original work of authorship. For the purposes
- *      of this License, Derivative Works shall not include works that remain
- *      separable from, or merely link (or bind by name) to the interfaces of,
- *      the Work and Derivative Works thereof.
- *
- *      "Contribution" shall mean any work of authorship, including
- *      the original version of the Work and any modifications or additions
- *      to that Work or Derivative Works thereof, that is intentionally
- *      submitted to Licensor for inclusion in the Work by the copyright owner
- *      or by an individual or Legal Entity authorized to submit on behalf of
- *      the copyright owner. For the purposes of this definition, "submitted"
- *      means any form of electronic, verbal, or written communication sent
- *      to the Licensor or its representatives, including but not limited to
- *      communication on electronic mailing lists, source code control systems,
- *      and issue tracking systems that are managed by, or on behalf of, the
- *      Licensor for the purpose of discussing and improving the Work, but
- *      excluding communication that is conspicuously marked or otherwise
- *      designated in writing by the copyright owner as "Not a Contribution."
- *
- *      "Contributor" shall mean Licensor and any individual or Legal Entity
- *      on behalf of whom a Contribution has been received by Licensor and
- *      subsequently incorporated within the Work.
- *
- *   2. Grant of Copyright License. Subject to the terms and conditions of
- *      this License, each Contributor hereby grants to You a perpetual,
- *      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- *      copyright license to reproduce, prepare Derivative Works of,
- *      publicly display, publicly perform, sublicense, and distribute the
- *      Work and such Derivative Works in Source or Object form.
- *
- *   3. Grant of Patent License. Subject to the terms and conditions of
- *      this License, each Contributor hereby grants to You a perpetual,
- *      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- *      (except as stated in this section) patent license to make, have made,
- *      use, offer to sell, sell, import, and otherwise transfer the Work,
- *      where such license applies only to those patent claims licensable
- *      by such Contributor that are necessarily infringed by their
- *      Contribution(s) alone or by combination of their Contribution(s)
- *      with the Work to which such Contribution(s) was submitted. If You
- *      institute patent litigation against any entity (including a
- *      cross-claim or counterclaim in a lawsuit) alleging that the Work
- *      or a Contribution incorporated within the Work constitutes direct
- *      or contributory patent infringement, then any patent licenses
- *      granted to You under this License for that Work shall terminate
- *      as of the date such litigation is filed.
- *
- *   4. Redistribution. You may reproduce and distribute copies of the
- *      Work or Derivative Works thereof in any medium, with or without
- *      modifications, and in Source or Object form, provided that You
- *      meet the following conditions:
- *
- *      (a) You must give any other recipients of the Work or
- *          Derivative Works a copy of this License; and
- *
- *      (b) You must cause any modified files to carry prominent notices
- *          stating that You changed the files; and
- *
- *      (c) You must retain, in the Source form of any Derivative Works
- *          that You distribute, all copyright, patent, trademark, and
- *          attribution notices from the Source form of the Work,
- *          excluding those notices that do not pertain to any part of
- *          the Derivative Works; and
- *
- *      (d) If the Work includes a "NOTICE" text file as part of its
- *          distribution, then any Derivative Works that You distribute must
- *          include a readable copy of the attribution notices contained
- *          within such NOTICE file, excluding those notices that do not
- *          pertain to any part of the Derivative Works, in at least one
- *          of the following places: within a NOTICE text file distributed
- *          as part of the Derivative Works; within the Source form or
- *          documentation, if provided along with the Derivative Works; or,
- *          within a display generated by the Derivative Works, if and
- *          wherever such third-party notices normally appear. The contents
- *          of the NOTICE file are for informational purposes only and
- *          do not modify the License. You may add Your own attribution
- *          notices within Derivative Works that You distribute, alongside
- *          or as an addendum to the NOTICE text from the Work, provided
- *          that such additional attribution notices cannot be construed
- *          as modifying the License.
- *
- *      You may add Your own copyright statement to Your modifications and
- *      may provide additional or different license terms and conditions
- *      for use, reproduction, or distribution of Your modifications, or
- *      for any such Derivative Works as a whole, provided Your use,
- *      reproduction, and distribution of the Work otherwise complies with
- *      the conditions stated in this License.
- *
- *   5. Submission of Contributions. Unless You explicitly state otherwise,
- *      any Contribution intentionally submitted for inclusion in the Work
- *      by You to the Licensor shall be under the terms and conditions of
- *      this License, without any additional terms or conditions.
- *      Notwithstanding the above, nothing herein shall supersede or modify
- *      the terms of any separate license agreement you may have executed
- *      with Licensor regarding such Contributions.
- *
- *   6. Trademarks. This License does not grant permission to use the trade
- *      names, trademarks, service marks, or product names of the Licensor,
- *      except as required for reasonable and customary use in describing the
- *      origin of the Work and reproducing the content of the NOTICE file.
- *
- *   7. Disclaimer of Warranty. Unless required by applicable law or
- *      agreed to in writing, Licensor provides the Work (and each
- *      Contributor provides its Contributions) on an "AS IS" BASIS,
- *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- *      implied, including, without limitation, any warranties or conditions
- *      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- *      PARTICULAR PURPOSE. You are solely responsible for determining the
- *      appropriateness of using or redistributing the Work and assume any
- *      risks associated with Your exercise of permissions under this License.
- *
- *   8. Limitation of Liability. In no event and under no legal theory,
- *      whether in tort (including negligence), contract, or otherwise,
- *      unless required by applicable law (such as deliberate and grossly
- *      negligent acts) or agreed to in writing, shall any Contributor be
- *      liable to You for damages, including any direct, indirect, special,
- *      incidental, or consequential damages of any character arising as a
- *      result of this License or out of the use or inability to use the
- *      Work (including but not limited to damages for loss of goodwill,
- *      work stoppage, computer failure or malfunction, or any and all
- *      other commercial damages or losses), even if such Contributor
- *      has been advised of the possibility of such damages.
- *
- *   9. Accepting Warranty or Additional Liability. While redistributing
- *      the Work or Derivative Works thereof, You may choose to offer,
- *      and charge a fee for, acceptance of support, warranty, indemnity,
- *      or other liability obligations and/or rights consistent with this
- *      License. However, in accepting such obligations, You may act only
- *      on Your own behalf and on Your sole responsibility, not on behalf
- *      of any other Contributor, and only if You agree to indemnify,
- *      defend, and hold each Contributor harmless for any liability
- *      incurred by, or claims asserted against, such Contributor by reason
- *      of your accepting any such warranty or additional liability.
- *
- *   END OF TERMS AND CONDITIONS
- *
- *   APPENDIX: How to apply the Apache License to your work.
- *
- *      To apply the Apache License to your work, attach the following
- *      boilerplate notice, with the fields enclosed by brackets "[]"
- *      replaced with your own identifying information. (Don't include
- *      the brackets!)  The text should be enclosed in the appropriate
- *      comment syntax for the file format. We also recommend that a
- *      file or class name and description of purpose be included on the
- *      same "printed page" as the copyright notice for easier
- *      identification within third-party archives.
- *
- *   Copyright [yyyy] [name of copyright owner]
+ *   Copyright 2004 The Apache Software Foundation
  *
  *   Licensed under the Apache License, Version 2.0 (the "License");
  *   you may not use this file except in compliance with the License.
@@ -202,41 +14,34 @@
  *   limitations under the License.
  *
  */
-
-/*
- * $Id: SnaccEncoder.java,v 1.1 2003/04/22 14:57:59 akarasulu Exp $
- *
- * -- (c) LDAPd Group                                                    --
- * -- Please refer to the LICENSE.txt file in the root directory of      --
- * -- any LDAPd project for copyright and distribution information.      --
- *
- */
-
-package org.apache.ldap.common.berlib.snacc ;
+package org.apache.ldap.common.berlib.snacc;
 
 
-import org.apache.ldap.common.message.spi.Provider ;
-import org.apache.ldap.common.message.spi.EncoderSpi ;
+import org.apache.ldap.common.message.spi.Provider;
 import org.apache.ldap.common.message.spi.ProviderException;
+import org.apache.ldap.common.message.spi.ProviderEncoder;
+
 import java.io.OutputStream;
 import org.apache.ldap.common.berlib.snacc.ldap_v3.LDAPMessage;
+import org.apache.commons.codec.EncoderException;
+import org.apache.commons.codec.stateful.EncoderCallback;
+import org.apache.commons.codec.stateful.EncoderMonitor;
 import com.ibm.asn1.BEREncoder;
 import com.ibm.asn1.ASN1Exception;
 import java.io.IOException;
+import java.nio.ByteBuffer;
 
 
 /**
  * Snacc4J provider implementation of a the encoder SPI.
  *
- * @author <a href="mailto:aok123@bellsouth.net">Alex Karasulu</a>
- * @author $Author: akarasulu $
- * @version $Revision: 1.1 $
+ * @author <a href="mailto:directory-dev@incubator.apache.org">Apache Directory Project</a>
+ * @version $Rev$
  */
-public class SnaccEncoder
-	implements EncoderSpi
+public class SnaccEncoder implements ProviderEncoder
 {
     /** Provider owning this encoder SPI implementation */
-	private final Provider m_provider ;
+	private final Provider provider;
 
 
     // ------------------------------------------------------------------------
@@ -247,11 +52,11 @@
     /**
      * Creates an instance of a Snacc4J EncoderSpi implementation.
      *
-     * @param a_provider the owning provider.
+     * @param provider the owning provider.
      */
-	SnaccEncoder( final Provider a_provider )
+	SnaccEncoder( final Provider provider )
     {
-        m_provider = a_provider ;
+        this.provider = provider;
     }
 
 
@@ -267,12 +72,12 @@
      */
     public Provider getProvider()
     {
-        return m_provider ;
+        return this.provider;
     }
 
 
     // ------------------------------------------------------------------------
-    // EncoderSpi Interface Method Implementations
+    // ProviderEncoder Interface Method Implementations
     // ------------------------------------------------------------------------
 
 
@@ -280,9 +85,9 @@
      * Encodes a compiler stub specific ASN.1 message envelope containment tree
      * onto an output stream.
      *
-     * @param a_lock lock object used to exclusively write to the output stream
-     * @param a_out the OutputStream to encode the message envelope onto.
-     * @param a_obj the top-level message envelope stub instance, i.e. for the
+     * @param lock lock object used to exclusively write to the output stream
+     * @param out the OutputStream to encode the message envelope onto.
+     * @param obj the top-level message envelope stub instance, i.e. for the
      * Snacc4J service provider this would be an instance of the LDAPMessage
      * compiler generated stub class.
      * @throws ProviderException to indicate an error while attempting to encode
@@ -290,49 +95,46 @@
      * exceptions encountered while encoding can be held within this subclass
      * of MultiException.
      */
-    public void encode(Object a_lock, OutputStream a_out, Object a_obj)
-        throws ProviderException
+    public void encodeBlocking( Object lock, OutputStream out, Object obj )
     {
-        byte [] l_buf = encode( a_obj ) ;
+        byte [] buf = encodeBlockingByteArray( obj );
 
         // If lock is null perform unsynchronized write.
-        if( a_lock == null )
+        if( lock == null )
         {
             // Log some warnings here about synch dangers.
 
             try
             {
-				a_out.write( l_buf ) ;
-				a_out.flush() ;
+				out.write( buf );
+				out.flush();
             }
             catch( IOException ioe )
             {
-                ProviderException pe = new ProviderException( m_provider ,
-                    "" ) ;
-                pe.addThrowable( ioe ) ;
-                throw pe ;
+                ProviderException pe = new ProviderException( provider , "" );
+                pe.addThrowable( ioe );
+                throw pe;
             }
 
-            return ;
+            return;
         }
 
         // Lock exists so we do synchronized thread safe write.
-		synchronized( a_lock )
+		synchronized( lock )
         {
             try
             {
-				a_out.write( l_buf ) ;
-				a_out.flush() ;
+				out.write( buf );
+				out.flush();
             }
             catch( IOException ioe )
             {
-                ProviderException pe = new ProviderException( m_provider ,
-                    "" ) ;
-                pe.addThrowable( ioe ) ;
-                throw pe ;
+                ProviderException pe = new ProviderException( provider , "" );
+                pe.addThrowable( ioe );
+                throw pe;
             }
 
-			a_lock.notifyAll() ;
+			lock.notifyAll();
 		}
     }
 
@@ -341,7 +143,7 @@
      * Encodes a compiler stub specific ASN.1 message envelope containment tree
      * into byte array.
      *
-     * @param a_obj the top-level message envelope stub instance, i.e. for the
+     * @param obj the top-level message envelope stub instance, i.e. for the
      * Snacc4J service provider this would be an instance of the LDAPMessage
      * compiler generated stub class.
      * @throws ProviderException to indicate an error while attempting to encode
@@ -349,39 +151,68 @@
      * encountered while encoding can be held within this subclass of
      * MultiException.
      */
-    public byte [] encode( Object a_obj )
-        throws ProviderException
+    public byte[] encodeBlockingByteArray( Object obj ) throws ProviderException
     {
-        byte [] l_buf = null ;
-        BEREncoder l_encoder = null ;
-        LDAPMessage l_message = null ;
+        byte [] buf = null;
+        BEREncoder encoder = null;
+        LDAPMessage message = null;
 
         try
         {
-            l_message = (LDAPMessage) a_obj ;
+            message = (LDAPMessage) obj;
         }
         catch( ClassCastException cce )
         {
-            ProviderException pe = new ProviderException( m_provider,
+            ProviderException pe = new ProviderException( provider,
                 "Supplied message envelope object not recognized as a Snacc4J"
-                + " LDAPv3 envelope stub!" ) ;
-            pe.addThrowable( cce ) ;
-            throw pe ;
+                + " LDAPv3 envelope stub!" );
+            pe.addThrowable( cce );
+            throw pe;
         }
 
         // Initialize encoder and begin encoding process.
-        l_encoder = new BEREncoder() ;
+        encoder = new BEREncoder();
 
-        try {
-	        l_message.encode( l_encoder ) ;
-	        l_buf = l_encoder.toByteArray() ;
-        } catch( ASN1Exception e ) {
-            ProviderException pe = new ProviderException( m_provider,
-                "Snacc4J BEREncoder failed to encode message!" ) ;
-            pe.addThrowable( e ) ;
-            throw pe ;
+        try
+        {
+	        message.encode( encoder );
+	        buf = encoder.toByteArray();
         }
+        catch( ASN1Exception e )
+        {
+            ProviderException pe = new ProviderException( provider,
+                "Snacc4J BEREncoder failed to encode message!" );
+            pe.addThrowable( e );
+            throw pe;
+        }
+
+        return buf;
+    }
+
+
+    public ByteBuffer encodeBlocking( Object obj ) throws ProviderException
+    {
+        return ByteBuffer.wrap( encodeBlockingByteArray( obj ) );
+    }
 
-        return l_buf ;
+
+    // ------------------------------------------------------------------------
+    // StatefulEncoder interfaces
+    // ------------------------------------------------------------------------
+
+
+    public void encode( Object obj ) throws EncoderException
+    {
+        throw new UnsupportedOperationException( "this encoder is not stateful" );
+    }
+
+
+    public void setCallback( EncoderCallback cb )
+    {
+    }
+
+
+    public void setEncoderMonitor( EncoderMonitor monitor )
+    {
     }
 }

Modified: incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccProvider.java
==============================================================================
--- incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccProvider.java
(original)
+++ incubator/directory/ldap/trunk/snacc-provider/src/java/org/apache/ldap/common/berlib/snacc/SnaccProvider.java
Tue Nov  2 13:20:53 2004
@@ -215,11 +215,7 @@
 package org.apache.ldap.common.berlib.snacc ;
 
 
-import org.apache.ldap.common.message.spi.Provider ;
-import org.apache.ldap.common.message.spi.EncoderSpi ;
-import org.apache.ldap.common.message.spi.ProviderDecoder ;
-import org.apache.ldap.common.message.spi.TransformerSpi ;
-import org.apache.ldap.common.message.spi.ProviderException ;
+import org.apache.ldap.common.message.spi.*;
 
 
 /**
@@ -259,7 +255,7 @@
     // ------------------------------------------------------------------------
 
     /** This provider's EncoderSpi implementation */
-    private final EncoderSpi m_encoder ;
+    private final ProviderEncoder m_encoder ;
     /** This provider's Decoder implementation */
     private final ProviderDecoder decoder ;
     /** This provider's TransformerSpi implementation */
@@ -275,8 +271,7 @@
      * Creates an instance of a Provider extracting the required parameter
      * information from a composite set of properties.
      */
-    public SnaccProvider()
-        throws ProviderException
+    public SnaccProvider() throws ProviderException
     {
         super( "Snacc4J BER Library Provider", "IBM Alphaworks" ) ;
 		m_encoder = new SnaccEncoder( this ) ;
@@ -304,7 +299,7 @@
      *
      * @return an instance of the EncoderSpi implementation.
      */
-    public EncoderSpi getEncoder()
+    public ProviderEncoder getEncoder()
     {
         return m_encoder ;
     }

Mime
View raw message