Source code: org/acegisecurity/captcha/CaptchaSecurityContext.java
1 /* Copyright 2004, 2005 Acegi Technology Pty Limited
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 package org.acegisecurity.captcha;
17
18 import org.acegisecurity.context.SecurityContext;
19
20
21 /**
22 * Interface that add humanity concerns to the SecurityContext
23 *
24 * @author marc antoine garrigue
25 */
26 public interface CaptchaSecurityContext extends SecurityContext {
27 //~ Methods ================================================================
28
29 /**
30 * set human attribute, should called after captcha validation.
31 */
32 void setHuman();
33
34 /**
35 * DOCUMENT ME!
36 *
37 * @return true if the current user has already passed a captcha.
38 */
39 boolean isHuman();
40
41 /**
42 * DOCUMENT ME!
43 *
44 * @return number of human restricted resources requests since the last
45 * passed captcha.
46 */
47 int getHumanRestrictedResourcesRequestsCount();
48
49 /**
50 * DOCUMENT ME!
51 *
52 * @return the date of the last passed Captcha in millis, 0 if the user
53 * never passed captcha.
54 */
55 long getLastPassedCaptchaDateInMillis();
56
57 /**
58 * Method to increment the human Restricted Resrouces Requests Count;
59 */
60 void incrementHumanRestrictedRessoucesRequestsCount();
61 }