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 */ 020package org.apache.directory.shared.ldap.extras.extended; 021 022import org.apache.directory.shared.ldap.model.message.ExtendedRequest; 023 024 025/** 026 * The CancelRequest interface. 027 * 028 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 029 */ 030public interface CancelRequest extends ExtendedRequest<CancelResponse> 031{ 032 033 /** The requestName for this extended request */ 034 public static final String EXTENSION_OID = "1.3.6.1.1.8"; 035 036 037 /** 038 * @return The id of the Message to cancel. 039 */ 040 public abstract int getCancelId(); 041 042 043 /** 044 * Sets the message to cancel by id. 045 * 046 * @param cancelId The id of the message to cancel. 047 */ 048 public abstract void setCancelId( int cancelId ); 049 050}