001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2009-2010 Sun Microsystems, Inc. 015 * Portions copyright 2012 ForgeRock AS. 016 */ 017 018package org.forgerock.opendj.ldap.requests; 019 020import java.util.List; 021 022import org.forgerock.opendj.ldap.DecodeException; 023import org.forgerock.opendj.ldap.DecodeOptions; 024import org.forgerock.opendj.ldap.controls.Control; 025import org.forgerock.opendj.ldap.controls.ControlDecoder; 026 027/** 028 * The Abandon operation allows a client to request that the server abandon an 029 * uncompleted operation. 030 * <p> 031 * Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned. 032 */ 033public interface AbandonRequest extends Request { 034 035 @Override 036 AbandonRequest addControl(Control control); 037 038 @Override 039 <C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) 040 throws DecodeException; 041 042 @Override 043 List<Control> getControls(); 044 045 /** 046 * Returns the request ID of the request to be abandoned. 047 * 048 * @return The request ID of the request to be abandoned. 049 */ 050 int getRequestID(); 051 052 /** 053 * Sets the request ID of the request to be abandoned. 054 * 055 * @param id 056 * The request ID of the request to be abandoned. 057 * @return This abandon request. 058 * @throws UnsupportedOperationException 059 * If this abandon request does not permit the request ID to be 060 * set. 061 */ 062 AbandonRequest setRequestID(int id); 063 064}