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     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
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     * docs/licenses/cddl.txt.  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 2011-2014 UnboundID Corp.
026     */
027    
028    package com.unboundid.directory.sdk.http.types;
029    
030    /**
031     * Exception used to indicate authentication failed because the user account
032     * is disabled.
033     */
034    public class UserDisabledAuthenticationException extends AuthenticationException
035    {
036      private static final long serialVersionUID = 3290190132614396910L;
037    
038      /**
039       * Constructs a <code>UserDisabledAuthenticationException</code> with
040       * the specified message.
041       *
042       * @param message the detail message
043       */
044      public UserDisabledAuthenticationException(final String message)
045      {
046        super(message);
047      }
048    
049      /**
050       * Constructs a <code>UserDisabledAuthenticationException</code> with
051       * the specified message and root cause.
052       *
053       * @param message the detail message
054       * @param cause root cause
055       */
056      public UserDisabledAuthenticationException(final String message,
057                                                 final Throwable cause)
058      {
059        super(message, cause);
060      }
061    
062      /**
063       * {@inheritDoc}
064       */
065      @Override
066      public String getErrorCode()
067      {
068        return USER_DISABLED;
069      }
070    }