UserDao.java

/*
 * Copyright (C) 2013 tarent AG
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package org.osiam.storage.dao;

import org.antlr.v4.runtime.tree.ParseTree;
import org.osiam.resources.exception.ResourceNotFoundException;
import org.osiam.storage.entities.UserEntity;
import org.osiam.storage.entities.UserEntity_;
import org.osiam.storage.query.UserFilterParser;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;

@Repository
public class UserDao implements GenericDao<UserEntity> {

    private UserFilterParser filterParser;

    private ResourceDao resourceDao;

    @Autowired
    public UserDao(UserFilterParser filterParser, ResourceDao resourceDao) {
        this.filterParser = filterParser;
        this.resourceDao = resourceDao;
    }

    @Override
    public void create(UserEntity userEntity) {
        resourceDao.create(userEntity);
    }

    @Override
    public UserEntity getById(String id) {
        try {
            return resourceDao.getById(id, UserEntity.class);
        } catch (ResourceNotFoundException rnfe) {
            throw new ResourceNotFoundException(String.format("User with id '%s' not found", id), rnfe);
        }
    }

    public UserEntity getByUsername(String userName) {
        try {
            return resourceDao.getByAttribute(UserEntity_.userName, userName, UserEntity.class);
        } catch (ResourceNotFoundException rnfe) {
            throw new ResourceNotFoundException(String.format("User with userName '%s' not found", userName), rnfe);
        }
    }

    /**
     * Checks if a userName is already taken by another user.
     *
     * @param userName the userName to check
     * @return true if the userName is taken, otherwise false
     */
    public boolean isUserNameAlreadyTaken(String userName) {
        return isUserNameAlreadyTaken(userName, null);
    }

    /**
     * Checks if a userName is already taken by another user. Ignores the user with the given id.
     *
     * @param userName the userName to check
     * @param id       the id of the user to ignore
     * @return true if the userName is taken, otherwise false
     */
    public boolean isUserNameAlreadyTaken(String userName, String id) {
        return resourceDao.isUniqueAttributeAlreadyTaken(userName, id, UserEntity_.userName, UserEntity.class);
    }

    /**
     * Checks if a externalId is already taken by another user.
     *
     * @param externalId the userName to check
     * @return true if the externalId is taken, otherwise false
     */
    public boolean isExternalIdAlreadyTaken(String externalId) {
        return resourceDao.isExternalIdAlreadyTaken(externalId);
    }

    /**
     * Checks if a externalId is already taken by another user. Ignores the user with the given id.
     *
     * @param externalId the externalId to check
     * @param id         the id of the user to ignore
     * @return true if the externalId is taken, otherwise false
     */
    public boolean isExternalIdAlreadyTaken(String externalId, String id) {
        return resourceDao.isExternalIdAlreadyTaken(externalId, id);
    }

    @Override
    public UserEntity update(UserEntity entity) {
        return resourceDao.update(entity);
    }

    @Override
    public void delete(String id) {
        try {
            resourceDao.delete(id);
        } catch (ResourceNotFoundException rnfe) {
            throw new ResourceNotFoundException(String.format("User with id '%s' not found", id), rnfe);
        }
    }

    @Override
    public SearchResult<UserEntity> search(ParseTree filterTree, String sortBy, String sortOrder, int count,
                                           int startIndex) {
        return resourceDao.search(UserEntity.class, filterTree, count, startIndex, sortBy, sortOrder, filterParser);
    }

}