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.captcha;
35
36 import javax.servlet.http.HttpServletRequest;
37
38
39 /**
40 * The interface for Captcha security service
41 */
42 public interface ICaptchaSecurityService
43 {
44 String EMPTY_STRING = "";
45
46 /**
47 * Return an EMPTY_STRING if service is not available nor active
48 * @return the html code of a captcha
49 */
50 String getHtmlCode( );
51
52 /**
53 * @return the html code used by an admin to activate the captcha
54 */
55 String getActiveBlockHtml( );
56
57 /**
58 * Validates a captcha only if the service is available and active
59 * @param request the request, which must contain the parameter j_captcha_response
60 * @return true if captcha is valid or service is not available
61 */
62 boolean validate( HttpServletRequest request );
63
64 /**
65 * Activate the service for the current client
66 * @param bActive True to activate, otherwise false
67 */
68 void setActive( boolean bActive );
69
70 /**
71 * @return true if a captcha security service is loaded
72 */
73 boolean isAvailable( );
74
75 /**
76 * @return true if the service is active for the current client
77 */
78 boolean isActive( );
79 }