001    /*
002     * Copyright 2009-2014 UnboundID Corp.
003     * All Rights Reserved.
004     */
005    /*
006     * Copyright (C) 2009-2014 UnboundID Corp.
007     *
008     * This program is free software; you can redistribute it and/or modify
009     * it under the terms of the GNU General Public License (GPLv2 only)
010     * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011     * as published by the Free Software Foundation.
012     *
013     * This program is distributed in the hope that it will be useful,
014     * but WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016     * GNU General Public License for more details.
017     *
018     * You should have received a copy of the GNU General Public License
019     * along with this program; if not, see <http://www.gnu.org/licenses>.
020     */
021    package com.unboundid.ldap.sdk.migrate.ldapjdk;
022    
023    
024    
025    import com.unboundid.ldap.sdk.ResultCode;
026    import com.unboundid.util.NotExtensible;
027    import com.unboundid.util.NotMutable;
028    import com.unboundid.util.ThreadSafety;
029    import com.unboundid.util.ThreadSafetyLevel;
030    
031    
032    
033    /**
034     * This class provides an exception that may be returned if an operation in
035     * progress is interrupted.
036     * <BR><BR>
037     * This class is primarily intended to be used in the process of updating
038     * applications which use the Netscape Directory SDK for Java to switch to or
039     * coexist with the UnboundID LDAP SDK for Java.  For applications not written
040     * using the Netscape Directory SDK for Java, the
041     * {@link com.unboundid.ldap.sdk.LDAPException} class should be used instead.
042     */
043    @NotExtensible()
044    @NotMutable()
045    @ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
046    public class LDAPInterruptedException
047           extends LDAPException
048    {
049      /**
050       * The serial version UID for this serializable class.
051       */
052      private static final long serialVersionUID = 7867903105944011998L;
053    
054    
055    
056      /**
057       * Creates a new LDAP interrupted exception.
058       */
059      LDAPInterruptedException()
060      {
061        super(null, ResultCode.USER_CANCELED_INT_VALUE);
062      }
063    
064    
065    
066      /**
067       * Creates a new LDAP interrupted exception from the provided
068       * {@link com.unboundid.ldap.sdk.LDAPException} object.
069       *
070       * @param  ldapException  The {@code LDAPException} object to use for this
071       *                        LDAP interrupted exception.
072       */
073      LDAPInterruptedException(
074           final com.unboundid.ldap.sdk.LDAPException ldapException)
075      {
076        super(ldapException);
077      }
078    }