org.cgiar.ccafs.marlo.security.BaseSecurityContext.java Source code

Introduction

Here is the source code for org.cgiar.ccafs.marlo.security.BaseSecurityContext.java

Source

/*****************************************************************
 * This file is part of Managing Agricultural Research for Learning & 
 * Outcomes Platform (MARLO). 
 * MARLO is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * at your option) any later version.
 * MARLO is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with MARLO. If not, see <http://www.gnu.org/licenses/>.
 *****************************************************************/

package org.cgiar.ccafs.marlo.security;

import java.util.Collection;

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.mgt.RealmSecurityManager;
import org.apache.shiro.realm.Realm;
import org.apache.shiro.subject.Subject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Contains the security methods based framework Apache shiro
 * 
 * @author Hernn David Carvajal
 * @author Hermes Jimnez - CIAT/CCAFS
 */
public class BaseSecurityContext {

    private static Logger LOG = LoggerFactory.getLogger(BaseSecurityContext.class);

    /**
     * this method returns the APCustomRealm instance used by the app.
     * 
     * @return an APCustomRealm object.
     */
    public Realm getRealm() {
        Collection<Realm> realms = ((RealmSecurityManager) SecurityUtils.getSecurityManager()).getRealms();
        if (realms.size() > 0) {
            return realms.iterator().next();
        }
        return null;
    }

    /**
     * Get the actual instance of Subject
     * A Subject is just a security of an application User.
     * 
     * @return an Subject object.
     */
    public Subject getSubject() {
        try {
            return SecurityUtils.getSubject();
        } catch (Exception e) {
            LOG.warn("Failed to get Subject, maybe user is not login or session is lost:", e);
            return null;
        }
    }

    /**
     * Verify that the current user has all the following permissions.
     * 
     * @param permissions
     * @return an Subject object.
     */
    public boolean hasAllPermissions(String permissions) {
        Subject subject = this.getSubject();
        return subject == null ? false : subject.isPermittedAll(permissions);
    }

    /**
     * Verify that the current user has permission to any of the following
     * 
     * @param permissions
     * @return an Subject object.
     */
    public boolean hasAnyPermission(String[] permissions) {
        Subject subject = this.getSubject();
        if (subject != null && permissions != null) {
            for (String permission : permissions) {
                if (permission != null && subject.isPermitted(permission.trim())) {
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * Verify that the current user has the privileges.
     * 
     * @param permission
     * @return an Subject object.
     */
    public boolean hasPermission(String permission) {
        Subject subject = this.getSubject();
        return subject == null ? false : subject.isPermitted(permission);
    }

    /**
     * Verify that the user has the role received by parameter.
     * 
     * @param role
     * @return
     */
    public boolean hasRole(String role) {
        Subject subject = this.getSubject();
        return subject == null ? false : subject.hasRole(role);
    }

    /**
     * Validates if the user has started a session
     * 
     * @return true if the session exists, false otherwise.
     */
    public boolean isAuthenticated() {
        Subject subject = this.getSubject();
        if (subject == null) {
            return false;
        }
        return subject.isAuthenticated();
    }
}