View Javadoc

1   /*
2    * JCaptcha, the open source java framework for captcha definition and integration
3    * Copyright (c)  2007 jcaptcha.net. All Rights Reserved.
4    * See the LICENSE.txt file distributed with this package.
5    */
6   
7   package com.octo.captcha.service.image;
8   
9   import com.octo.captcha.service.CaptchaService;
10  import com.octo.captcha.service.CaptchaServiceException;
11  
12  import java.awt.image.BufferedImage;
13  import java.util.Locale;
14  
15  /***
16   * <p/>
17   * Specialize a Captcha service that return Image Captchas </p>
18   *
19   * @author <a href="mailto:mag@jcaptcha.net">Marc-Antoine Garrigue</a>
20   * @version 1.0
21   */
22  public interface ImageCaptchaService extends CaptchaService {
23  
24      /***
25       * Method to retrive the image challenge corresponding to the given ticket.
26       *
27       * @param ID the ticket
28       *
29       * @return the challenge
30       *
31       * @throws com.octo.captcha.service.CaptchaServiceException
32       *          if the ticket is invalid
33       */
34      BufferedImage getImageChallengeForID(String ID) throws CaptchaServiceException;
35  
36      /***
37       * Method to retrive the image challenge corresponding to the given ticket.
38       *
39       * @param ID the ticket
40       *
41       * @return the challenge
42       *
43       * @throws com.octo.captcha.service.CaptchaServiceException
44       *          if the ticket is invalid
45       */
46      BufferedImage getImageChallengeForID(String ID, Locale locale) throws CaptchaServiceException;
47  
48  }