001/*
002 * The MIT License
003 * Copyright (c) 2012 Microsoft Corporation
004 *
005 * Permission is hereby granted, free of charge, to any person obtaining a copy
006 * of this software and associated documentation files (the "Software"), to deal
007 * in the Software without restriction, including without limitation the rights
008 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
009 * copies of the Software, and to permit persons to whom the Software is
010 * furnished to do so, subject to the following conditions:
011 *
012 * The above copyright notice and this permission notice shall be included in
013 * all copies or substantial portions of the Software.
014 *
015 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
016 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
017 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
018 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
019 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
020 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
021 * THE SOFTWARE.
022 */
023
024package microsoft.exchange.webservices.data.core.exception.service.remote;
025
026import microsoft.exchange.webservices.data.core.exception.service.remote.ServiceRemoteException;
027
028import java.net.URI;
029
030/**
031 * Represents an error that occurs when the account that is
032 * being accessed is locked and requires user interaction to be unlocked.
033 */
034public class AccountIsLockedException extends ServiceRemoteException {
035
036  /**
037   * Constant serialized ID used for compatibility.
038   */
039  private static final long serialVersionUID = 1L;
040
041  private URI accountUnlockUrl;
042
043
044  /**
045   * Initializes a new instance of the AccountIsLockedException class.
046   *
047   * @param message          Error message text.
048   * @param accountUnlockUrl URL for client to visit to unlock account.
049   */
050  public AccountIsLockedException(String message, URI accountUnlockUrl,
051      Exception innerException) {
052
053    super(message, innerException);
054    this.setAccountUnlockUrl(accountUnlockUrl);
055  }
056
057  /**
058   * Gets the URL of a web page where the user
059   * can navigate to unlock his or her account.
060   */
061  public URI getAccountUnlockUrl() {
062    return accountUnlockUrl;
063  }
064
065
066  /**
067   * Sets the URL of a web page where the
068   * user can navigate to unlock his or her account.
069   */
070  private void setAccountUnlockUrl(URI value) {
071    this.accountUnlockUrl = value;
072  }
073}