com.expressui.core.dao.security.query.UserQuery.java Source code

Introduction

Here is the source code for com.expressui.core.dao.security.query.UserQuery.java

Source

/*
 * Copyright (c) 2012 Brown Bag Consulting.
 * This file is part of the ExpressUI project.
 * Author: Juan Osuna
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License Version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * Brown Bag Consulting, Brown Bag Consulting DISCLAIMS THE WARRANTY OF
 * NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the ExpressUI software without
 * disclosing the source code of your own applications. These activities
 * include: offering paid services to customers as an ASP, providing
 * services from a web application, shipping ExpressUI with a closed
 * source product.
 *
 * For more information, please contact Brown Bag Consulting at this
 * address: juan@brownbagconsulting.com.
 */

package com.expressui.core.dao.security.query;

import com.expressui.core.dao.query.StructuredEntityQuery;
import com.expressui.core.dao.security.UserDao;
import com.expressui.core.entity.security.Role;
import com.expressui.core.entity.security.User;
import com.expressui.core.entity.security.UserRole;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import javax.persistence.TypedQuery;
import javax.persistence.criteria.*;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import static org.springframework.beans.factory.config.BeanDefinition.SCOPE_PROTOTYPE;

/**
 * Structured entity query for finding users by name and that do not belong to a role, which is useful
 * to add users to a role that don't already belong to the role.
 */
@Component
@Scope(SCOPE_PROTOTYPE)
public class UserQuery extends StructuredEntityQuery<User> {

    @Resource
    private UserDao userDao;

    private String loginName;
    private Role doesNotBelongToRole;

    /**
     * Gets login name to query
     *
     * @return login name
     */
    public String getLoginName() {
        return loginName;
    }

    /**
     * Sets login name to query
     *
     * @param loginName login name
     */
    public void setLoginName(String loginName) {
        this.loginName = loginName;
    }

    /**
     * Gets {@link Role} that matching users must not belong to.
     *
     * @return role
     */
    public Role getDoesNotBelongToRole() {
        return doesNotBelongToRole;
    }

    /**
     * Sets {@link Role} that matching users must not belong to.
     *
     * @param doesNotBelongToRole role
     */
    public void setDoesNotBelongToRole(Role doesNotBelongToRole) {
        this.doesNotBelongToRole = doesNotBelongToRole;
    }

    @Override
    public List<User> execute() {
        return userDao.execute(this);
    }

    @Override
    public List<Predicate> buildCriteria(CriteriaBuilder builder, CriteriaQuery<User> query, Root<User> user) {
        List<Predicate> predicates = new ArrayList<Predicate>();

        if (hasValue(loginName)) {
            ParameterExpression<String> loginNameExp = builder.parameter(String.class, "loginName");
            predicates.add(builder.like(builder.upper(user.<String>get("loginName")), loginNameExp));
        }

        if (hasValue(doesNotBelongToRole)) {
            Subquery<User> subquery = query.subquery(User.class);
            Root userRole = subquery.from(UserRole.class);
            ParameterExpression<Role> role = builder.parameter(Role.class, "doesNotBelongToRole");
            subquery.select(userRole.get("user")).where(builder.equal(userRole.get("role"), role));
            predicates.add(builder.not(user.in(subquery)));
        }

        return predicates;
    }

    @Override
    public void setParameters(TypedQuery<Serializable> typedQuery) {
        if (hasValue(loginName)) {
            typedQuery.setParameter("loginName", "%" + loginName.toUpperCase() + "%");
        }
        if (hasValue(doesNotBelongToRole)) {
            typedQuery.setParameter("doesNotBelongToRole", doesNotBelongToRole);
        }
    }

    @Override
    public void clear() {
        Role doesNotBelongToRole = this.doesNotBelongToRole;
        super.clear();
        this.doesNotBelongToRole = doesNotBelongToRole;
    }

    @Override
    public String toString() {
        return "UserQuery{" + "loginName='" + loginName + '\'' + '}';
    }
}