1 /*
2 * Copyright (c) 2002-2022, City of 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 * This Exception should be thrown when an IP failed to login several times, and the authentication service wants to enable Captcha.
40 */
41 public final class FailedLoginCaptchaException extends FailedLoginException
42 {
43 private static final long serialVersionUID = -6833180698556878514L;
44 private final boolean _bEnableCaptcha;
45
46 /**
47 * Creates a new instance of FailedLoginCaptchaException
48 *
49 * @param bEnableCaptcha
50 * True if the captcha should be enabled, false otherwise
51 */
52 public FailedLoginCaptchaException( boolean bEnableCaptcha )
53 {
54 super( );
55 _bEnableCaptcha = bEnableCaptcha;
56 }
57
58 /**
59 * Creates a new instance of FailedLoginCaptchaException
60 *
61 * @param strMessage
62 * The detail message
63 * @param bEnableCaptcha
64 * True if the captcha should be enabled, false otherwise
65 */
66 public FailedLoginCaptchaException( String strMessage, boolean bEnableCaptcha )
67 {
68 super( strMessage );
69 _bEnableCaptcha = bEnableCaptcha;
70 }
71
72 /**
73 * Check if the captcha should be enabled
74 *
75 * @return True if the captcha should be enabled, false otherwise
76 */
77 public boolean isCaptchaEnabled( )
78 {
79 return _bEnableCaptcha;
80 }
81 }