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
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2006-2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.types;
028 import org.opends.messages.Message;
029
030 /**
031 * This class defines a data structure that can be used to hold
032 * information about a request to cancel or abandon an operation in
033 * progress.
034 */
035 @org.opends.server.types.PublicAPI(
036 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
037 mayInstantiate=false,
038 mayExtend=false,
039 mayInvoke=true)
040 public final class CancelRequest
041 {
042 // Indicates whether to send a response to the original request if
043 // the operation is canceled.
044 private final boolean notifyOriginalRequestor;
045
046 // A message that explains the purpose for this cancellation (may be
047 // included in the response to the original requestor).
048 private final Message cancelReason;
049
050
051
052 /**
053 * Creates a new cancel request with the provided information.
054 *
055 * @param notifyOriginalRequestor Indicates whether the original
056 * requestor should receive a
057 * response if the operation is
058 * canceled.
059 * @param cancelReason A message that explains the
060 * purpose for this cancellation.
061 */
062 public CancelRequest(boolean notifyOriginalRequestor,
063 Message cancelReason)
064 {
065 this.notifyOriginalRequestor = notifyOriginalRequestor;
066 this.cancelReason = cancelReason;
067 }
068
069
070
071 /**
072 * Indicates whether the original requestor should receive a
073 * response to the request if the operation is canceled.
074 *
075 * @return <CODE>true</CODE> if the original requestor should
076 * receive a response if the operation is canceled, or
077 * <CODE>false</CODE> if not.
078 */
079 public boolean notifyOriginalRequestor()
080 {
081 return notifyOriginalRequestor;
082 }
083
084
085
086 /**
087 * Retrieves a message that explains the purpose for this
088 * cancellation.
089 *
090 * @return A message that explains the purpose for this
091 * cancellation.
092 */
093 public Message getCancelReason()
094 {
095 return cancelReason;
096 }
097 }
098