org.acegisecurity.ui.switchuser.SwitchUserGrantedAuthority Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acegi-security

There is a newer version: 1.0.7

/* Copyright 2004, 2005 Acegi Technology Pty Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.acegisecurity.ui.switchuser;

import org.acegisecurity.Authentication;
import org.acegisecurity.GrantedAuthorityImpl;


/**
 * Custom GrantedAuthority used by {@link
 * org.acegisecurity.ui.switchuser.SwitchUserProcessingFilter}
 * 
 * 
 * Stores the Authentication object of the original user to be
 * used later when 'exiting' from a user switch.
 * 
 *
 * @author Mark St.Godard
 * @version $Id: SwitchUserGrantedAuthority.java,v 1.2 2005/11/17 00:56:10 benalex Exp $
 *
 * @see org.acegisecurity.ui.switchuser.SwitchUserProcessingFilter
 */
public class SwitchUserGrantedAuthority extends GrantedAuthorityImpl {
    //~ Instance fields ========================================================

    private Authentication source;

    //~ Constructors ===========================================================

    public SwitchUserGrantedAuthority(String role, Authentication source) {
        super(role);
        this.source = source;
    }

    //~ Methods ================================================================

    /**
     * Returns the original user associated with a successful user switch.
     *
     * @return The original Authentication object of the switched
     *         user.
     */
    public Authentication getSource() {
        return source;
    }
}