diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..978d1e3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,39 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ +secring.gpg +*.gpg \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..7c1f5ac --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,5 @@ +repos: + - repo: https://github.com/Yelp/detect-secrets + rev: v1.4.0 + hooks: + - id: detect-secrets \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..cda8001 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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 + + https://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. \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..0bc01a2 --- /dev/null +++ b/build.gradle @@ -0,0 +1,92 @@ +buildscript { + repositories { + mavenCentral() + } + dependencies { + classpath "org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}" + } +} + +allprojects { + group = groupId + version = packageVersion +} + +subprojects { + + apply plugin: "java" + apply plugin: "maven-publish" + apply plugin: "signing" + + sourceCompatibility = JavaVersion.VERSION_17 + + repositories { + mavenCentral() + } + + task javadocJar(type: Jar) { + archiveClassifier = 'javadoc' + from javadoc + } + + task sourcesJar(type: Jar) { + archiveClassifier = 'sources' + from sourceSets.main.allSource + } + + artifacts { + archives javadocJar, sourcesJar + } + + publishing { + publications { + mavenJava(MavenPublication) { + signing { + sign publishing.publications.mavenJava + } + artifact jar + artifact tasks.javadocJar + artifact tasks.sourcesJar + + repositories { + maven { + name = "Ossrh" + url = "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/" + credentials() { + username = ossrhUsername + password = ossrhPassword + } + } + } + + pom { + name = 'Commons Dao Application' + packaging 'jar' + description = 'Commons-Dao used for make easy implementation of spring data jpa.' + url = 'https://github.com/smartSenseSolutions/smartsense-java-commons' + + licenses { + license { + name = 'The Apache License, Version 2.0' + url = 'http://www.apache.org/licenses/LICENSE-2.0.txt' + } + } + developers { + developer { + id = 'dilip.dhankecah' + name = 'Dilip Dhankecha' + email = 'dilip.dhankecha@smartsensesolutions.com' + } + } + scm { + connection = 'scm:git:git://github.com/smartSenseSolutions/smartsense-java-commons' + developerConnection = 'scm:git:ssh://github.com/smartSenseSolutions/smartsense-java-commons.git' + url = 'https://github.com/smartSenseSolutions/smartsense-java-commons/' + } + } + + } + } + } + +} \ No newline at end of file diff --git a/commons-dao/commons-dao.gradle b/commons-dao/commons-dao.gradle new file mode 100644 index 0000000..cf48efe --- /dev/null +++ b/commons-dao/commons-dao.gradle @@ -0,0 +1,31 @@ +plugins { + id 'java' + id 'java-library' + id 'org.springframework.boot' + id 'io.spring.dependency-management' +} + +version = commonDaoVersion + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +dependencies { + api 'jakarta.validation:jakarta.validation-api' + api 'org.springframework.boot:spring-boot-starter-data-jpa' + + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' +} + +bootJar { + enabled = false +} + +jar { + enabled = true + archiveClassifier = '' +} \ No newline at end of file diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/FilterRequest.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/FilterRequest.java new file mode 100644 index 0000000..bb7a26e --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/FilterRequest.java @@ -0,0 +1,91 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons; + +import com.smartsensesolutions.java.commons.criteria.CriteriaOperator; +import com.smartsensesolutions.java.commons.filter.FilterCriteria; +import com.smartsensesolutions.java.commons.operator.Operator; +import com.smartsensesolutions.java.commons.sort.Sort; +import jakarta.validation.Valid; +import jakarta.validation.constraints.Max; +import jakarta.validation.constraints.Min; +import jakarta.validation.constraints.NotNull; +import lombok.Getter; +import lombok.Setter; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +/** + * FilterRequest used for the filter the data based on the given criteria. + */ +@Getter +@Setter +public class FilterRequest { + + /** + * Indicates the page number which used for prepare pagination response from JPA query. + */ + @NotNull(message = "{NotNull.RecordFilter.page}") + private int page; + /** + * Indicates the size which used for prepare pagination response from JPA query. + */ + @NotNull(message = "{NotNull.RecordFilter.size}") + @Min(value = 10) + @Max(value = 20) + private int size; + /** + * Indicates the sorting objects that used in JPA query. + */ + private Sort sort; + /** + * Indicates the criteria that needs to used for JPA query. + */ + private CriteriaOperator criteriaOperator = CriteriaOperator.AND; + /** + * Indicates the criteria that needs to used for search using JPA query. + */ + @Valid + private List criteria; + + /** + * Method used for append new criteria to the given FilterRequest. + * + * @param fieldName - Indicates the Column name + * @param operator - Indicates operator + * @param recordType - Indicates the values + */ + public void appendNewCriteria(String fieldName, Operator operator, String... recordType) { + this.appendNewCriteria(fieldName, operator, Arrays.asList(recordType)); + } + + /** + * Method used for append new criteria to the given FilterRequest. + * + * @param fieldName - Indicates the Column name + * @param operator - Indicates operator + * @param recordType - Indicates the values + */ + public void appendNewCriteria(String fieldName, Operator operator, List recordType) { + List filterCriteria = this.getCriteria() != null ? this.getCriteria() : new ArrayList<>(); + filterCriteria.add(new FilterCriteria(fieldName, operator.getOperatorValue(), recordType)); + this.setCriteria(filterCriteria); + } + +} \ No newline at end of file diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/base/entity/BaseEntity.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/base/entity/BaseEntity.java new file mode 100644 index 0000000..5247d47 --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/base/entity/BaseEntity.java @@ -0,0 +1,23 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons.base.entity; + +/** + * Each @{@link jakarta.persistence.Entity} class must implement the BaseEntity. + */ +public interface BaseEntity { +} diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/base/repository/BaseRepository.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/base/repository/BaseRepository.java new file mode 100644 index 0000000..c801c79 --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/base/repository/BaseRepository.java @@ -0,0 +1,51 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons.base.repository; + +import com.smartsensesolutions.java.commons.base.entity.BaseEntity; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.Pageable; +import org.springframework.data.jpa.domain.Specification; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.repository.NoRepositoryBean; + +/** + * Each @{@link org.springframework.data.repository.Repository} must be extended with BaseRepository. + * + * @param - Indicates the @{@link jakarta.persistence.Entity} class. + * @param - Indicates the @{@link jakarta.persistence.Id} column from entity class. + */ +@NoRepositoryBean +public interface BaseRepository extends JpaRepository { + + /** + * Method used for fetch all elements from the entity class. + * + * @param specification - Indicates the JPA specification used for search on BaseEntity. + * @param pageable - Indicates the pageable request for JPA queries. + * @return Page response with entity details. + */ + Page findAll(Specification specification, Pageable pageable); + + /** + * Method used for fetch count based on the JPA specification. + * + * @param specification - Indicates the JPA specification used for search on BaseEntity. + * @return Indicates the elements count. + */ + long count(Specification specification); +} \ No newline at end of file diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/base/service/BaseService.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/base/service/BaseService.java new file mode 100644 index 0000000..355a9bb --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/base/service/BaseService.java @@ -0,0 +1,187 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons.base.service; + +import com.smartsensesolutions.java.commons.FilterRequest; +import com.smartsensesolutions.java.commons.base.entity.BaseEntity; +import com.smartsensesolutions.java.commons.base.repository.BaseRepository; +import com.smartsensesolutions.java.commons.criteria.CriteriaOperator; +import com.smartsensesolutions.java.commons.sort.SortType; +import com.smartsensesolutions.java.commons.specification.SpecificationUtil; +import org.springframework.dao.InvalidDataAccessApiUsageException; +import org.springframework.data.domain.Page; +import org.springframework.data.domain.PageRequest; +import org.springframework.data.domain.Sort; +import org.springframework.transaction.annotation.Propagation; +import org.springframework.transaction.annotation.Transactional; + +import java.util.List; +import java.util.Objects; + +/** + * Each @{@link org.springframework.stereotype.Service} must be extended with BaseService. + * + * @param - Indicates the @{@link jakarta.persistence.Entity} class. + * @param - Indicates the @{@link jakarta.persistence.Id} column from entity class. + */ +public abstract class BaseService { + + /** + * Method used for save entity. + * + * @param newEntity - Indicates the entity that needs to be saved. + * @return Entity + */ + public E create(E newEntity) { + return this.getRepository().save(newEntity); + } + + /** + * Method used for save entities. + * + * @param iterable - Indicates the iterable entities. + * @return List of Entity + */ + public List create(Iterable iterable) { + return this.getRepository().saveAll(iterable); + } + + /** + * Method used for fetch Entity by @{@link jakarta.persistence.Id} column. + * + * @param entityId - Indicates the entityId. + * @return Entity + */ + @Transactional(propagation = Propagation.NOT_SUPPORTED, readOnly = true) + public E get(ID entityId) { + return this.getRepository().findById(entityId).orElse(null); + } + + /** + * Method used for fetch multiple entities by @{@link jakarta.persistence.Id} column. + * + * @param entityIds - Indicates the entityIds. + * @return List of Entity + */ + @Transactional(propagation = Propagation.NOT_SUPPORTED, readOnly = true) + public List get(Iterable entityIds) { + return this.getRepository().findAllById(entityIds); + } + + /** + * Method used for fetch all records from the entity. + * + * @return List of Entity + */ + @Transactional(propagation = Propagation.NOT_SUPPORTED, readOnly = true) + public List getAll() { + return this.getRepository().findAll(); + } + + /** + * Method used for delete entity by entityId. + * + * @param entityId - Indicates the EntityId + */ + public void delete(ID entityId) { + this.getRepository().deleteById(entityId); + } + + /** + * Method used for check whether given entityId exist or not. + * + * @param entityId - Indicates the entityId + * @return boolean + */ + public boolean existsById(ID entityId) { + return this.getRepository().existsById(entityId); + } + + /** + * Method used for generate Page response based on the given FilterRequest. + * + * @param filter - Indicates the FilterRequest + * @return Page of Entity + */ + @Transactional(readOnly = true) + public Page filter(FilterRequest filter) { + try { + PageRequest pageRequest = this.getPageRequest(filter); + Page entities; + if (filter.getCriteria() != null && !filter.getCriteria().isEmpty()) { + if (Objects.isNull(filter.getCriteriaOperator()) || filter.getCriteriaOperator().equals(CriteriaOperator.AND)) { + entities = this.getRepository().findAll(this.getSpecificationUtil().generateSpecification(filter.getCriteria()), + pageRequest); + } else { + entities = this.getRepository().findAll(this.getSpecificationUtil().generateOrSpecification(filter.getCriteria()), pageRequest); + } + + } else { + entities = this.getRepository().findAll(pageRequest); + } + return entities; + } catch (InvalidDataAccessApiUsageException ex) { + throw new IllegalArgumentException("field type not support operator or value", ex); + } + } + + /** + * Generate page request from {@link FilterRequest}. + * + * @param filter - Indicates the FilterRequest + * @return PageRequest + */ + private PageRequest getPageRequest(FilterRequest filter) { + if (filter.getSize() <= 0) { + filter.setSize(Integer.MAX_VALUE); + } + PageRequest pageRequest; + if (filter.getSort() != null) { + org.springframework.data.domain.Sort sort = org.springframework.data.domain.Sort.by(filter.getSort().getSortType() == SortType.ASC ? org.springframework.data.domain.Sort.Direction.ASC : Sort.Direction.DESC, filter.getSort().getColumn()); + pageRequest = PageRequest.of(filter.getPage(), filter.getSize(), sort); + } else { + pageRequest = PageRequest.of(filter.getPage(), filter.getSize()); + } + return pageRequest; + } + + /** + * Method used for fetch count based on the FilterRequest. + * + * @param filter - Indicates the FilterRequest. + * @return Long + */ + @Transactional(readOnly = true) + public long count(FilterRequest filter) { + return this.getRepository().count(this.getSpecificationUtil().generateSpecification(filter.getCriteria())); + } + + /** + * Method needs to Override by each service which extends BaseService. + * + * @return BaseRepository of @{@link org.springframework.stereotype.Repository} interface. + */ + protected abstract BaseRepository getRepository(); + + /** + * Method needs to Override by each service which extends BaseService. + * + * @return Specification of @{@link jakarta.persistence.Entity} class + */ + protected abstract SpecificationUtil getSpecificationUtil(); + +} diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/criteria/CriteriaOperator.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/criteria/CriteriaOperator.java new file mode 100644 index 0000000..fa1f9a7 --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/criteria/CriteriaOperator.java @@ -0,0 +1,24 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons.criteria; + +/** + * CriteriaOperator indicates the supported criteria for JPA queries. + */ +public enum CriteriaOperator { + AND, OR +} diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/filter/FilterCriteria.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/filter/FilterCriteria.java new file mode 100644 index 0000000..91ba2fe --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/filter/FilterCriteria.java @@ -0,0 +1,53 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons.filter; + +import com.smartsensesolutions.java.commons.FilterRequest; +import com.smartsensesolutions.java.commons.operator.Operator; +import jakarta.validation.constraints.NotBlank; +import jakarta.validation.constraints.NotNull; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +import java.util.List; + +/** + * FilterCriteria used in {@link FilterRequest} to provide custom search. + */ +@NoArgsConstructor +@AllArgsConstructor +@Getter +@Setter +public class FilterCriteria { + /** + * Indicates the variable name that used in @{@link jakarta.persistence.Entity} class. + */ + @NotBlank(message = "{NotNull.FilterCriteria.column}") + private String column; + /** + * Indicates the value from the {@link Operator}. + */ + @NotNull(message = "{NotNull.FilterCriteria.operator}") + private String operator; + /** + * Values that needs to be matched while querying to @{@link jakarta.persistence.Entity} class. + */ + private List values; + +} diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/operator/Operator.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/operator/Operator.java new file mode 100644 index 0000000..887e3b8 --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/operator/Operator.java @@ -0,0 +1,63 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons.operator; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +import java.util.HashMap; +import java.util.Map; + +/** + * All supported operators. + */ +@AllArgsConstructor +@Getter +public enum Operator { + + CONTAIN("like"), + NOT_CONTAIN("!like"), + EQUALS("="), + NOT_EQUAL("!="), + IN("in"), + NOT_IN("!in"), + GREATER_THAN(">"), + LESSER_THAN("<"), + GREATER_EQUALS(">="), + LESSER_EQUALS("<="), + TRUE("is_true"), + FALSE("is_false"), + NULL("is_null"), + NOT_NULL("!is_null"), + JOIN_EQUALS("join_eq"), + JOIN_IN("join_in"), + JOIN_LIKE("join_like"); + + private static final Map map = new HashMap<>(); + private final String operatorValue; + + static { + for (Operator legEnum : Operator.values()) { + map.put(legEnum.operatorValue, legEnum); + } + } + + public static Operator getOperator(String operatorValue) { + return map.get(operatorValue); + } + +} diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/sort/Sort.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/sort/Sort.java new file mode 100644 index 0000000..234fc5c --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/sort/Sort.java @@ -0,0 +1,42 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons.sort; + +import com.smartsensesolutions.java.commons.FilterRequest; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +/** + * Cort used in {@link FilterRequest} to provide sorting. + */ +@NoArgsConstructor +@Getter +@Setter +public class Sort { + + /** + * Indicates the variable name that used in @{@link jakarta.persistence.Entity} class. + */ + private String column; + /** + * Indicates the ASD or DESC sort on column. + * Values used from the {@link SortType}. + */ + private SortType sortType; + +} diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/sort/SortType.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/sort/SortType.java new file mode 100644 index 0000000..c920d0f --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/sort/SortType.java @@ -0,0 +1,31 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons.sort; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +/** + * All supported sort types. + */ +@AllArgsConstructor +@Getter +public enum SortType { + + NONE("none"), ASC("asc"), DESC("desc"); + private final String value; +} diff --git a/commons-dao/src/main/java/com/smartsensesolutions/java/commons/specification/SpecificationUtil.java b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/specification/SpecificationUtil.java new file mode 100644 index 0000000..8f4ede7 --- /dev/null +++ b/commons-dao/src/main/java/com/smartsensesolutions/java/commons/specification/SpecificationUtil.java @@ -0,0 +1,234 @@ +/* + * Copyright 2023 smartSense Consulting Solutions Pvt. Ltd + * + * Licensed 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 com.smartsensesolutions.java.commons.specification; + +import com.smartsensesolutions.java.commons.filter.FilterCriteria; +import com.smartsensesolutions.java.commons.operator.Operator; +import jakarta.persistence.criteria.*; +import org.springframework.data.jpa.domain.Specification; +import org.springframework.stereotype.Component; +import org.springframework.util.CollectionUtils; + +import java.util.ArrayList; +import java.util.Date; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + +/** + * Specification will be used for generate the JPA query. + * + * @param - Indicates @{@link jakarta.persistence.Entity} class. + */ +@Component +public class SpecificationUtil { + + private static Predicate getContainsPredicates(FilterCriteria filterCriteria, Root root, CriteriaBuilder cb) { + validateValue(filterCriteria.getValues()); + List predicates = new ArrayList<>(); + filterCriteria.getValues().forEach(value -> predicates.add(cb.like(root.get(filterCriteria.getColumn()).as(String.class), getContainsValue(value)))); + return cb.or(predicates.toArray(new Predicate[0])); + } + + public Specification generateOrSpecification(List criteria) { + return (final Root root, final CriteriaQuery cq, final CriteriaBuilder cb) -> { + List predicates = new ArrayList<>(); + criteria.forEach(filterCriteria -> predicates.add(this.getPredicate(filterCriteria, root, cb))); + return cb.or(predicates.toArray(new Predicate[predicates.size()])); + }; + } + + private static Predicate getNotContainPredicates(FilterCriteria filterCriteria, Root root, CriteriaBuilder cb) { + validateValue(filterCriteria.getValues()); + List predicates = new ArrayList<>(); + filterCriteria.getValues().forEach(value -> predicates.add(cb.notLike(root.get(filterCriteria.getColumn()), getContainsValue(value)))); + return cb.or(predicates.toArray(new Predicate[0])); + } + + private static String getContainsValue(String value) { + return "%".concat(value).concat("%"); + } + + private static void validateValue(List values) { + if (CollectionUtils.isEmpty(values)) { + throw new IllegalArgumentException("value/s require"); + } + } + + public Specification generateSpecification(List criteria) { + return (final Root root, final CriteriaQuery cq, final CriteriaBuilder cb) -> { + List predicates = new ArrayList<>(); + criteria.forEach(filterCriteria -> predicates.add(this.getPredicate(filterCriteria, root, cb))); + return cb.and(predicates.toArray(new Predicate[0])); + }; + } + + private Predicate getPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder cb) { + Predicate predicate; + Operator operator = Operator.getOperator(filterCriteria.getOperator()); + switch (operator) { + case CONTAIN: + predicate = getContainsPredicates(filterCriteria, root, cb); + break; + case NOT_CONTAIN: + predicate = getNotContainPredicates(filterCriteria, root, cb); + break; + case EQUALS: + predicate = this.getEqualsPredicate(filterCriteria, root, cb); + break; + case NOT_EQUAL: + predicate = this.getNotEqualsPredicate(filterCriteria, root, cb); + break; + case NULL: + predicate = this.getIsNullPredicate(filterCriteria, root, cb); + break; + case NOT_NULL: + predicate = this.getIsNotNullPredicate(filterCriteria, root, cb); + break; + case IN: + predicate = this.getInPredicate(filterCriteria, root); + break; + case NOT_IN: + predicate = this.getNotInPredicate(filterCriteria, root, cb); + break; + case TRUE: + predicate = this.getTruePredicate(filterCriteria, root, cb); + break; + case FALSE: + predicate = this.getFalsePredicate(filterCriteria, root, cb); + break; + case LESSER_THAN: + predicate = this.getLesserThanPredicate(filterCriteria, root, cb); + break; + case LESSER_EQUALS: + predicate = this.getLesserEqualPredicate(filterCriteria, root, cb); + break; + case GREATER_THAN: + predicate = this.getGretherThanPredicate(filterCriteria, root, cb); + break; + case GREATER_EQUALS: + predicate = this.getGretherEqualPredicate(filterCriteria, root, cb); + break; + case JOIN_EQUALS: + predicate = this.prepareJoinPredicate(filterCriteria, root, cb); + break; + case JOIN_IN: + predicate = this.prepareJoinInPredicate(filterCriteria, root); + break; + case JOIN_LIKE: + predicate = this.prepareJoinLikePredicate(filterCriteria, root, cb); + break; + default: + throw new IllegalArgumentException("operator not implemented"); + } + return predicate; + } + + private Predicate getEqualsPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + validateValue(filterCriteria.getValues()); + Object o = this.getValue(root.get(filterCriteria.getColumn()), filterCriteria.getValues().get(0)); + return criteriaBuilder.equal(root.get(filterCriteria.getColumn()), o); + } + + private Predicate getNotEqualsPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + validateValue(filterCriteria.getValues()); + Object o = this.getValue(root.get(filterCriteria.getColumn()), filterCriteria.getValues().get(0)); + return criteriaBuilder.notEqual(root.get(filterCriteria.getColumn()), o); + } + + private Predicate getInPredicate(FilterCriteria filterCriteria, Root root) { + validateValue(filterCriteria.getValues()); + Set set = filterCriteria.getValues().stream().map(value -> this.getValue(root.get(filterCriteria.getColumn()), value)).collect(Collectors.toSet()); + return root.get(filterCriteria.getColumn()).in(set); + } + + private Predicate getIsNullPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + return criteriaBuilder.isNull(root.get(filterCriteria.getColumn())); + } + + private Predicate getIsNotNullPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + return criteriaBuilder.isNotNull(root.get(filterCriteria.getColumn())); + } + + private Predicate getNotInPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder cb) { + validateValue(filterCriteria.getValues()); + Set set = filterCriteria.getValues().stream().map(value -> this.getValue(root.get(filterCriteria.getColumn()), value)).collect(Collectors.toSet()); + return cb.not(root.get(filterCriteria.getColumn()).in(set)); + } + + private Predicate getTruePredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + return criteriaBuilder.isTrue(root.get(filterCriteria.getColumn())); + } + + private Predicate getFalsePredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + return criteriaBuilder.not(criteriaBuilder.isTrue(root.get(filterCriteria.getColumn()))); + } + + private Predicate getLesserThanPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + validateValue(filterCriteria.getValues()); + Object o = this.getValue(root.get(filterCriteria.getColumn()), filterCriteria.getValues().get(0)); + return criteriaBuilder.lessThan(root.get(filterCriteria.getColumn()), (Comparable) o); + } + + private Predicate getLesserEqualPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + validateValue(filterCriteria.getValues()); + Object o = this.getValue(root.get(filterCriteria.getColumn()), filterCriteria.getValues().get(0)); + return criteriaBuilder.lessThanOrEqualTo(root.get(filterCriteria.getColumn()), (Comparable) o); + } + + private Predicate getGretherThanPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + validateValue(filterCriteria.getValues()); + Object o = this.getValue(root.get(filterCriteria.getColumn()), filterCriteria.getValues().get(0)); + return criteriaBuilder.greaterThan(root.get(filterCriteria.getColumn()), (Comparable) o); + } + + private Predicate getGretherEqualPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + validateValue(filterCriteria.getValues()); + Object o = this.getValue(root.get(filterCriteria.getColumn()), filterCriteria.getValues().get(0)); + return criteriaBuilder.greaterThanOrEqualTo(root.get(filterCriteria.getColumn()), (Comparable) o); + } + + private Predicate prepareJoinPredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + validateValue(filterCriteria.getValues()); + String[] split = filterCriteria.getColumn().split("_"); + Join join = root.join(split[0]); + return criteriaBuilder.equal(join.get(split[1]), filterCriteria.getValues().get(0)); + } + + private Predicate prepareJoinInPredicate(FilterCriteria filterCriteria, Root root) { + validateValue(filterCriteria.getValues()); + String[] split = filterCriteria.getColumn().split("_"); + Join join = root.join(split[0]); + return join.get(split[1]).in(filterCriteria.getValues()); + } + + private Predicate prepareJoinLikePredicate(FilterCriteria filterCriteria, Root root, CriteriaBuilder criteriaBuilder) { + String[] split = filterCriteria.getColumn().split("_"); + validateValue(filterCriteria.getValues()); + List predicates = new ArrayList<>(); + Join join = root.join(split[0], JoinType.LEFT); + filterCriteria.getValues().forEach(value -> predicates.add(criteriaBuilder.like(join.get(split[1]).as(String.class), getContainsValue(value)))); + return criteriaBuilder.or(predicates.toArray(new Predicate[0])); + } + + private Object getValue(Path path, String value) { + if (path instanceof java.util.Date) { + return new Date(Long.parseLong(value)); + } + return value; + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..60a42ea --- /dev/null +++ b/gradle.properties @@ -0,0 +1,28 @@ +# +# Copyright 2023 smartSense Consulting Solutions Pvt. Ltd +# +# Licensed 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. +# +groupId=com.smartsensesolutions +artifactId=commons +packageVersion=0.0.1 +springBootVersion=3.0.6 +springDependencyManagementVersion=1.1.0 +#Commons-Dao version Details +commonDaoVersion=0.0.2 +#OSSRH and GPG Signing configuration +signing.keyId= +signing.password= +signing.secretKeyRingFile= +ossrhUsername= +ossrhPassword= \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..5aea348 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,20 @@ +# +# Copyright 2023 smartSense Consulting Solutions Pvt. Ltd +# +# Licensed 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. +# +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..e980d7d --- /dev/null +++ b/gradlew @@ -0,0 +1,240 @@ +#!/bin/sh + +# +# Copyright 2023 smartSense Consulting Solutions Pvt. Ltd +# +# Licensed 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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..53a6b23 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,91 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..9895dd4 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,16 @@ +rootProject.name = 'java.commons' + +FileTree buildFiles = fileTree(rootDir) { + include '**/*.gradle' + exclude 'build', '**/gradle', 'settings.gradle', 'buildSrc', '/build.gradle', '.*', 'out' +} + +buildFiles.each { File buildFile -> + String projectName = buildFile.name.replace('.gradle', ''); + String projectPath = ':' + projectName; + include projectPath + def project = findProject("${projectPath}") + project.name = projectName + project.projectDir = buildFile.parentFile + project.buildFileName = buildFile.name +} \ No newline at end of file