[java-identity-provider] 01/06: JSPT-98 Integrate lifecycle checking methods in base classes
Rod Widdowson
rdw at steadingsoftware.com
Wed Jul 13 10:35:15 UTC 2022
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=9bcae7bbfa9b28b093767b058793f63781c4bb09
commit 9bcae7bbfa9b28b093767b058793f63781c4bb09
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Tue Jun 28 20:09:36 2022 +0100
JSPT-98 Integrate lifecycle checking methods in base classes
https://shibboleth.atlassian.net/browse/JSPT-98
Stop using ComponentSupport and use the appropriate methods instead:
idp-admin-*
---
.../net/shibboleth/idp/log/LogbackLoggingService.java | 3 +--
.../net/shibboleth/idp/admin/impl/DoStorageOperation.java | 4 +---
.../impl/InitializeAdministrativeProfileContextTree.java | 5 ++---
.../java/net/shibboleth/idp/admin/impl/OutputMetrics.java | 15 +++++++--------
.../net/shibboleth/idp/admin/impl/UnlockDataSealers.java | 3 +--
.../net/shibboleth/idp/admin/impl/UnlockPrivateKeys.java | 15 +++++++--------
6 files changed, 19 insertions(+), 26 deletions(-)
diff --git a/idp-admin-api/src/main/java/net/shibboleth/idp/log/LogbackLoggingService.java b/idp-admin-api/src/main/java/net/shibboleth/idp/log/LogbackLoggingService.java
index 99f909f23..226bde911 100644
--- a/idp-admin-api/src/main/java/net/shibboleth/idp/log/LogbackLoggingService.java
+++ b/idp-admin-api/src/main/java/net/shibboleth/idp/log/LogbackLoggingService.java
@@ -51,7 +51,6 @@ import net.shibboleth.idp.plugin.IdPPlugin;
import net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer;
import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.service.AbstractReloadableService;
import net.shibboleth.utilities.java.support.service.ServiceException;
@@ -90,7 +89,7 @@ public class LogbackLoggingService extends AbstractReloadableService<Object>
/** {@inheritDoc} */
@Override public void setLoggingConfiguration(@Nonnull final Resource configuration) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
configurationResource = Constraint.isNotNull(configuration, "Logging configuration resource cannot be null");
}
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/DoStorageOperation.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/DoStorageOperation.java
index e8410b795..d0d7cfe39 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/DoStorageOperation.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/DoStorageOperation.java
@@ -48,7 +48,6 @@ import net.shibboleth.idp.profile.context.SpringRequestContext;
import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.logic.Constraint;
/**
@@ -92,8 +91,7 @@ public class DoStorageOperation extends AbstractProfileAction {
* @param mapper object mapper
*/
public void setObjectMapper(@Nonnull final ObjectMapper mapper) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
-
+ throwSetterPreconditionExceptions();
objectMapper = Constraint.isNotNull(mapper, "ObjectMapper cannot be null");
}
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/InitializeAdministrativeProfileContextTree.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/InitializeAdministrativeProfileContextTree.java
index 8faa62c4b..7cf6187e8 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/InitializeAdministrativeProfileContextTree.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/InitializeAdministrativeProfileContextTree.java
@@ -36,7 +36,6 @@ import net.shibboleth.idp.profile.IdPEventIds;
import net.shibboleth.idp.profile.context.RelyingPartyContext;
import net.shibboleth.idp.ui.context.RelyingPartyUIContext;
import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.net.ThreadLocalHttpServletRequestProxy;
/**
@@ -68,7 +67,7 @@ public class InitializeAdministrativeProfileContextTree extends AbstractProfileA
* @param descriptor the flow descriptor to base the action on
*/
public void setAdministrativeFlowDescriptor(@Nullable final AdministrativeFlowDescriptor descriptor) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
flowDescriptor = descriptor;
}
@@ -79,7 +78,7 @@ public class InitializeAdministrativeProfileContextTree extends AbstractProfileA
* @param langs a semi-colon separated string.
*/
public void setFallbackLanguages(@Nonnull @NonnullElements final List<String> langs) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
if (langs != null) {
fallbackLanguages = List.copyOf(langs);
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/OutputMetrics.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/OutputMetrics.java
index e2ab8f4a6..9cbe65043 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/OutputMetrics.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/OutputMetrics.java
@@ -56,7 +56,6 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterI
import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.primitive.StringSupport;
@@ -116,7 +115,7 @@ public class OutputMetrics extends AbstractProfileAction {
* @param filter metric filter
*/
public void setMetricFilter(@Nullable final MetricFilter filter) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
metricFilter = filter;
}
@@ -127,7 +126,7 @@ public class OutputMetrics extends AbstractProfileAction {
* @param registry metric registry
*/
public void setMetricRegistry(@Nonnull final MetricRegistry registry) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
metricRegistry = Constraint.isNotNull(registry, "MetricRegistry cannot be null");
}
@@ -138,7 +137,7 @@ public class OutputMetrics extends AbstractProfileAction {
* @param origin header value
*/
public void setAllowedOrigin(@Nullable final String origin) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
allowedOrigin = StringSupport.trimOrNull(origin);
}
@@ -149,7 +148,7 @@ public class OutputMetrics extends AbstractProfileAction {
* @param callbackName callback function name.
*/
public void setJSONPCallbackName(@Nullable final String callbackName) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
jsonpCallbackName = StringSupport.trimOrNull(callbackName);
}
@@ -160,7 +159,7 @@ public class OutputMetrics extends AbstractProfileAction {
* @param format formatting string
*/
public void setDateTimeFormat(@Nullable @NotEmpty final String format) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
if (format != null) {
dateTimeFormatter = DateTimeFormatter.ofPattern(StringSupport.trimOrNull(format));
@@ -175,7 +174,7 @@ public class OutputMetrics extends AbstractProfileAction {
* @since 4.1.0
*/
public void setUseDefaultTimeZone(final boolean flag) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
useDefaultTimeZone = flag;
}
@@ -186,7 +185,7 @@ public class OutputMetrics extends AbstractProfileAction {
* @param map group to filter map
*/
public void setMetricFilterMap(@Nonnull @NonnullElements final Map<String,MetricFilter> map) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
Constraint.isNotNull(map, "MetricFilter map cannot be null");
metricFilterMap = new HashMap<>(map.size());
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/UnlockDataSealers.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/UnlockDataSealers.java
index 62620a004..36d2aa524 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/UnlockDataSealers.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/UnlockDataSealers.java
@@ -36,7 +36,6 @@ import jakarta.servlet.http.HttpServletRequest;
import net.shibboleth.idp.profile.AbstractProfileAction;
import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.security.impl.BasicKeystoreKeyStrategy;
/**
@@ -78,7 +77,7 @@ public class UnlockDataSealers extends AbstractProfileAction {
* @param strategies objects to unlock
*/
public void setKeyStrategies(@Nullable @NonnullElements final Collection<BasicKeystoreKeyStrategy> strategies) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
if (strategies != null) {
keyStrategies = List.copyOf(strategies);
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/UnlockPrivateKeys.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/UnlockPrivateKeys.java
index 52a50e373..e2cc28d32 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/UnlockPrivateKeys.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/UnlockPrivateKeys.java
@@ -28,12 +28,6 @@ import java.util.List;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
-import net.shibboleth.idp.profile.AbstractProfileAction;
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
-import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
-import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
-
import org.cryptacular.EncodingException;
import org.opensaml.profile.action.ActionSupport;
import org.opensaml.profile.action.EventIds;
@@ -44,6 +38,11 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.io.Resource;
+import net.shibboleth.idp.profile.AbstractProfileAction;
+import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
+import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+
/**
* Action that creates private key objects and injects them into existing
* {@link MutableCredential} objects.
@@ -82,7 +81,7 @@ public class UnlockPrivateKeys extends AbstractProfileAction {
* @param creds credentials to load keys into
*/
public void setCredentials(@Nullable @NonnullElements final Collection<MutableCredential> creds) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
if (creds != null) {
credentials = List.copyOf(creds);
@@ -97,7 +96,7 @@ public class UnlockPrivateKeys extends AbstractProfileAction {
* @param keys key resources to load
*/
public void setKeyResources(@Nullable @NonnullElements final Collection<Resource> keys) {
- ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+ throwSetterPreconditionExceptions();
if (keys != null) {
keyResources = List.copyOf(keys);
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list