org.sakaiproject.nakamura.api.lite.authorizable.User.java Source code

Introduction

Here is the source code for org.sakaiproject.nakamura.api.lite.authorizable.User.java

Source

/*
 * Licensed to the Sakai Foundation (SF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The SF licenses this file
 * to you 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.sakaiproject.nakamura.api.lite.authorizable;

import com.google.common.collect.ImmutableSet;

import org.apache.commons.lang.StringUtils;

import java.security.Principal;
import java.util.Map;
import java.util.Set;

import javax.security.auth.Subject;

/**
 * Represetnation of the User.
 */
public class User extends Authorizable {

    /**
     * The ID of the admin user.
     */
    public static final String ADMIN_USER = "admin";
    /**
     * The ID of the anon user.
     */
    public static final String ANON_USER = "anonymous";
    /**
     * The ID of the system user.
     */
    public static final String SYSTEM_USER = "system";
    public static final String IMPERSONATORS_FIELD = "impersonators";

    public User(Map<String, Object> userMap) {
        super(userMap);
    }

    /**
     * @return true if this user is an administrative user.
     */
    public boolean isAdmin() {
        return SYSTEM_USER.equals(id) || ADMIN_USER.equals(id) || principals.contains(ADMINISTRATORS_GROUP);
    }

    /**
     * Does this user allow any of the principals identified in the subject to
     * impersonate it.
     * 
     * @param impersSubject
     *            a subject containing principals to be tested
     * @return true if this user allows one or more of the subjects to
     *         impersonate it.
     */
    // TODO: Unit test
    public boolean allowImpersonate(Subject impersSubject) {

        String impersonators = (String) getProperty(IMPERSONATORS_FIELD);
        if (impersonators == null) {
            return false;
        }
        Set<String> impersonatorSet = ImmutableSet.of(StringUtils.split(impersonators, ';'));
        for (Principal p : impersSubject.getPrincipals()) {

            if (ADMIN_USER.equals(p.getName()) || SYSTEM_USER.equals(p.getName())
                    || impersonatorSet.contains(p.getName())) {
                return true;
            }
        }
        return false;
    }

}