Module org.apache.wicket.extensions

Package org.apache.wicket.extensions.markup.html.captcha

Class CaptchaImageResource

java.lang.Object

org.apache.wicket.request.resource.AbstractResource

org.apache.wicket.request.resource.DynamicImageResource

org.apache.wicket.extensions.markup.html.captcha.CaptchaImageResource

All Implemented Interfaces:

Serializable, IResource, IClusterable

public class CaptchaImageResource
extends DynamicImageResource

Generates a captcha image.

Author:

Joshua Perlow

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.request.resource.AbstractResource

AbstractResource.ContentRangeType, AbstractResource.ResourceResponse, AbstractResource.WriteCallback

Nested classes/interfaces inherited from interface org.apache.wicket.request.resource.IResource

IResource.Attributes

Field Summary

Fields inherited from class org.apache.wicket.request.resource.AbstractResource

CONTENT_DISPOSITION_HEADER_NAME, CONTENT_RANGE_ENDBYTE, CONTENT_RANGE_STARTBYTE, INTERNAL_HEADERS

Constructor Summary

Constructors

Constructor	Description
CaptchaImageResource()	Construct.
CaptchaImageResource(String challengeId)	Construct.
CaptchaImageResource(String challengeId, int fontSize, int margin)	Construct.
CaptchaImageResource(IModel<String> challengeId)	Construct.
CaptchaImageResource(IModel<String> challengeId, int fontSize, int margin)	Construct.

Method Summary

Modifier and Type	Method	Description
final String	getChallengeId()	Gets the id for the challenge.
final IModel<String>	getChallengeIdModel()	Gets the id for the challenge
protected final byte[]	getImageData(IResource.Attributes attributes)	Get image data for our dynamic image resource.
final void	invalidate()	Causes the image to be redrawn the next time its requested.
protected Random	newRandomNumberGenerator()
protected byte[]	render()	Renders this image

Methods inherited from class org.apache.wicket.request.resource.DynamicImageResource

configureResponse, getFormat, newResourceResponse, setFormat, setLastModifiedTime, toImageData

Methods inherited from class org.apache.wicket.request.resource.AbstractResource

configureCache, getCachingStrategy, respond, setRequestMetaData, setRequestRangeMetaData, setResponseContentRangeHeaderFields, setResponseHeaders

Methods inherited from class java.lang.Object

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

Constructor Details

CaptchaImageResource

public CaptchaImageResource()

Construct.

CaptchaImageResource

public CaptchaImageResource(String challengeId)

Construct.

Parameters:

challengeId - The id of the challenge

CaptchaImageResource

public CaptchaImageResource(IModel<String> challengeId)

Construct.

Parameters:

challengeId - The id of the challenge

CaptchaImageResource

public CaptchaImageResource(IModel<String> challengeId,
 int fontSize,
 int margin)

Construct.

Parameters:

challengeId - The id of the challenge

fontSize - The font size

margin - The image's margin

CaptchaImageResource

public CaptchaImageResource(String challengeId,
 int fontSize,
 int margin)

Construct.

Parameters:

challengeId - The id of the challenge

fontSize - The font size

margin - The image's margin

Method Details

newRandomNumberGenerator

protected Random newRandomNumberGenerator()

getChallengeId

public final String getChallengeId()

Gets the id for the challenge.

Returns:

The id for the challenge

getChallengeIdModel

public final IModel<String> getChallengeIdModel()

Gets the id for the challenge

Returns:

The id for the challenge

invalidate

public final void invalidate()

Causes the image to be redrawn the next time its requested.

getImageData

protected final byte[] getImageData(IResource.Attributes attributes)

Description copied from class: DynamicImageResource

Get image data for our dynamic image resource. If the subclass regenerates the data, it should set the DynamicImageResource.setLastModifiedTime(Instant) when it does so. This ensures that image caching works correctly.

Specified by:

getImageData in class DynamicImageResource

Parameters:

attributes - the context bringing the request, response and the parameters

Returns:

The image data for this dynamic image. null means there is no image and 404 (Not found) response will be return.

render

protected byte[] render()

Renders this image

Returns:

The image data