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 2008 Sun Microsystems, Inc. 015 * Portions Copyright 2015-2016 ForgeRock AS. 016 */ 017package org.opends.server.types; 018 019/** Base for data structures that define configuration for operations. */ 020@org.opends.server.types.PublicAPI( 021 stability=org.opends.server.types.StabilityLevel.VOLATILE, 022 mayInstantiate=true, 023 mayExtend=false, 024 mayInvoke=true) 025public abstract class OperationConfig { 026 027 /** When true indicates that the operation should stop as soon as possible. */ 028 private boolean cancelled; 029 030 /** 031 * Indicates that this operation has been cancelled and the 032 * operation if executing should finish as soon as possible. 033 */ 034 public void cancel() 035 { 036 this.cancelled = true; 037 } 038 039 /** 040 * Indicates whether this operation has been cancelled. 041 * 042 * @return boolean where true indicates that this 043 * operation has been cancelled and if currently 044 * executing will finish as soon as possible 045 */ 046 public boolean isCancelled() 047 { 048 return this.cancelled; 049 } 050}