Package org.ametys.plugins.core.impl.captcha.jcaptcha

Class JCaptcha

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.captcha.AbstractCaptcha

org.ametys.plugins.core.impl.captcha.jcaptcha.JCaptcha

All Implemented Interfaces:

Captcha, LogEnabled, PluginAware, Configurable

public class JCaptcha
extends AbstractCaptcha

Captcha implementation with images

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JCaptcha.ValidableCaptcha	Bean for a captcha and a validity date

Field Summary

Fields

Modifier and Type	Field	Description
protected static Map<String,JCaptcha.ValidableCaptcha>	_mapDynamicCaptcha	Map of dynamic captchas
protected static Map<String,List<JCaptcha.ValidableCaptcha>>	_mapStaticCaptcha	Map of static captchas
protected static final String	DYNAMIC_PREFIX_KEY	Prefix for dynamic captchas
protected static final String	STATIC_PREFIX_KEY	Prefix for static captchas

Constructor Summary

Constructors

Constructor	Description
JCaptcha()

Method Summary

Modifier and Type	Method	Description
boolean	checkAndInvalidateCaptcha(String key, String value)	Check if the Captcha is correct
void	cleanOldCaptchas()	Clean the outdated captchas
BufferedImage	generateImageCaptcha(String key, Integer color, boolean addNoise, boolean fisheye, int width, int height)	Generate an image captcha to PNG format.
I18nizableText	getLabel()	Get the Captcha type label
I18nizableText	getLoginFailedBecauseCaptchaFailedLabel()	Get the label to display when login has failed with this captcha
I18nizableText	getLoginFailedBecauseTooManyAttemptLabel()	Get the label to display when too many attempt have been done
List<Pattern>	getUsedUrlPatterns()	Get the minimal url patterns used by the captcha implementation.
void	removeCaptcha(String key)	Remove a captcha

Methods inherited from class org.ametys.core.captcha.AbstractCaptcha

configure, getConfigParameters, getId, getLoginSCSSURL, getXSLHelperURL, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.core.captcha.Captcha

requireUserInteraction

Field Details

STATIC_PREFIX_KEY

protected static final String STATIC_PREFIX_KEY

Prefix for static captchas

See Also:

• Constant Field Values

DYNAMIC_PREFIX_KEY

protected static final String DYNAMIC_PREFIX_KEY

Prefix for dynamic captchas

See Also:

• Constant Field Values

_mapStaticCaptcha

protected static Map<String,List<JCaptcha.ValidableCaptcha>> _mapStaticCaptcha

Map of static captchas

_mapDynamicCaptcha

protected static Map<String,JCaptcha.ValidableCaptcha> _mapDynamicCaptcha

Map of dynamic captchas

Constructor Details

JCaptcha

public JCaptcha()

Method Details

checkAndInvalidateCaptcha

public boolean checkAndInvalidateCaptcha(String key,
 String value)

Description copied from interface: Captcha

Check if the Captcha is correct

Parameters:

key - the key

value - the value

Returns:

true if correct

getLabel

public I18nizableText getLabel()

Description copied from interface: Captcha

Get the Captcha type label

Returns:

the label

getLoginFailedBecauseCaptchaFailedLabel

public I18nizableText getLoginFailedBecauseCaptchaFailedLabel()

Description copied from interface: Captcha

Get the label to display when login has failed with this captcha

Returns:

the label

getLoginFailedBecauseTooManyAttemptLabel

public I18nizableText getLoginFailedBecauseTooManyAttemptLabel()

Description copied from interface: Captcha

Get the label to display when too many attempt have been done

Returns:

the label

getUsedUrlPatterns

public List<Pattern> getUsedUrlPatterns()

Description copied from interface: Captcha

Get the minimal url patterns used by the captcha implementation. This is necessary to grant those url even when the user is not authentified (in particular to set a catpcha on the login page). Do no put a too wide range (such as ^.*$) since it may introduce security issues.

Returns:

The minimal url patterns used by the captcha implementation.

generateImageCaptcha

public BufferedImage generateImageCaptcha(String key,
 Integer color,
 boolean addNoise,
 boolean fisheye,
 int width,
 int height)

Generate an image captcha to PNG format. The key has to be unique, if you cannot generate a key use the other form of the method.

Parameters:

key - the wanted key. Can not be null. You can use RandomStringUtils.randomAlphanumeric(10) to generates one

color - The color for font

addNoise - true to add noise to captcha image

fisheye - true to add fish eye background to captcha image

width - The image width

height - The image height

Returns:

The corresponding image

removeCaptcha

public void removeCaptcha(String key)

Remove a captcha

Parameters:

key - the key value

cleanOldCaptchas

public void cleanOldCaptchas()

Clean the outdated captchas