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    package org.apache.directory.shared.ldap.message;
021    
022    
023    /**
024     * Extended protocol response message used to confirm the results of a extended
025     * request message.
026     * 
027     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028     * @version $Revision: 764131 $
029     */
030    public interface InternalExtendedResponse extends InternalResultResponse, javax.naming.ldap.ExtendedResponse
031    {
032        /** Extended response message type enumeration value */
033        MessageTypeEnum TYPE = MessageTypeEnum.EXTENDED_RESP;
034    
035    
036        /**
037         * Gets the OID uniquely identifying this extended response (a.k.a. its
038         * name).
039         * 
040         * @return the OID of the extended response type.
041         */
042        String getResponseName();
043    
044    
045        /**
046         * Sets the OID uniquely identifying this extended response (a.k.a. its
047         * name).
048         * 
049         * @param oid
050         *            the OID of the extended response type.
051         */
052        void setResponseName( String oid );
053    
054    
055        /**
056         * Gets the reponse OID specific encoded response values.
057         * 
058         * @return the response specific encoded response values.
059         */
060        byte[] getResponse();
061    
062    
063        /**
064         * Sets the reponse OID specific encoded response values.
065         * 
066         * @param value
067         *            the response specific encoded response values.
068         */
069        void setResponse( byte[] value );
070    }