View Javadoc

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.ui.switchuser;
17  
18  import org.acegisecurity.Authentication;
19  import org.acegisecurity.GrantedAuthorityImpl;
20  
21  
22  /***
23   * Custom <code>GrantedAuthority</code> used by {@link
24   * org.acegisecurity.ui.switchuser.SwitchUserProcessingFilter}
25   * 
26   * <p>
27   * Stores the <code>Authentication</code> object of the original user to be
28   * used later when 'exiting' from a user switch.
29   * </p>
30   *
31   * @author Mark St.Godard
32   * @version $Id: SwitchUserGrantedAuthority.java,v 1.2 2005/11/17 00:56:10 benalex Exp $
33   *
34   * @see org.acegisecurity.ui.switchuser.SwitchUserProcessingFilter
35   */
36  public class SwitchUserGrantedAuthority extends GrantedAuthorityImpl {
37      //~ Instance fields ========================================================
38  
39      private Authentication source;
40  
41      //~ Constructors ===========================================================
42  
43      public SwitchUserGrantedAuthority(String role, Authentication source) {
44          super(role);
45          this.source = source;
46      }
47  
48      //~ Methods ================================================================
49  
50      /***
51       * Returns the original user associated with a successful user switch.
52       *
53       * @return The original <code>Authentication</code> object of the switched
54       *         user.
55       */
56      public Authentication getSource() {
57          return source;
58      }
59  }