[java-mvn-enforcer] 02/04: Stop needlessly using DependencyPomArtifacts
Rod Widdowson
rdw at steadingsoftware.com
Tue Oct 11 08:34:11 UTC 2022
This is an automated email from the git hooks/post-receive script.
rdw pushed a commit to branch main
in repository java-mvn-enforcer.
View the commit online:
http://git.shibboleth.net/view/?p=java-mvn-enforcer.git;a=commit;h=e740dcae31ee14dfdbb0426271172eabc62b08dc
commit e740dcae31ee14dfdbb0426271172eabc62b08dc
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Mon Oct 10 11:17:23 2022 +0100
Stop needlessly using DependencyPomArtifacts
There are several places (notably in signature checking) where
we only care about an artifact in terms of being a container for
maven coordinates (rather than the encapsulation of a <dependency>)
Exploit this.
---
.../net/shibboleth/mvn/enforcer/impl/BaseSigChecker.java | 4 ++--
.../java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java | 3 +--
.../java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java | 6 +++---
.../java/net/shibboleth/mvn/enforcer/impl/MavenLoader.java | 6 ++----
.../java/net/shibboleth/mvn/enforcer/impl/ParsedPom.java | 13 +------------
.../java/net/shibboleth/mvn/enforcer/impl/SigChecker.java | 4 +---
6 files changed, 10 insertions(+), 26 deletions(-)
diff --git a/src/main/java/net/shibboleth/mvn/enforcer/impl/BaseSigChecker.java b/src/main/java/net/shibboleth/mvn/enforcer/impl/BaseSigChecker.java
index b8ef8db..bf4f6c3 100644
--- a/src/main/java/net/shibboleth/mvn/enforcer/impl/BaseSigChecker.java
+++ b/src/main/java/net/shibboleth/mvn/enforcer/impl/BaseSigChecker.java
@@ -94,7 +94,7 @@ public class BaseSigChecker {
* @param artifact the {@link DependencyPomArtifact} for the jar file.
* @return true if the signature passed (or some other "usual conditions)
*/
- protected boolean checkSignature(final InputStream jarFile, final DependencyPomArtifact artifact) {
+ protected boolean checkSignature(final InputStream jarFile, final PomArtifact artifact) {
final String group = artifact.getGroupId();
final String id = artifact.getArtifactId();
final String version;
@@ -154,7 +154,7 @@ public class BaseSigChecker {
* @param artifact what to load
* @return the Signature or null if we couldn't locate it.
*/
- private Signature getSignature(final DependencyPomArtifact artifact) {
+ private Signature getSignature(final PomArtifact artifact) {
Path path;
try {
path = getMavenLoader().downloadArtifact(artifact, "jar.asc");
diff --git a/src/main/java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java b/src/main/java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java
index d0b2ab7..9f31474 100644
--- a/src/main/java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java
+++ b/src/main/java/net/shibboleth/mvn/enforcer/impl/JarEnforcer.java
@@ -51,7 +51,6 @@ import org.apache.maven.repository.RepositorySystem;
import org.slf4j.Logger;
import net.shibboleth.mvn.enforcer.impl.GPGKeyRing.Signature;
-import net.shibboleth.mvn.enforcer.impl.ParsedPom.DependencyPomArtifact;
import net.shibboleth.utilities.java.support.primitive.StringSupport;
import net.shibboleth.utilities.java.support.xml.BasicParserPool;
import net.shibboleth.utilities.java.support.xml.XMLConstants;
@@ -449,7 +448,7 @@ public class JarEnforcer implements EnforcerRule, MavenLoader{
}
/** {@inheritDoc} */
- public Path downloadArtifact(final DependencyPomArtifact artifact, final String type) throws Exception {
+ public Path downloadArtifact(final PomArtifact artifact, final String type) throws Exception {
final File file = downloadArtifact(artifact.getGroupId(), artifact.getArtifactId(), artifact.getVersion(), artifact.getClassifier(), type);
if (file == null) {
return null;
diff --git a/src/main/java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java b/src/main/java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java
index c413865..2ad5e4a 100644
--- a/src/main/java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java
+++ b/src/main/java/net/shibboleth/mvn/enforcer/impl/M2SigChecker.java
@@ -89,7 +89,7 @@ public class M2SigChecker extends BaseSigChecker {
fileName.endsWith("-javadoc.jar") ) {
return result;
}
- final DependencyPomArtifact info = artifactFromPath(relativePath);
+ final PomArtifact info = artifactFromPath(relativePath);
if (info == null || info.getVersion() == null) {
log.error("Badly located jar file {}", file);
return result;
@@ -115,7 +115,7 @@ public class M2SigChecker extends BaseSigChecker {
* @param path the path to an artifact.
* @return a suitable {@link DependencyPomArtifact}
*/
- private DependencyPomArtifact artifactFromPath(Path path) {
+ private PomArtifact artifactFromPath(Path path) {
final Path versionDir = path.getParent();
if (versionDir == null) {
return null;
@@ -159,7 +159,7 @@ public class M2SigChecker extends BaseSigChecker {
if (buf.length() > 0) {
buf.deleteCharAt(buf.length()-1);
}
- return getProjectContext().getParentPom().new DependencyPomArtifact(buf.toString(), artifactId, version, classifier);
+ return new PomArtifact(buf.toString(), artifactId, version, classifier);
}
}
diff --git a/src/main/java/net/shibboleth/mvn/enforcer/impl/MavenLoader.java b/src/main/java/net/shibboleth/mvn/enforcer/impl/MavenLoader.java
index fca97fa..bbf35d0 100644
--- a/src/main/java/net/shibboleth/mvn/enforcer/impl/MavenLoader.java
+++ b/src/main/java/net/shibboleth/mvn/enforcer/impl/MavenLoader.java
@@ -19,18 +19,16 @@ package net.shibboleth.mvn.enforcer.impl;
import java.nio.file.Path;
-import net.shibboleth.mvn.enforcer.impl.ParsedPom.DependencyPomArtifact;
-
/**
* Abstraction of a way to get hold of a maven artifact.
*/
public interface MavenLoader {
- /** tell Something to download the artifact and returns it's path.
+ /** Tell Something to download the artifact and returns it's path.
* @param artifact what to look for
* @param type the maven type to load
* @return the address of the artifact
* @throws Exception on an error
*/
- Path downloadArtifact(DependencyPomArtifact artifact, String type) throws Exception;
+ Path downloadArtifact(PomArtifact artifact, String type) throws Exception;
}
\ No newline at end of file
diff --git a/src/main/java/net/shibboleth/mvn/enforcer/impl/ParsedPom.java b/src/main/java/net/shibboleth/mvn/enforcer/impl/ParsedPom.java
index c3125f6..dd4dff7 100644
--- a/src/main/java/net/shibboleth/mvn/enforcer/impl/ParsedPom.java
+++ b/src/main/java/net/shibboleth/mvn/enforcer/impl/ParsedPom.java
@@ -438,21 +438,10 @@ public class ParsedPom {
* @param ver the <version>
* @param clssfr the <classifier>
*/
- public DependencyPomArtifact(final String group, final String id, final String ver, final String clssfr) {
+ private DependencyPomArtifact(final String group, final String id, final String ver, final String clssfr) {
super(group, id, ver, clssfr);
}
- /**
- * Constructor.
- *
- * @param id the <artifactId>
- * @param group the <groupId>
- * @param ver the <version>
- */
- public DependencyPomArtifact(final String group, final String id, final String ver) {
- this(group, id, ver, "");
- }
-
/**
* @return the pom source.
*/
diff --git a/src/main/java/net/shibboleth/mvn/enforcer/impl/SigChecker.java b/src/main/java/net/shibboleth/mvn/enforcer/impl/SigChecker.java
index 1315665..e66a564 100644
--- a/src/main/java/net/shibboleth/mvn/enforcer/impl/SigChecker.java
+++ b/src/main/java/net/shibboleth/mvn/enforcer/impl/SigChecker.java
@@ -28,7 +28,6 @@ import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.ArchiveInputStream;
import org.slf4j.Logger;
-import net.shibboleth.mvn.enforcer.impl.ParsedPom.DependencyPomArtifact;
import net.shibboleth.utilities.java.support.collection.Pair;
/**
@@ -85,8 +84,7 @@ public class SigChecker extends BaseSigChecker {
final String jarName = Path.of(jarPath).getFileName().toString();
final Pair<String,String> name = getProjectContext().splitFileName(jarName);
final String group = getProjectContext().getGroup(name.getFirst());
- final DependencyPomArtifact jarAsArtifact =
- getProjectContext().getParentPom().new DependencyPomArtifact(group, name.getFirst(), name.getSecond());
+ final PomArtifact jarAsArtifact = new PomArtifact(group, name.getFirst(), name.getSecond());
if (checkSignature(input, jarAsArtifact)) {
return 0;
}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list