com.octo.captcha.engine.CaptchaEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jcaptcha-api Show documentation
The newest version!
/*
 * JCaptcha, the open source java framework for captcha definition and integration
 * Copyright (c)  2007 jcaptcha.net. All Rights Reserved.
 * See the LICENSE.txt file distributed with this package.
 */

/*
 * jcaptcha, the open source java framework for captcha definition and integration
 * copyright (c)  2007 jcaptcha.net. All Rights Reserved.
 * See the LICENSE.txt file distributed with this package.
 */

/*
 * jcaptcha, the open source java framework for captcha definition and integration
 * copyright (c)  2007 jcaptcha.net. All Rights Reserved.
 * See the LICENSE.txt file distributed with this package.
 */

package com.octo.captcha.engine;

import com.octo.captcha.CaptchaFactory;

import java.util.Locale;

/**
 * CaptchaEngine is the main interface from an application point of view : it uses CapchaFactories in order to return
 * new captchas. It has thes reponsibilty of creating CatpchaFactory instances and to provide an easy way to
 * retrieve captchas. Sub classes may implement container services around capcthas as, for example, Captchas pooling,
 * serialization, and so.
 *
 * @author Marc-Antoine Garrigue
 * @version $Id: CaptchaEngine.java 493 2009-02-14 12:00:39Z magarrigue $
 */
public interface CaptchaEngine {

    /**
     * This return a new captcha. It may be used directly.
     *
     * @return a new Captcha
     */
    com.octo.captcha.Captcha getNextCaptcha();

    /**
     * This return a new captcha. It may be used directly.
     *
     * @param locale the desired locale
     *
     * @return a new Captcha
     */
    com.octo.captcha.Captcha getNextCaptcha(Locale locale);


    /**
     * @return captcha factories used by this engine
     */
    CaptchaFactory[] getFactories();

    /**
     * @param factories new captcha factories for this engine
     *
     * @throws CaptchaEngineException if the factories are invalid for this engine
     */
    void setFactories(CaptchaFactory[] factories) throws CaptchaEngineException;
}