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.cancel; 021 022 023import org.apache.directory.api.ldap.model.message.ExtendedRequest; 024 025 026/** 027 * The CancelRequest interface, as described in RFC 3909 : 028 * 029 * <pre> 030 * cancelRequestValue ::= SEQUENCE { 031 * cancelID MessageID 032 * -- MessageID is as defined in [RFC2251] 033 * </pre> 034 * 035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 036 */ 037public interface CancelRequest extends ExtendedRequest 038{ 039 /** The OID for the Cancel extended operation request. */ 040 String EXTENSION_OID = "1.3.6.1.1.8"; 041 042 043 /** 044 * @return The id of the Message to cancel. 045 */ 046 int getCancelId(); 047 048 049 /** 050 * Sets the message to cancel by id. 051 * 052 * @param cancelId The id of the message to cancel. 053 */ 054 void setCancelId( int cancelId ); 055}