com.octo.captcha.service.image.ImageCaptchaService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcaptcha-core 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.
 */

package com.octo.captcha.service.image;

import java.awt.image.BufferedImage;
import java.util.Locale;

import com.octo.captcha.engine.CaptchaEngine;
import com.octo.captcha.service.CaptchaService;
import com.octo.captcha.service.CaptchaServiceException;

/**
 * 
 * Specialize a Captcha service that return Image Captchas
 * 
 * 
 * @author Marc-Antoine Garrigue
 * @version 1.0
 */
public interface ImageCaptchaService extends CaptchaService {

	/**
	 * Method to retrive the image challenge corresponding to the given ticket.
	 * 
	 * @param ID the ticket
	 * 
	 * @return the challenge
	 * 
	 * @throws com.octo.captcha.service.CaptchaServiceException if the ticket is
	 *             invalid
	 */
	BufferedImage getImageChallengeForID(String ID) throws CaptchaServiceException;

	/**
	 * Method to retrive the image challenge corresponding to the given ticket.
	 * 
	 * @param ID the ticket
	 * 
	 * @return the challenge
	 * 
	 * @throws com.octo.captcha.service.CaptchaServiceException if the ticket is
	 *             invalid
	 */
	BufferedImage getImageChallengeForID(String ID, Locale locale) throws CaptchaServiceException;

	public void setCaptchaEngine(CaptchaEngine engine);
}