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 * Abandon protocol operation request to terminate an operation already in 027 * progress. 028 * 029 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 030 * @version $Rev: 910150 $ 031 */ 032 public interface InternalAbandonRequest extends InternalRequest 033 { 034 /** Ldap abandon request type code */ 035 MessageTypeEnum TYPE = MessageTypeEnum.ABANDON_REQUEST; 036 037 038 /** 039 * Gets the id of the request operation to terminate. 040 * 041 * @return the id of the request message to abandon 042 */ 043 int getAbandoned(); 044 045 046 /** 047 * Sets the id of the request operation to terminate. 048 * 049 * @param requestId 050 * the sequence id of the request message to abandon 051 */ 052 void setAbandoned( int requestId ); 053 }