001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    
021    package org.apache.directory.shared.ldap.message.spi;
022    
023    
024    import java.io.InputStream;
025    
026    import org.apache.directory.shared.asn1.codec.stateful.StatefulDecoder;
027    
028    
029    /**
030     * Standard decoder service provider interface. BER decoders generating ASN.1
031     * compiler stub based containment tree for a provider are expected to implement
032     * this interface.
033     * 
034     * @author <a href="mailto:dev@directory.apache.org"> Apache Directory Project</a>
035     * @version $Rev: 437007 $
036     */
037    public interface ProviderDecoder extends ProviderObject, StatefulDecoder
038    {
039        /**
040         * Decodes a BER encoded LDAPv3 ASN.1 message envelope from a binary input
041         * stream into an in memory containment tree using stub's generated by a
042         * provider's ASN.1 stub compiler and associated runtime BER libraries.
043         * 
044         * @param lock
045         *            lock object used to exclusively read from the input stream
046         * @param in
047         *            the binary input stream where the encoded message PDU is read
048         * @return an object representing the top-most containment tree object which
049         *         represents the entire message envelope. For the Snacc provider
050         *         this object would be a populated instance of LDAPMessage.
051         * @throws ProviderException
052         *             to indicate an error while attempting to decode the message
053         *             envelope onto the output stream. Provider specific exceptions
054         *             encountered while decoding can be held within this subclass
055         *             of MultiException.
056         */
057        Object decode( Object lock, InputStream in ) throws ProviderException;
058    }