diff --git a/buildSrc/src/main/java/org/springframework/pulsar/gradle/ExtractResources.java b/buildSrc/src/main/java/org/springframework/pulsar/gradle/ExtractResources.java deleted file mode 100644 index 015da383..00000000 --- a/buildSrc/src/main/java/org/springframework/pulsar/gradle/ExtractResources.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Copyright 2012-present the original author or authors. - * - * 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. - */ - -package org.springframework.pulsar.gradle; - -import java.io.FileWriter; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.nio.charset.StandardCharsets; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import org.gradle.api.DefaultTask; -import org.gradle.api.GradleException; -import org.gradle.api.Task; -import org.gradle.api.file.DirectoryProperty; -import org.gradle.api.tasks.Input; -import org.gradle.api.tasks.OutputDirectory; -import org.gradle.api.tasks.TaskAction; - -import org.springframework.util.FileCopyUtils; -import org.springframework.util.PropertyPlaceholderHelper; - -/** - * {@link Task} to extract resources from the classpath and write them to disk. - * - * @author Andy Wilkinson - */ -public class ExtractResources extends DefaultTask { - - private final PropertyPlaceholderHelper propertyPlaceholderHelper = new PropertyPlaceholderHelper("${", "}"); - - private final Map properties = new HashMap<>(); - - private final DirectoryProperty destinationDirectory; - - private List resourceNames = new ArrayList<>(); - - public ExtractResources() { - this.destinationDirectory = getProject().getObjects().directoryProperty(); - } - - @Input - public List getResourceNames() { - return this.resourceNames; - } - - public void setResourcesNames(List resourceNames) { - this.resourceNames = resourceNames; - } - - @OutputDirectory - public DirectoryProperty getDestinationDirectory() { - return this.destinationDirectory; - } - - public void property(String name, String value) { - this.properties.put(name, value); - } - - @Input - public Map getProperties() { - return this.properties; - } - - @TaskAction - void extractResources() throws IOException { - for (String resourceName : this.resourceNames) { - InputStream resourceStream = getClass().getClassLoader().getResourceAsStream(resourceName); - if (resourceStream == null) { - throw new GradleException("Resource '" + resourceName + "' does not exist"); - } - String resource = FileCopyUtils.copyToString(new InputStreamReader(resourceStream, StandardCharsets.UTF_8)); - resource = this.propertyPlaceholderHelper.replacePlaceholders(resource, this.properties::get); - FileCopyUtils.copy(resource, - new FileWriter(this.destinationDirectory.file(resourceName).get().getAsFile())); - } - } - -} diff --git a/buildSrc/src/main/java/org/springframework/pulsar/gradle/JavaConventionsPlugin.java b/buildSrc/src/main/java/org/springframework/pulsar/gradle/JavaConventionsPlugin.java index 78e5daad..2cbe1300 100644 --- a/buildSrc/src/main/java/org/springframework/pulsar/gradle/JavaConventionsPlugin.java +++ b/buildSrc/src/main/java/org/springframework/pulsar/gradle/JavaConventionsPlugin.java @@ -16,12 +16,8 @@ package org.springframework.pulsar.gradle; -import java.util.Arrays; import java.util.Collections; -import java.util.Map; import java.util.Set; -import java.util.TreeMap; -import java.util.stream.Collectors; import org.gradle.api.Plugin; import org.gradle.api.Project; @@ -34,8 +30,6 @@ import org.gradle.api.plugins.quality.Checkstyle; import org.gradle.api.plugins.quality.CheckstyleExtension; import org.gradle.api.plugins.quality.CheckstylePlugin; -import org.gradle.api.tasks.SourceSet; -import org.gradle.api.tasks.SourceSetContainer; import org.gradle.api.tasks.bundling.Jar; import org.gradle.api.tasks.compile.JavaCompile; import org.gradle.api.tasks.javadoc.Javadoc; @@ -77,15 +71,6 @@ *
  • Enable {@code unchecked}, {@code deprecation}, {@code rawtypes}, and {@code varags} * warnings * - *
  • {@link Jar} tasks are configured to produce jars with LICENSE.txt and NOTICE.txt - * files and the following manifest entries: - *
      - *
    • {@code Automatic-Module-Name} - *
    • {@code Build-Jdk-Spec} - *
    • {@code Built-By} - *
    • {@code Implementation-Title} - *
    • {@code Implementation-Version} - *
    *
  • {@code spring-pulsar-dependencies} is used for dependency management
  • * * @@ -107,7 +92,6 @@ public void apply(Project project) { configureSpringJavaFormat(project); configureJavadocConventions(project); configureTestConventions(project); - configureJarManifestConventions(project); configureDependencyManagement(project); }); } @@ -162,32 +146,6 @@ private void configureTestConventions(Project project) { .add(JavaPlugin.TEST_RUNTIME_ONLY_CONFIGURATION_NAME, "org.junit.platform:junit-platform-launcher")); } - private void configureJarManifestConventions(Project project) { - ExtractResources extractLegalResources = project.getTasks().create("extractLegalResources", - ExtractResources.class); - extractLegalResources.getDestinationDirectory().set(project.getLayout().getBuildDirectory().dir("legal")); - extractLegalResources.setResourcesNames(Arrays.asList("LICENSE.txt", "NOTICE.txt")); - extractLegalResources.property("version", project.getVersion().toString()); - SourceSetContainer sourceSets = project.getExtensions().getByType(SourceSetContainer.class); - Set sourceJarTaskNames = sourceSets.stream().map(SourceSet::getSourcesJarTaskName) - .collect(Collectors.toSet()); - Set javadocJarTaskNames = sourceSets.stream().map(SourceSet::getJavadocJarTaskName) - .collect(Collectors.toSet()); - project.getTasks().withType(Jar.class, (jar) -> project.afterEvaluate((evaluated) -> { - jar.metaInf((metaInf) -> metaInf.from(extractLegalResources)); - jar.manifest((manifest) -> { - Map attributes = new TreeMap<>(); - attributes.put("Automatic-Module-Name", project.getName().replace("-", ".")); - attributes.put("Build-Jdk-Spec", SOURCE_AND_TARGET_COMPATIBILITY); - attributes.put("Built-By", "Spring"); - attributes.put("Implementation-Title", - determineImplementationTitle(project, sourceJarTaskNames, javadocJarTaskNames, jar)); - attributes.put("Implementation-Version", project.getVersion()); - manifest.attributes(attributes); - }); - })); - } - private String determineImplementationTitle(Project project, Set sourceJarTaskNames, Set javadocJarTaskNames, Jar jar) { if (sourceJarTaskNames.contains(jar.getName())) { diff --git a/buildSrc/src/main/resources/LICENSE.txt b/buildSrc/src/main/resources/LICENSE.txt deleted file mode 100644 index 823c1c8e..00000000 --- a/buildSrc/src/main/resources/LICENSE.txt +++ /dev/null @@ -1,202 +0,0 @@ - - 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/gradle/java-conventions.gradle b/gradle/java-conventions.gradle index ff08b7e8..e6116d17 100644 --- a/gradle/java-conventions.gradle +++ b/gradle/java-conventions.gradle @@ -5,6 +5,10 @@ def toolchainVersion() { return 17 } +def linkHomepage() { + return 'https://github.com/spring-projects/spring-pulsar' +} + project.afterEvaluate { subprojects { subproject -> afterEvaluate { @@ -20,6 +24,28 @@ project.afterEvaluate { options.compilerArgs.addAll(["-Werror", "-Xlint:unchecked", "-Xlint:deprecation", "-Xlint:rawtypes", "-Xlint:varargs"]); options.release.set(17) } + jar { + manifest { + attributes( + 'Implementation-Version': archiveVersion, + 'Created-By': "JDK ${System.properties['java.version']} (${System.properties['java.specification.vendor']})", + 'Implementation-Title': subproject.name, + 'Implementation-Vendor-Id': subproject.group, + 'Implementation-Vendor': 'Broadcom Inc.', + 'Implementation-URL': linkHomepage(), + 'Automatic-Module-Name': subproject.name.replace('-', '.') // for Jigsaw + ) + } + from("${rootProject.projectDir}/src/dist") { + include 'notice.txt' + into 'META-INF' + expand(version: project.version) + } + from("${rootProject.projectDir}") { + include 'LICENSE.txt' + into 'META-INF' + } + } } } } diff --git a/spring-pulsar-cache-provider-caffeine/spring-pulsar-cache-provider-caffeine.gradle b/spring-pulsar-cache-provider-caffeine/spring-pulsar-cache-provider-caffeine.gradle index 328e92b5..8e9bc4a6 100644 --- a/spring-pulsar-cache-provider-caffeine/spring-pulsar-cache-provider-caffeine.gradle +++ b/spring-pulsar-cache-provider-caffeine/spring-pulsar-cache-provider-caffeine.gradle @@ -21,6 +21,15 @@ shadowJar { manifest { inheritFrom project.tasks.jar.manifest } + from("${rootProject.projectDir}/src/dist") { + include 'notice.txt' + into 'META-INF' + expand(version: project.version) + } + from("${rootProject.projectDir}") { + include 'LICENSE.txt' + into 'META-INF' + } relocate 'com.github.benmanes.caffeine', 'org.springframework.pulsar.shade.com.github.benmanes.caffeine' relocate 'com.google', 'org.springframework.pulsar.shade.com.google' dependencies { diff --git a/buildSrc/src/main/resources/NOTICE.txt b/src/dist/notice.txt similarity index 100% rename from buildSrc/src/main/resources/NOTICE.txt rename to src/dist/notice.txt