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 2008 Sun Microsystems, Inc. 025 * Portions Copyright 2015 ForgeRock AS. 026 */ 027 028package org.opends.server.types; 029 030/** 031 * Base for data structures that define configuration 032 * for operations. 033 */ 034@org.opends.server.types.PublicAPI( 035 stability=org.opends.server.types.StabilityLevel.VOLATILE, 036 mayInstantiate=true, 037 mayExtend=false, 038 mayInvoke=true) 039public abstract class OperationConfig { 040 041 /** 042 * When true indicates that the operation should stop as soon as 043 * possible. 044 */ 045 private boolean cancelled; 046 047 /** 048 * Indicates that this operation has been cancelled and the 049 * operation if executing should finish as soon as possible. 050 */ 051 public void cancel() 052 { 053 this.cancelled = true; 054 } 055 056 /** 057 * Indicates whether or not this operation has been 058 * cancelled. 059 * 060 * @return boolean where true indicates that this 061 * operation has been cancelled and if currently 062 * executing will finish as soon as possible 063 */ 064 public boolean isCancelled() 065 { 066 return this.cancelled; 067 } 068}