AuthenticationSwitchUserEvent.java

/*
 * Copyright 2004, 2005, 2006 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.springframework.security.web.authentication.switchuser;

import org.springframework.security.authentication.event.AbstractAuthenticationEvent;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.userdetails.UserDetails;

/**
 * Application event which indicates that a user context switch.
 *
 * @author Mark St.Godard
 */
public class AuthenticationSwitchUserEvent extends AbstractAuthenticationEvent {
	// ~ Instance fields
	// ================================================================================================

	private final UserDetails targetUser;

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

	/**
	 * Switch user context event constructor
	 *
	 * @param authentication The current <code>Authentication</code> object
	 * @param targetUser The target user
	 */
	public AuthenticationSwitchUserEvent(Authentication authentication,
			UserDetails targetUser) {
		super(authentication);
		this.targetUser = targetUser;
	}

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

	public UserDetails getTargetUser() {
		return targetUser;
	}
}