1 /* Copyright 2004, 2005, 2006 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.springframework.security.context;
17
18 /**
19 * A strategy for storing security context information against a thread.
20 *
21 * <p>
22 * The preferred strategy is loaded by {@link
23 * org.springframework.security.context.SecurityContextHolder}.
24 * </p>
25 *
26 * @author Ben Alex
27 * @version $Id: SecurityContextHolderStrategy.java 2142 2007-09-21 18:18:21Z luke_t $
28 */
29 public interface SecurityContextHolderStrategy {
30 //~ Methods ========================================================================================================
31
32 /**
33 * Clears the current context.
34 */
35 void clearContext();
36
37 /**
38 * Obtains the current context.
39 *
40 * @return a context (never <code>null</code> - create a default implementation if necessary)
41 */
42 SecurityContext getContext();
43
44 /**
45 * Sets the current context.
46 *
47 * @param context to the new argument (should never be <code>null</code>, although implementations must check if
48 * <code>null</code> has been passed and throw an <code>IllegalArgumentException</code> in such cases)
49 */
50 void setContext(SecurityContext context);
51 }