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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
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;
25
26 import org.acegisecurity.Authentication;
27 import org.acegisecurity.context.SecurityContext;
28 import org.acegisecurity.userdetails.UserDetails;
29
30 import javax.servlet.http.HttpSession;
31
32 /**
33 * {@link UserDetails} that can mark {@link Authentication} invalid.
34 *
35 * <p>
36 * Tomcat persists sessions by using Java serialization (and
37 * that includes the security token created by Acegi, which includes this object)
38 * and when that happens, the next time the server comes back
39 * it will try to deserialize {@link SecurityContext} that Acegi
40 * puts into {@link HttpSession} (which transitively includes {@link UserDetails}
41 * that can be implemented by Hudson.
42 *
43 * <p>
44 * Such {@link UserDetails} implementation can override the {@link #isInvalid()}
45 * method and return false, so that such {@link SecurityContext} will be
46 * dropped before the rest of Acegi sees it.
47 *
48 * <p>
49 * See JENKINS-1482
50 *
51 * @author Kohsuke Kawaguchi
52 * @deprecated
53 * Starting 1.285, Hudson stops persisting {@link Authentication} altogether
54 * (see {@link NotSerilizableSecurityContext}), so there's no need to use this mechanism.
55 */
56 public interface InvalidatableUserDetails extends UserDetails {
57 boolean isInvalid();
58 }
59