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