/*******************************************************************************
 * Copyright (c) 2012 GigaSpaces Technologies Ltd. All rights reserved
 *
 * 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.cloudifysource.security;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.logging.Logger;

import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.GrantedAuthority;

/**
 * Extends {@link UsernamePasswordAuthenticationToken} and adds support for authorization groups.
 * @author noak
 * @since 2.3.0
 */
public class CustomAuthenticationToken extends UsernamePasswordAuthenticationToken implements ExtendedAuthentication {

	/**
	 * serialVersionUID.
	 */
	private static final long serialVersionUID = -6592305155032221704L;
	private Collection<String> authGroups;
	private static final Logger logger = java.util.logging.Logger.getLogger(CustomAuthenticationToken.class.getName());
	
	/**
	 * Ctor.
	 */
	public CustomAuthenticationToken(final Object principal, final Object credentials, 
			final Collection<? extends GrantedAuthority> authorities, final Collection <String> authGroups) {
		super(principal, credentials, authorities);
		logger.finest("CustomAuthenticationToken : constructor");
		//set authGroups
		if (authGroups == null) {
            this.authGroups = new ArrayList<String>();
            return;
        }
		
		logger.finest("Setting auth groups " + Arrays.toString(authGroups.toArray()) + " for user.");

        for (String authGroup: authGroups) {
            if (authGroup == null) {
                throw new IllegalArgumentException("Authorization groups collection cannot contain any null elements");
            }
        }
        ArrayList<String> temp = new ArrayList<String>(authGroups.size());
        temp.addAll(authGroups);
        this.authGroups = Collections.unmodifiableList(temp);
	}

	public Collection<String> getAuthGroups() {
		return authGroups;
	}

}