gorm.tools.repository.RepoUtil.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gorm-tools Show documentation
gorm-tools core
There is a newer version: 7.3.74
/*
* Copyright 2019 Yak.Works - Licensed under the Apache License, Version 2.0 (the "License")
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*/
package gorm.tools.repository

import groovy.transform.CompileStatic

import org.springframework.dao.OptimisticLockingFailureException

import yakworks.api.problem.data.DataProblem
import yakworks.api.problem.data.DataProblemCodes
import yakworks.api.problem.data.NotFoundProblem

/**
 * A bunch of statics to support the repositories.
 * this is also setup as repoUtilBean so that it gets injected with the ApplicationContext once its setup
 *
 * @author Joshua Burnett (@basejump)
 * @since 1.0
 */
@CompileStatic
@SuppressWarnings(["FieldName"])
class RepoUtil {
    public static final String SUFFIX = "Repo"

    // static List getRepoClasses(){
    //     GrailsHolder.grailsApplication.getArtefacts(RepositoryArtefactHandler.TYPE)*.clazz
    // }

    // Deprecated, moved to RepoLookup
    // static String getRepoBeanName(Class domainClass) {
    //     return "${NameUtils.getPropertyName(domainClass.name)}$SUFFIX"
    // }

    /**
     * checks the passed in version with the version on the entity (entity.version)
     * make sure entity.version is not greater
     *
     * @param entity the domain object the check
     * @param ver the version this used to be (entity will have the )
     * @throws OptimisticLockingFailureException
     */
    static void checkVersion(Object entity, Long oldVersion) {
        if (oldVersion == null) return
        if (entity.hasProperty('version')) {
            Long currentVersion = entity['version'] as Long
            if (currentVersion > oldVersion) {
                throw DataProblemCodes.OptimisticLocking.get()
                    .entity(entity)
                    .detail("server version:${currentVersion} > edited version:${oldVersion}")
                    .toException()
            }
        }
    }

    /**
     * check that the passed in entity is not null and throws EntityNotFoundException if so
     *
     * @param entity - the domain object the check
     * @param id - the identifier use when trying to find it. Will be used to construct the exception message
     * @param domainClassName - the name of the domain that will be used to build error message if thrown
     * @throw NotFoundProblem if it not found
     */
    static void checkFound(Object entity, Serializable id, String domainClassName) {
        if (!entity) {
            throw NotFoundProblem.of(id, domainClassName).toException()
        }
    }

    /**
     * check that the passed in data is not empty and throws EmptyDataException if so
     * @throws ProblemRuntime if it not found
     */
    static void checkData(Map data, Class entityClass) {
        if (!data) {
            throw DataProblem.of('error.data.empty', [name: entityClass.simpleName]).toException()
        }
    }

    /**
     * in create data, if id is passed then bindId must be set to true, if not throw exception
     */
    static void checkCreateData(Map data, PersistArgs args, Class entityClass) {
        if(data['id'] && !args.bindId)
            throw DataProblem.of('error.data.bindId', [name: entityClass.simpleName])
                .title("set bindId:true when manually assigning id in create data").toException()
    }
}