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