1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.service.security;
35
36 import javax.security.auth.login.FailedLoginException;
37
38
39 /**
40 * This Exception should be thrown when an IP failed to login several times, and the authentication service wants to enable Captcha.
41 */
42 public final class FailedLoginCaptchaException extends FailedLoginException
43 {
44 private static final long serialVersionUID = -6833180698556878514L;
45 private final boolean _bEnableCaptcha;
46
47 /**
48 * Creates a new instance of FailedLoginCaptchaException
49 * @param bEnableCaptcha True if the captcha should be enabled, false otherwise
50 */
51 public FailedLoginCaptchaException( boolean bEnableCaptcha )
52 {
53 super( );
54 _bEnableCaptcha = bEnableCaptcha;
55 }
56
57 /**
58 * Creates a new instance of FailedLoginCaptchaException
59 * @param strMessage The detail message
60 * @param bEnableCaptcha True if the captcha should be enabled, false otherwise
61 */
62 public FailedLoginCaptchaException( String strMessage, boolean bEnableCaptcha )
63 {
64 super( strMessage );
65 _bEnableCaptcha = bEnableCaptcha;
66 }
67
68 /**
69 * Check if the captcha should be enabled
70 * @return True if the captcha should be enabled, false otherwise
71 */
72 public boolean isCaptchaEnabled( )
73 {
74 return _bEnableCaptcha;
75 }
76 }