Module bus.extra

Package org.miaixz.bus.extra.captcha.provider

Class ClickWordProvider

java.lang.Object

org.miaixz.bus.extra.captcha.AbstractProvider

org.miaixz.bus.extra.captcha.provider.ClickWordProvider

All Implemented Interfaces:

Serializable, org.miaixz.bus.core.Provider, CaptchaProvider

public class ClickWordProvider
extends AbstractProvider

Click Word CAPTCHA Provider.

Since:

Java 17+

Author:

Kimi Liu

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.miaixz.bus.extra.captcha.AbstractProvider

background, code, font, generator, height, imageBytes, interfereCount, textAlpha, width

Constructor Summary

Constructors

Constructor	Description
ClickWordProvider(int width, int height, int codeCount, int interfereCount)	Constructor.
ClickWordProvider(int width, int height, CodeStrategy generator, int interfereCount)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Image	createImage(String code)	Creates the CAPTCHA image based on the generated code.
String	get()	Retrieves the text content of the generated CAPTCHA.
boolean	verify(String inputCode)	Verifies if the user-provided CAPTCHA input matches the generated CAPTCHA text.

Methods inherited from class org.miaixz.bus.extra.captcha.AbstractProvider

create, generateCode, getGenerator, getImage, getImageBase64, getImageBase64Data, getImageBytes, setBackground, setFont, setGenerator, setTextAlpha, write, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.miaixz.bus.extra.captcha.CaptchaProvider

type

Constructor Details

ClickWordProvider

public ClickWordProvider(int width,
 int height,
 int codeCount,
 int interfereCount)

Constructor.

Parameters:

width - Image width.

height - Image height.

codeCount - Number of characters.

interfereCount - Number of interfering elements.

ClickWordProvider

public ClickWordProvider(int width,
 int height,
 CodeStrategy generator,
 int interfereCount)

Constructor.

Parameters:

width - Image width.

height - Image height.

generator - CAPTCHA code generator.

interfereCount - Number of interfering elements.

Method Details

createImage

protected Image createImage(String code)

Description copied from class: AbstractProvider

Creates the CAPTCHA image based on the generated code.

Specified by:

createImage in class AbstractProvider

Parameters:

code - The CAPTCHA code.

Returns:

The CAPTCHA image.

get

public String get()

Description copied from interface: CaptchaProvider

Retrieves the text content of the generated CAPTCHA.

Specified by:

get in interface CaptchaProvider

Overrides:

get in class AbstractProvider

Returns:

The text content of the CAPTCHA.

verify

public boolean verify(String inputCode)

Description copied from interface: CaptchaProvider

Verifies if the user-provided CAPTCHA input matches the generated CAPTCHA text. It is recommended to perform a case-insensitive comparison.

Specified by:

verify in interface CaptchaProvider

Overrides:

verify in class AbstractProvider

Parameters:

inputCode - The CAPTCHA code entered by the user.

Returns:

true if the user input matches the generated CAPTCHA, false otherwise.