[java-metadata-aggregator] branch main updated: Take advantage of ensureId method
Ian Young
ian at iay.org.uk
Fri Apr 21 16:36:29 UTC 2023
This is an automated email from the git hooks/post-receive script.
iay pushed a commit to branch main
in repository java-metadata-aggregator.
View the commit online:
http://git.shibboleth.net/view/?p=java-metadata-aggregator.git;a=commit;h=b2f8b76d4cac3fe7a5f67b089b6a7a495d440ad9
The following commit(s) were added to refs/heads/main by this push:
new b2f8b76 Take advantage of ensureId method
b2f8b76 is described below
commit b2f8b76d4cac3fe7a5f67b089b6a7a495d440ad9
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Fri Apr 21 17:36:23 2023 +0100
Take advantage of ensureId method
---
.../main/java/net/shibboleth/metadata/ErrorStatus.java | 17 ++---------------
.../main/java/net/shibboleth/metadata/InfoStatus.java | 17 ++---------------
.../java/net/shibboleth/metadata/StatusMetadata.java | 16 +---------------
.../java/net/shibboleth/metadata/WarningStatus.java | 17 ++---------------
.../metadata/dom/AbstractDOMTraversalStage.java | 2 +-
.../metadata/dom/AbstractNamespacesStrippingStage.java | 2 +-
.../metadata/dom/AbstractXSLProcessingStage.java | 6 +++---
.../metadata/dom/XMLSchemaValidationStage.java | 4 ++--
.../metadata/dom/XMLSignatureValidationStage.java | 8 ++++----
.../saml/DuplicateEntityInAggregateCheckingStage.java | 2 +-
.../metadata/dom/saml/ValidateValidUntilStage.java | 10 ++++++----
.../dom/saml/mdattr/EntityAttributeFilteringStage.java | 2 +-
.../mdrpi/RegistrationAuthorityPopulationStage.java | 4 ++--
13 files changed, 28 insertions(+), 79 deletions(-)
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/ErrorStatus.java b/mda-framework/src/main/java/net/shibboleth/metadata/ErrorStatus.java
index e05b994..a5071b3 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/ErrorStatus.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/ErrorStatus.java
@@ -17,6 +17,7 @@
package net.shibboleth.metadata;
+import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;
/** A type of {@link StatusMetadata} that indicates something is definitely wrong with the Item. */
@@ -25,25 +26,11 @@ public class ErrorStatus extends StatusMetadata {
/**
* Constructor.
- *
- * <p>
- * Note that the parameters must not be either <code>null</code>
- * or the empty string. However, as they are often set from
- * theoretically nullable sources such as a a bean's identifier
- * (which is not statically known to be non-null until after
- * initialization) or a <code>toString</code> method result,
- * this is not not included in the parameter annotations.
- * </p>
- *
- * <p>
- * Instead, nullness is checked as a run-time
- * constraint resulting in a <code>ConstraintViolation</code>.
- * </p>
*
* @param componentId ID of the component creating the status message, never null or empty
* @param statusMessage the status message, never null or empty
*/
- public ErrorStatus(final String componentId, final String statusMessage) {
+ public ErrorStatus(final @Nonnull String componentId, final String statusMessage) {
super(componentId, statusMessage);
}
}
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/InfoStatus.java b/mda-framework/src/main/java/net/shibboleth/metadata/InfoStatus.java
index 200719a..11bc25b 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/InfoStatus.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/InfoStatus.java
@@ -17,6 +17,7 @@
package net.shibboleth.metadata;
+import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;
/**
@@ -29,24 +30,10 @@ public class InfoStatus extends StatusMetadata {
/**
* Constructor.
*
- * <p>
- * Note that the parameters must not be either <code>null</code>
- * or the empty string. However, as they are often set from
- * theoretically nullable sources such as a a bean's identifier
- * (which is not statically known to be non-null until after
- * initialization) or a <code>toString</code> method result,
- * this is not not included in the parameter annotations.
- * </p>
- *
- * <p>
- * Instead, nullness is checked as a run-time
- * constraint resulting in a <code>ConstraintViolation</code>.
- * </p>
- *
* @param componentId ID of the component creating the status message, never null or empty
* @param statusMessage the status message, never null or empty
*/
- public InfoStatus(final String componentId, final String statusMessage) {
+ public InfoStatus(final @Nonnull String componentId, final String statusMessage) {
super(componentId, statusMessage);
}
}
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/StatusMetadata.java b/mda-framework/src/main/java/net/shibboleth/metadata/StatusMetadata.java
index e18bb41..09d7330 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/StatusMetadata.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/StatusMetadata.java
@@ -37,24 +37,10 @@ public class StatusMetadata implements ItemMetadata {
/**
* Constructor.
*
- * <p>
- * Note that the parameters must not be either <code>null</code>
- * or the empty string. However, as they are often set from
- * theoretically nullable sources such as a a bean's identifier
- * (which is not statically known to be non-null until after
- * initialization) or a <code>toString</code> method result,
- * this is not not included in the parameter annotations.
- * </p>
- *
- * <p>
- * Instead, nullness is checked as a run-time
- * constraint resulting in a <code>ConstraintViolation</code>.
- * </p>
- *
* @param componentId ID of the component creating the status message, never null or empty
* @param statusMessage the status message, never null or empty
*/
- public StatusMetadata(final String componentId, final String statusMessage) {
+ public StatusMetadata(final @Nonnull String componentId, final String statusMessage) {
component = Constraint.isNotNull(StringSupport.trimOrNull(componentId),
"Component ID can not be null or empty");
message = Constraint.isNotNull(StringSupport.trimOrNull(statusMessage),
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/WarningStatus.java b/mda-framework/src/main/java/net/shibboleth/metadata/WarningStatus.java
index a0487f2..bd5bd47 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/WarningStatus.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/WarningStatus.java
@@ -17,6 +17,7 @@
package net.shibboleth.metadata;
+import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;
/**
@@ -32,24 +33,10 @@ public class WarningStatus extends StatusMetadata {
/**
* Constructor.
*
- * <p>
- * Note that the parameters must not be either <code>null</code>
- * or the empty string. However, as they are often set from
- * theoretically nullable sources such as a a bean's identifier
- * (which is not statically known to be non-null until after
- * initialization) or a <code>toString</code> method result,
- * this is not not included in the parameter annotations.
- * </p>
- *
- * <p>
- * Instead, nullness is checked as a run-time
- * constraint resulting in a <code>ConstraintViolation</code>.
- * </p>
- *
* @param componentId ID of the component creating the status message, never null or empty
* @param statusMessage the status message, never null or empty
*/
- public WarningStatus(final String componentId, final String statusMessage) {
+ public WarningStatus(final @Nonnull String componentId, final String statusMessage) {
super(componentId, statusMessage);
}
}
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractDOMTraversalStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractDOMTraversalStage.java
index cdc3761..f2da00f 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractDOMTraversalStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractDOMTraversalStage.java
@@ -146,7 +146,7 @@ public abstract class AbstractDOMTraversalStage<C extends DOMTraversalContext>
@Nonnull final String error) {
final ClassToInstanceMultiMap<ItemMetadata> metadata = item.getItemMetadata();
final String prefix = errorPrefix(element);
- metadata.put(new ErrorStatus(getId(), prefix + error));
+ metadata.put(new ErrorStatus(ensureId(), prefix + error));
}
}
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractNamespacesStrippingStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractNamespacesStrippingStage.java
index e9c213a..6c01235 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractNamespacesStrippingStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractNamespacesStrippingStage.java
@@ -74,7 +74,7 @@ public abstract class AbstractNamespacesStrippingStage extends AbstractIterating
*/
if (removingNamespace(element.getNamespaceURI())) {
final ClassToInstanceMultiMap<ItemMetadata> metadata = item.getItemMetadata();
- metadata.put(new ErrorStatus(getId(), "can't strip namespace from document element"));
+ metadata.put(new ErrorStatus(ensureId(), "can't strip namespace from document element"));
return;
}
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractXSLProcessingStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractXSLProcessingStage.java
index 9d037b5..e733146 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractXSLProcessingStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/AbstractXSLProcessingStage.java
@@ -380,13 +380,13 @@ public abstract class AbstractXSLProcessingStage extends AbstractStage<Element>
final String statusMessage;
if (errorMessage.startsWith(ERROR_PREFIX)) {
statusMessage = StringSupport.trim(errorMessage.substring(ERROR_PREFIX.length()));
- item.getItemMetadata().put(new ErrorStatus(getId(), statusMessage));
+ item.getItemMetadata().put(new ErrorStatus(ensureId(), statusMessage));
} else if (errorMessage.startsWith(WARN_PREFIX)) {
statusMessage = StringSupport.trim(errorMessage.substring(WARN_PREFIX.length()));
- item.getItemMetadata().put(new WarningStatus(getId(), statusMessage));
+ item.getItemMetadata().put(new WarningStatus(ensureId(), statusMessage));
} else if (errorMessage.startsWith(INFO_PREFIX)) {
statusMessage = StringSupport.trim(errorMessage.substring(INFO_PREFIX.length()));
- item.getItemMetadata().put(new InfoStatus(getId(), statusMessage));
+ item.getItemMetadata().put(new InfoStatus(ensureId(), statusMessage));
} else {
throw e;
}
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/XMLSchemaValidationStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/XMLSchemaValidationStage.java
index b04d1c4..6123ca3 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/XMLSchemaValidationStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/XMLSchemaValidationStage.java
@@ -139,9 +139,9 @@ public class XMLSchemaValidationStage extends AbstractIteratingStage<Element> {
LOG.debug("DOM Element was not valid:\n{}", SerializeSupport.prettyPrintXML(item.unwrap()), e);
}
if (isElementRequiredToBeSchemaValid()) {
- item.getItemMetadata().put(new ErrorStatus(getId(), e.getMessage()));
+ item.getItemMetadata().put(new ErrorStatus(ensureId(), e.getMessage()));
} else {
- item.getItemMetadata().put(new WarningStatus(getId(), e.getMessage()));
+ item.getItemMetadata().put(new WarningStatus(ensureId(), e.getMessage()));
}
}
}
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/XMLSignatureValidationStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/XMLSignatureValidationStage.java
index 8e45809..5145702 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/XMLSignatureValidationStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/XMLSignatureValidationStage.java
@@ -252,7 +252,7 @@ public class XMLSignatureValidationStage extends AbstractStage<Element> {
if (isSignatureRequired()) {
LOG.debug("DOM Element was not signed and signature is required");
item.getItemMetadata().put(
- new ErrorStatus(getId(), "DOM Element was not signed but signatures are required"));
+ new ErrorStatus(ensureId(), "DOM Element was not signed but signatures are required"));
} else {
LOG.debug("DOM Element is not signed, no verification performed");
}
@@ -261,7 +261,7 @@ public class XMLSignatureValidationStage extends AbstractStage<Element> {
} catch (final ValidationException e) {
// pass on an error from signature location (e.g., multiple signatures)
LOG.debug("setting status: ", e.getMessage());
- item.getItemMetadata().put(new ErrorStatus(getId(), e.getMessage()));
+ item.getItemMetadata().put(new ErrorStatus(ensureId(), e.getMessage()));
return;
}
@@ -275,9 +275,9 @@ public class XMLSignatureValidationStage extends AbstractStage<Element> {
final String message = "element signature is invalid: " + e.getMessage();
LOG.debug("setting status: ", message);
if (isValidSignatureRequired()) {
- item.getItemMetadata().put(new ErrorStatus(getId(), message));
+ item.getItemMetadata().put(new ErrorStatus(ensureId(), message));
} else {
- item.getItemMetadata().put(new WarningStatus(getId(), message));
+ item.getItemMetadata().put(new WarningStatus(ensureId(), message));
}
}
}
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/DuplicateEntityInAggregateCheckingStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/DuplicateEntityInAggregateCheckingStage.java
index 100aa9b..0a6fd34 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/DuplicateEntityInAggregateCheckingStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/DuplicateEntityInAggregateCheckingStage.java
@@ -68,7 +68,7 @@ public class DuplicateEntityInAggregateCheckingStage extends AbstractIteratingSt
if (ids.contains(id)) {
// Report duplicate, but only once.
if (!reported.contains(id)) {
- item.getItemMetadata().put(new ErrorStatus(getId(), "duplicate entityID: " + id));
+ item.getItemMetadata().put(new ErrorStatus(ensureId(), "duplicate entityID: " + id));
reported.add(id);
}
} else {
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/ValidateValidUntilStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/ValidateValidUntilStage.java
index cc82271..ecf576a 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/ValidateValidUntilStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/ValidateValidUntilStage.java
@@ -121,7 +121,7 @@ public class ValidateValidUntilStage extends AbstractIteratingStage<Element> {
SAMLMetadataSupport.VALID_UNTIL_ATTRIB_NAME);
if (attr == null) {
if (isRequireValidUntil()) {
- item.getItemMetadata().put(new ErrorStatus(getId(), "Item does not include a validUntil attribute"));
+ item.getItemMetadata().put(new ErrorStatus(ensureId(), "Item does not include a validUntil attribute"));
}
return;
}
@@ -129,19 +129,21 @@ public class ValidateValidUntilStage extends AbstractIteratingStage<Element> {
final Instant validUntil = AttributeSupport.getDateTimeAttribute(attr);
if (validUntil == null) {
if (isRequireValidUntil()) {
- item.getItemMetadata().put(new ErrorStatus(getId(), "Item does not include a validUntil attribute"));
+ item.getItemMetadata().put(new ErrorStatus(ensureId(), "Item does not include a validUntil attribute"));
}
} else {
final var lowerBound = Instant.now();
if (validUntil.isBefore(lowerBound)) {
- item.getItemMetadata().put(new ErrorStatus(getId(), "Item has a validUntil prior to the current time"));
+ item.getItemMetadata().put(new ErrorStatus(ensureId(),
+ "Item has a validUntil prior to the current time"));
}
if (!getMaxValidityInterval().isZero()) {
final var upperBound = lowerBound.plus(getMaxValidityInterval());
if (validUntil.isAfter(upperBound)) {
item.getItemMetadata().put(
- new ErrorStatus(getId(), "Item has validUntil larger than the maximum validity interval"));
+ new ErrorStatus(ensureId(),
+ "Item has validUntil larger than the maximum validity interval"));
}
}
}
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/mdattr/EntityAttributeFilteringStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/mdattr/EntityAttributeFilteringStage.java
index f67abde..dc661e3 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/mdattr/EntityAttributeFilteringStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/mdattr/EntityAttributeFilteringStage.java
@@ -338,7 +338,7 @@ public class EntityAttributeFilteringStage extends AbstractIteratingStage<Elemen
if (matched ^ isWhitelisting()) {
LOG.debug("removing {}", ctx);
if (isRecordingRemovals()) {
- item.getItemMetadata().put(new WarningStatus(getId(),
+ item.getItemMetadata().put(new WarningStatus(ensureId(),
"removing '" + ctx.getName() + "' = '" + ctx.getValue() + "'"));
}
attribute.removeChild(value);
diff --git a/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/mdrpi/RegistrationAuthorityPopulationStage.java b/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/mdrpi/RegistrationAuthorityPopulationStage.java
index 6595db3..d9a7f6e 100644
--- a/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/mdrpi/RegistrationAuthorityPopulationStage.java
+++ b/mda-framework/src/main/java/net/shibboleth/metadata/dom/saml/mdrpi/RegistrationAuthorityPopulationStage.java
@@ -47,7 +47,7 @@ public class RegistrationAuthorityPopulationStage extends AbstractIteratingStage
if (!SAMLMetadataSupport.isEntityDescriptor(entity)) {
// all items must be EntityDescriptor elements
- metadata.put(new ErrorStatus(getId(), "item was not an EntityDescriptor"));
+ metadata.put(new ErrorStatus(ensureId(), "item was not an EntityDescriptor"));
} else {
// Extract mdrpi:RegistrationInfo if present.
final Element regInfo = SAMLMetadataSupport.getDescriptorExtension(entity,
@@ -57,7 +57,7 @@ public class RegistrationAuthorityPopulationStage extends AbstractIteratingStage
final String attr = AttributeSupport.getAttributeValue(regInfo, null, "registrationAuthority");
if (attr == null) {
final String eid = entity.getAttribute("entityID");
- metadata.put(new ErrorStatus(getId(), "RegistrationInfo for " + eid +
+ metadata.put(new ErrorStatus(ensureId(), "RegistrationInfo for " + eid +
" did not have a registrationAuthority attribute"));
} else {
metadata.put(new RegistrationAuthority(attr));
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list