SpringSecurity工具包之AuthorityUtils类

package org.springframework.security.util;

import org.springframework.security.Authentication;
import org.springframework.security.GrantedAuthority;
import org.springframework.security.GrantedAuthorityImpl;
import org.springframework.security.context.SecurityContextHolder;
import org.springframework.util.StringUtils;

import java.util.HashSet;
import java.util.Set;

/**
 * @author Luke Taylor
 * @version $Id: AuthorityUtils.java 2250 2007-11-11 23:37:32Z luke_t $
 */

public abstract class AuthorityUtils {

    //未认证数组列表

    public static final GrantedAuthority[] NO_AUTHORITIES = new GrantedAuthority[0];

    /**
     * Returns true if the current user has the specified authority.
     *当用户已经认证通过返回true
     * @param authority the authority to test for (e.g. "ROLE_A").
     * @return true if a GrantedAuthority object with the same string representation as the supplied authority
     * name exists in the current user's list of authorities. False otherwise, or if the user in not authenticated.
     */
    public static boolean userHasAuthority(String authority) {
        GrantedAuthority[] authorities = getUserAuthorities();

        for (int i = 0; i < authorities.length; i++) {
            if (authority.equals(authorities[i].getAuthority())) {
                return true;
            }
        }

        return false;
    }

    /**
     * Returns the authorities of the current user.
     *返回当前用户认证列表
     * @return an array containing the current user's authorities (or an empty array if not authenticated), never null.
     */
    private static GrantedAuthority[] getUserAuthorities() {
        Authentication auth = SecurityContextHolder.getContext().getAuthentication();

        if (auth == null || auth.getAuthorities() == null) {
            return NO_AUTHORITIES;
        }

        return auth.getAuthorities();
    }


    /**
     * Creates a array of GrantedAuthority objects from a comma-separated string
     * representation (e.g. "ROLE_A, ROLE_B, ROLE_C").
     *
     * @param authorityString the comma-separated string
     * @return the authorities created by tokenizing the string
     */
    public static GrantedAuthority[] commaSeparatedStringToAuthorityArray(String authorityString) {
        String[] authorityStrings = StringUtils.tokenizeToStringArray(authorityString, ",");
        GrantedAuthority[] authorities = new GrantedAuthority[authorityStrings.length];

        for (int i=0; i < authorityStrings.length; i++) {
            authorities[i] = new GrantedAuthorityImpl(authorityStrings[i]);
        }

        return authorities;
    }

    /**
     * Converts an array of GrantedAuthority objects to a Set.
     * @return a Set of the Strings obtained from each call to GrantedAuthority.getAuthority()
     */
    public static Set authorityArrayToSet(GrantedAuthority[] authorities) {
        Set set = new HashSet(authorities.length);

        for (int i = 0; i < authorities.length; i++) {
            set.add(authorities[i].getAuthority());
        }

        return set;
    }

    public static GrantedAuthority[] stringArrayToAuthorityArray(String[] roles) {
        GrantedAuthority[] authorities = new GrantedAuthority[roles.length];

        for (int i=0; i < roles.length; i++) {
            authorities[i] = new GrantedAuthorityImpl(roles[i]);
        }

        return authorities;
    }
}