File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\security\captcha\CaptchaSupport.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2011, Winston.Prakash@oracle.com
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.security.captcha;
25
26
27 import hudson.DescriptorExtensionList;
28 import hudson.ExtensionPoint;
29 import hudson.model.AbstractDescribableImpl;
30 import hudson.model.Descriptor;
31 import hudson.model.Hudson;
32
33 import java.io.IOException;
34 import java.io.OutputStream;
35
36
37 /**
38 * Extension point for adding Captcha Support to User Registration Page {@link CaptchaSupport}.
39 *
40 * <p>
41 * This object can have an optional <tt>config.jelly</tt> to configure the Captcha Support
42 * <p>
43 * A default constructor is needed to create CaptchaSupport in
44 * the default configuration.
45 *
46 * @author Winston Prakash
47 * @since 1.416
48 * @see CaptchaSupportDescriptor
49 */
50 public abstract class CaptchaSupport extends AbstractDescribableImpl<CaptchaSupport> implements ExtensionPoint {
51 /**
52 * Returns all the registered {@link CaptchaSupport} descriptors.
53 */
54 public static DescriptorExtensionList<CaptchaSupport, Descriptor<CaptchaSupport>> all() {
55 return Hudson.getInstance().<CaptchaSupport, Descriptor<CaptchaSupport>>getDescriptorList(CaptchaSupport.class);
56 }
57
58 abstract public boolean validateCaptcha(String id, String text);
59
60 abstract public void generateImage(String id, OutputStream ios) throws IOException;
61
62 public CaptchaSupportDescriptor getDescriptor() {
63 return (CaptchaSupportDescriptor)super.getDescriptor();
64 }
65 }
66