hudson.security.captcha

Class CaptchaSupport

java.lang.Object

hudson.model.AbstractDescribableImpl<CaptchaSupport>

hudson.security.captcha.CaptchaSupport

All Implemented Interfaces:

ExtensionPoint, Describable<CaptchaSupport>

public abstract class CaptchaSupport
extends AbstractDescribableImpl<CaptchaSupport>
implements ExtensionPoint

Extension point for adding Captcha Support to User Registration Page CaptchaSupport.

This object can have an optional config.jelly to configure the Captcha Support

A default constructor is needed to create CaptchaSupport in the default configuration.

Since:

1.416

Author:

Winston Prakash

See Also:

CaptchaSupportDescriptor

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
CaptchaSupport()

Method Summary

Modifier and Type	Method and Description
static DescriptorExtensionList<CaptchaSupport,Descriptor<CaptchaSupport>>	all() Returns all the registered CaptchaSupport descriptors.
abstract void	generateImage(String id, OutputStream ios)
CaptchaSupportDescriptor	getDescriptor() By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.
abstract boolean	validateCaptcha(String id, String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptchaSupport

public CaptchaSupport()

Method Detail

all

public static DescriptorExtensionList<CaptchaSupport,Descriptor<CaptchaSupport>> all()

Returns all the registered CaptchaSupport descriptors.

validateCaptcha

public abstract boolean validateCaptcha(String id,
                                        String text)

generateImage

public abstract void generateImage(String id,
                                   OutputStream ios)
                            throws IOException

Throws:

IOException

getDescriptor

public CaptchaSupportDescriptor getDescriptor()

Description copied from class: AbstractDescribableImpl

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

Specified by:

getDescriptor in interface Describable<CaptchaSupport>

Overrides:

getDescriptor in class AbstractDescribableImpl<CaptchaSupport>