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.extras.extended.startTransaction;
21
22
23 import org.apache.directory.api.ldap.model.message.ExtendedResponse;
24
25
26 /**
27 * The interface for Start Transaction Extended Response. It's described in RFC 5805 :
28 *
29 * <pre>
30 * StartTransactionResponse ::= [APPLICATION 24] SEQUENCE {
31 * COMPONENTS OF LDAPResult,
32 * responseValue [11] OCTET STRING OPTIONAL }
33 * </pre>
34 *
35 * where the responseName is not present, and the responseValue contain
36 * a transaction identifier when the result is SUCCESS.
37 *
38 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
39 */
40 public interface StartTransactionResponse extends ExtendedResponse
41 {
42 /**
43 * @return The transaction ID if success
44 */
45 byte[] getTransactionId();
46 }