1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.codec.api;
21
22
23 import org.apache.directory.api.asn1.DecoderException;
24 import org.apache.directory.api.asn1.util.Asn1Buffer;
25 import org.apache.directory.api.ldap.model.message.IntermediateResponse;
26
27
28 /**
29 * The factory interface, defined by the codec API, for creating new
30 * Intermediate responses.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public interface IntermediateOperationFactory
35 {
36 /**
37 * Gets the OID of the IntermediateResponse this factory generates.
38 *
39 * @return the extended request OID
40 */
41 String getOid();
42
43
44 /**
45 * Returns a new {@link IntermediateResponse} with no value.
46 *
47 * @return the extended response type
48 */
49 IntermediateResponse newResponse();
50
51
52 /**
53 * Returns a new {@link IntermediateResponse} with the following encoded value.
54 *
55 * @param value the encoded value
56 * @return the extended response type
57 */
58 IntermediateResponse newResponse( byte[] value );
59
60
61 /**
62 * Encode the value part of the intermediate response operation.
63 *
64 * @param buffer The buffer into which to put the encoded value
65 * @param intermediateResponse The IntermediateResponse Operation to encode
66 */
67 void encodeValue( Asn1Buffer buffer, IntermediateResponse intermediateResponse );
68
69
70 /**
71 * Decode the value part of the intermediate response operation.
72 *
73 * @param intermediateResponse The IntermediateResponse Operation to feed
74 * @param responseValue The response value to decode
75 * @throws DecoderException If the value cannot be decoded
76 */
77 void decodeValue( IntermediateResponse intermediateResponse, byte[] responseValue ) throws DecoderException;
78 }