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 */
019package org.apache.directory.api.ldap.extras.controls.transaction;
020
021import org.apache.directory.api.ldap.model.message.Control;
022
023/**
024 * The Transaction Specification control. It's defined in RFC 5805.
025 * This control is sent with every update once a transaction is started.
026 * It contains the Transaction ID. 
027 *
028 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
029 */
030public interface TransactionSpecification extends Control
031{
032    /** The Transaction Specification control OID */
033    String OID = "1.3.6.1.1.21.2";
034
035    /**
036     * @return The transaction identifier
037     */
038    byte[] getIdentifier();
039    
040    
041    /**
042     * Set the transaction ID
043     * @param identifier The transaction identifier, an opaque byte array
044     */
045    void setIdentifier( byte[] identifier );
046}