[java-identity-provider] branch main updated: Fix build
Rod Widdowson
rdw at steadingsoftware.com
Thu Jun 24 12:13:58 UTC 2021
This is an automated email from the git hooks/post-receive script.
rdw pushed a commit to branch main
in repository java-identity-provider.
View the commit online:
http://git.shibboleth.net/view/?p=java-identity-provider.git;a=commit;h=61d62438144b2173a9d564ab7d8d258fe96e87b4
The following commit(s) were added to refs/heads/main by this push:
new 61d624381 Fix build
61d624381 is described below
commit 61d62438144b2173a9d564ab7d8d258fe96e87b4
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Thu Jun 24 13:13:53 2021 +0100
Fix build
---
.../installer/impl/CurrentInstallStateImpl.java | 2 +-
.../idp/dependencies/DependencyTest.java | 22 ++++++-------
.../net/shibboleth/idp/dependencies/ParsedPom.java | 36 +++++++++++-----------
3 files changed, 30 insertions(+), 30 deletions(-)
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CurrentInstallStateImpl.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CurrentInstallStateImpl.java
index 4238d4bb5..89aaf0ba2 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CurrentInstallStateImpl.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/impl/CurrentInstallStateImpl.java
@@ -139,7 +139,7 @@ public final class CurrentInstallStateImpl extends AbstractInitializableComponen
/** Populate {{@link #props} from idp.properties and other files pointed to by
* {@value IdPPropertiesApplicationContextInitializer#IDP_ADDITIONAL_PROPERTY}.
- * @throws ComponentInitializationException
+ * @throws ComponentInitializationException on various IO issues
*/
private void setupPreviousProps() throws ComponentInitializationException {
if (!isIdPPropertiesPresent()) {
diff --git a/idp-installer/src/test/java/net/shibboleth/idp/dependencies/DependencyTest.java b/idp-installer/src/test/java/net/shibboleth/idp/dependencies/DependencyTest.java
index 52f51c5d9..50a4af684 100644
--- a/idp-installer/src/test/java/net/shibboleth/idp/dependencies/DependencyTest.java
+++ b/idp-installer/src/test/java/net/shibboleth/idp/dependencies/DependencyTest.java
@@ -88,7 +88,7 @@ public class DependencyTest extends OpenSAMLInitBaseTestCase {
private PomArtifact parentArtefact;
/** We have as an assumption that the CWD is idp-installer. Test this.
- * @throws IOException
+ * @throws IOException if the directorty isn't what we expect it to be,
*/
@BeforeClass public void testWorkingDir() throws IOException {
final Path path = Path.of(".");
@@ -123,11 +123,11 @@ public class DependencyTest extends OpenSAMLInitBaseTestCase {
/** Set up the environment for running the test.
* Parse the IdP parent pom.
- * From that find the description of parent pom & download it.
+ * From that find the description of parent pom & download it.
* Parse that.
- * @throws IOException
- * @throws XMLParserException
- * @throws MavenInvocationException
+ * @throws IOException if a folder or files has issues
+ * @throws XMLParserException if the pom is badly formed
+ * @throws MavenInvocationException if maven fails
*/
@BeforeClass(dependsOnMethods = {"setupMavenEnvironment", "testWorkingDir"}) public void setup() throws IOException, XMLParserException, MavenInvocationException {
@@ -256,10 +256,10 @@ public class DependencyTest extends OpenSAMLInitBaseTestCase {
assertEquals(similarNames, 0, "Multiple similarly named jars");
}
- /** report the contributions of the provided dependency & version.
- * @param dependency
- * @param version
- * @param sources
+ /** report the contributions of the provided dependency & version.
+ * @param dependency the artifact ID
+ * @param version the version we are considering
+ * @param sources what caused this to exist
*/
private void reportContributions(final String dependency, final String version, final Collection<String> sources) {
List<String> srcs = new ArrayList<>(sources);
@@ -332,7 +332,7 @@ public class DependencyTest extends OpenSAMLInitBaseTestCase {
/** Create a pom file which has one dependency - this artifact.
* @param artifact the artifact.
* @return the file.
- * @throws FileNotFoundException
+ * @throws FileNotFoundException if the created pom file doesnt exist?
*/
private File outputPom(PomArtifact artifact) throws FileNotFoundException {
final File file = workingDir.resolve(new StringBuilder(artifact.getArtifactId())
@@ -424,7 +424,7 @@ public class DependencyTest extends OpenSAMLInitBaseTestCase {
/** tell maven to download the artifact and returns it's path.
* @param artifact what to look for
* @return the pom as a {@link Path}
- * @throws MavenInvocationException
+ * @throws MavenInvocationException if the download failed
*/
private Path downloadPom(final PomArtifact artifact) throws MavenInvocationException {
final Path output = workingDir.resolve(artifact.getArtifactId() + ".pom");
diff --git a/idp-installer/src/test/java/net/shibboleth/idp/dependencies/ParsedPom.java b/idp-installer/src/test/java/net/shibboleth/idp/dependencies/ParsedPom.java
index 3b76c27f8..b06800588 100644
--- a/idp-installer/src/test/java/net/shibboleth/idp/dependencies/ParsedPom.java
+++ b/idp-installer/src/test/java/net/shibboleth/idp/dependencies/ParsedPom.java
@@ -199,8 +199,8 @@ public class ParsedPom extends OpenSAMLInitBaseTestCase{
}
}
- /**
- * @param item
+ /** Parse the properties from the pom.
+ * @param item the <properties> element
*/
private void parseProperties(Element item) {
@@ -211,36 +211,36 @@ public class ParsedPom extends OpenSAMLInitBaseTestCase{
}
}
- /**
- * @param item
+ /** Parse the parent from the pom.
+ * @param item the <parent> element
*/
private void parseParent(Element item) {
parent = new PomArtifact(item);
}
- /**
- * @return Returns the compileDependencies.
+ /** Returns the Compile Dependencies.
+ * @return Returns the Compile Dependencies.
*/
public List<PomArtifact> getCompileDependencies() {
return compileDependencies;
}
- /**
- * @return Returns the bomDependencies.
+ /** Returns the Bom Dependencies.
+ * @return Returns the Bom Dependencies.
*/
public List<PomArtifact> getBomDependencies() {
return bomDependencies;
}
- /**
- * @return Returns the runtimeDependencies.
+ /** Returns the Runtime Dependencies.
+ * @return Returns the Runtime Dependencies.
*/
public List<PomArtifact> getRuntimeDependencies() {
return runtimeDependencies;
}
- /**
- * @return Returns the myManagedDependencies.
+ /** Returns the Managed Dependencies.
+ * @return Returns the Managed Dependencies.
*/
public List<PomArtifact> getManagedDependencies() {
return myManagedDependencies;
@@ -253,14 +253,14 @@ public class ParsedPom extends OpenSAMLInitBaseTestCase{
return us;
}
- /**
- * @return Returns the parent.
+ /** Return the parent.
+ * @return the parent.
*/
public PomArtifact getParent() {
return parent;
}
- /**
+ /** The <properties> contents.
* @return Returns the properties.
*/
public Properties getProperties() {
@@ -288,9 +288,9 @@ public class ParsedPom extends OpenSAMLInitBaseTestCase{
/**
* Constructor.
*
- * @param id
- * @param group
- * @param ver
+ * @param id the <artifactId>
+ * @param group the <groupId>
+ * @param ver the <version>
*/
private PomArtifact(final String id, final String group, final String ver) {
artifactId = id;
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list