Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
CaptchaVerifier	33	0	-	0	0	-1.0 -	Show methods

Class CaptchaVerifier

Class CaptchaVerifier	Line # 33	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* See the NOTICE file distributed with this work for additional
3		* information regarding copyright ownership.
4		*
5		* This is free software; you can redistribute it and/or modify it
6		* under the terms of the GNU Lesser General Public License as
7		* published by the Free Software Foundation; either version 2.1 of
8		* the License, or (at your option) any later version.
9		*
10		* This software is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public
16		* License along with this software; if not, write to the Free
17		* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18		* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19		*/
20		package org.xwiki.captcha;
21
22		import javax.servlet.http.HttpServletRequest;
23
24		import org.xwiki.component.annotation.Role;
25
26		/**
27		* The CaptchaVerifier interface allows us to check if an answer to a captcha was correct.
28		*
29		* @version $Id: a0d936242d71802c686690d934d9829710939944 $
30		* @since 2.2M2
31		*/
32		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
33		public interface CaptchaVerifier
34		{
35		/**
36		* Check if the solution to a captcha is correct.
37		*
38		* @param captchaId A String used to identify the captcha which is to be solved because multiple users may
39		* be solving captchas at the same time and which captcha belongs to who can't be confused.
40		* @param answer The provided solution.
41		* @return true if the solution is correct for the identified captcha.
42		* @throws Exception If for some reason the CaptchaService fails or cannot be reached, or if the
43		* CaptchaService has no record of any captcha gotten with the given captchaId.
44		*/
45		boolean isAnswerCorrect(String captchaId, String answer) throws Exception;
46
47		/**
48		* Uses an HttpServletRequest object to get a unique id string to tell different users apart.
49		* depending on the implementation, the id may be the servlet id or a generated value passed through a parameter.
50		*
51		* @param request The HttpServletRequest sent by the user who must be identified.
52		* @return A unique String representing the user who sent the request
53		*/
54		String getUserId(HttpServletRequest request);
55		}