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 032 /** 033 * This class defines an exception that may be thrown if the operation 034 * being processed is cancelled for some reason (e.g., an abandon or 035 * cancel request from the client). 036 */ 037 @org.opends.server.types.PublicAPI( 038 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED, 039 mayInstantiate=true, 040 mayExtend=false, 041 mayInvoke=true) 042 public final class CanceledOperationException 043 extends IdentifiedException 044 { 045 /** 046 * The serial version identifier required to satisfy the compiler 047 * because this class extends <CODE>java.lang.Exception</CODE>, 048 * which implements the <CODE>java.io.Serializable</CODE> interface. 049 * This value was generated using the <CODE>serialver</CODE> 050 * command-line utility included with the Java SDK. 051 */ 052 private static final long serialVersionUID = -1936491673256446966L; 053 054 055 056 // The cancel result that provides information about the status of 057 // the cancellation. 058 private final CancelRequest cancelRequest; 059 060 061 062 /** 063 * Creates a new cancelled operation exception with the provided 064 * result and no additional message. 065 * 066 * @param cancelRequest The result of the cancel processing. 067 */ 068 public CanceledOperationException(CancelRequest cancelRequest) 069 { 070 super(); 071 072 073 this.cancelRequest = cancelRequest; 074 } 075 076 077 078 /** 079 * Creates a new cancelled operation exception with the provided 080 * information. 081 * 082 * @param cancelRequest The request of the cancel processing. 083 * @param message The message providing additional 084 * information about the cancel processing, or 085 * <CODE>null</CODE> if there is no message. 086 */ 087 public CanceledOperationException(CancelRequest cancelRequest, 088 Message message) 089 { 090 super(message); 091 092 093 this.cancelRequest = cancelRequest; 094 } 095 096 097 098 /** 099 * Retrieves the cancel request for this cancelled operation 100 * exception. 101 * 102 * @return The cancel request for this cancelled operation 103 * exception. 104 */ 105 public CancelRequest getCancelRequest() 106 { 107 return cancelRequest; 108 } 109 } 110