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 * https://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 */ 020package org.apache.directory.api.ldap.extras.extended.endTransaction; 021 022 023import java.util.List; 024 025import org.apache.directory.api.ldap.model.message.ExtendedResponse; 026 027 028/** 029 * The interface for End Transaction Extended Response. It's described in RFC 5805 : 030 * 031 * <pre> 032 * ExtendedResponse ::= [APPLICATION 24] SEQUENCE { 033 * COMPONENTS OF LDAPResult, 034 * responseName [10] LDAPOID OPTIONAL, 035 * responseValue [11] OCTET STRING OPTIONAL } 036 * </pre> 037 * 038 * where the responseName is not present, and the responseValue contains 039 * a BER encoded value, defined by the following grammar : 040 * 041 * <pre> 042 * txnEndRes ::= SEQUENCE { 043 * messageID MessageID OPTIONAL, 044 * -- msgid associated with non-success resultCode 045 * updatesControls SEQUENCE OF updateControls SEQUENCE { 046 * messageID MessageID, 047 * -- msgid associated with controls 048 * controls Controls 049 * } OPTIONAL 050 * } 051 * </pre> 052 * 053 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 054 */ 055public interface EndTransactionResponse extends ExtendedResponse 056{ 057 /** The OID for the Start Transaction extended operation response. */ 058 String EXTENSION_OID = EndTransactionRequest.EXTENSION_OID; 059 060 061 /** 062 * @return The Message ID if failure 063 */ 064 int getFailedMessageId(); 065 066 067 /** 068 * @param failedMessageId The messageId that causes the failure 069 */ 070 void setFailedMessageId( int failedMessageId ); 071 072 073 /** 074 * @return the list of <messageId, Controls> processed within the transaction 075 */ 076 List<UpdateControls> getUpdateControls(); 077}