[java-identity-provider] branch main updated: Fix javadoc and checkstyle warnings.
Scott Cantor
cantor.2 at osu.edu
Wed Oct 18 17:54:21 UTC 2023
This is an automated email from the git hooks/post-receive script.
scantor 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=2fb66825f7922182e0d3c9b1095c1679384e4f06
The following commit(s) were added to refs/heads/main by this push:
new 2fb66825f Fix javadoc and checkstyle warnings.
2fb66825f is described below
commit 2fb66825f7922182e0d3c9b1095c1679384e4f06
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Wed Oct 18 13:54:18 2023 -0400
Fix javadoc and checkstyle warnings.
---
.../shibboleth/idp/admin/impl/OutputConfig.java | 7 +++
.../idp/admin/impl/ReportModuleStatus.java | 24 +++++---
.../config/LDAPAuthenticationFactoryBean.java | 20 ++++++-
.../idp/profile/logic/ScriptedPredicate.java | 6 +-
.../MockAuthenticationProfileConfiguration.java | 5 +-
.../idp/authn/testing/TestPrincipal.java | 2 +-
.../idp/profile/testing/ActionTestingSupport.java | 17 ++++--
.../idp/saml/impl/testing/TestSources.java | 69 ++++++++++++++--------
.../profile/testing/ActionTestSupportAction.java | 2 +-
9 files changed, 107 insertions(+), 45 deletions(-)
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/OutputConfig.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/OutputConfig.java
index 71e8f0024..f9e09c83d 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/OutputConfig.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/OutputConfig.java
@@ -268,6 +268,13 @@ public class OutputConfig extends AbstractProfileAction {
}
// Checkstyle: CyclomaticComplexity ON
+ /**
+ * Check an object for whether it's a boxed primitive type or one of the time wrappers.
+ *
+ * @param o object to test
+ *
+ * @return true iff the type of the object is one of the boxed primitive types
+ */
private boolean isPrimitive(@Nullable final Object o) {
return o instanceof Boolean
|| o instanceof Integer
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/ReportModuleStatus.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/ReportModuleStatus.java
index 9efb0f745..513b0347a 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/ReportModuleStatus.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/admin/impl/ReportModuleStatus.java
@@ -38,20 +38,24 @@ import net.shibboleth.shared.primitive.LoggerFactory;
public class ReportModuleStatus extends AbstractIdentifiableInitializableComponent {
/** Log. */
- private final Logger log = LoggerFactory.getLogger(ReportModuleStatus.class);
+ @Nonnull private final Logger log = LoggerFactory.getLogger(ReportModuleStatus.class);
/** The IdOP Home dir. */
@Nonnull private String idpHome="";
- /** Where IdP Home is.
+ /**
+ * Sets IdP home location.
+ *
* @param input what to set.
*/
- public void setIdpHome(@Nonnull @NotEmpty String input) {
+ public void setIdpHome(@Nonnull @NotEmpty final String input) {
idpHome = Constraint.isNotNull(input, "IdpHome not set");
}
- /** Return all the enabled modules.
- * @return the module ids
+ /**
+ * Return all the enabled modules.
+ *
+ * @return the module IDs.
*/
@Nonnull private Set<String> getEnabledModules() {
final HashSet<String> result = new HashSet<>();
@@ -70,10 +74,12 @@ public class ReportModuleStatus extends AbstractIdentifiableInitializableCompone
return result;
}
- /** Check whether any plugin required a non enabled plugin.
- * @param enabledModules
+ /**
+ * Check whether any plugin required a non-enabled module.
+ *
+ * @param enabledModules the enabled module IDs
*/
- private void checkPlugins(@Nonnull Set<String> enabledModules) {
+ private void checkPlugins(@Nonnull final Set<String> enabledModules) {
final Iterator<IdPPlugin> plugins = ServiceLoader.load(IdPPlugin.class).iterator();
while (plugins.hasNext()) {
final IdPPlugin plugin = plugins.next();
@@ -95,4 +101,4 @@ public class ReportModuleStatus extends AbstractIdentifiableInitializableCompone
checkPlugins(getEnabledModules());
}
-}
+}
\ No newline at end of file
diff --git a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/config/LDAPAuthenticationFactoryBean.java b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/config/LDAPAuthenticationFactoryBean.java
index 05a569fc3..20e300ec9 100644
--- a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/config/LDAPAuthenticationFactoryBean.java
+++ b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/config/LDAPAuthenticationFactoryBean.java
@@ -910,7 +910,16 @@ public class LDAPAuthenticationFactoryBean extends AbstractFactoryBean<Authentic
return factory;
}
- protected SearchConnectionValidator createSearchConnectionValidator(final String baseDn, final String filter) {
+ /**
+ * Create {@link SearchConnectionValidator}.
+ *
+ * @param baseDn base DN
+ * @param filter search filter
+ *
+ * @return the validator
+ */
+ @Nonnull protected SearchConnectionValidator createSearchConnectionValidator(@Nullable final String baseDn,
+ @Nullable final String filter) {
final SearchRequest searchRequest = new SearchRequest();
searchRequest.setReturnAttributes("1.1");
searchRequest.setSearchScope(SearchScope.OBJECT);
@@ -930,7 +939,14 @@ public class LDAPAuthenticationFactoryBean extends AbstractFactoryBean<Authentic
return SearchConnectionValidator.builder().request(searchRequest).period(validatePeriod).build();
}
- protected ConnectionPassivator createConnectionPassivator(final PassivatorType type) {
+ /**
+ * Creates {@link ConnectionPassivator} object.
+ *
+ * @param type type to create
+ *
+ * @return the created object
+ */
+ @Nullable protected ConnectionPassivator createConnectionPassivator(@Nonnull final PassivatorType type) {
switch (type) {
case BIND:
return new BindConnectionPassivator(new SimpleBindRequest(bindDn, new Credential(bindDnCredential)));
diff --git a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/logic/ScriptedPredicate.java b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/logic/ScriptedPredicate.java
index 1cb911146..387c6ffe0 100644
--- a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/logic/ScriptedPredicate.java
+++ b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/logic/ScriptedPredicate.java
@@ -117,10 +117,14 @@ public class ScriptedPredicate extends net.shibboleth.profile.context.logic.Scri
* Factory to create {@link ScriptedPredicate} from inline data.
*
* @param scriptSource the script, as a string
+ *
* @return the predicate
+ *
* @throws ScriptException if the compile fails
+ * @throws ComponentInitializationException if the script object fails to initialize
*/
- public static ScriptedPredicate inlineScript(@Nonnull @NotEmpty final String scriptSource) throws ScriptException, ComponentInitializationException {
+ public static ScriptedPredicate inlineScript(@Nonnull @NotEmpty final String scriptSource)
+ throws ScriptException, ComponentInitializationException {
return inlineScript(DEFAULT_ENGINE, scriptSource);
}
diff --git a/idp-testing/src/main/java/net/shibboleth/idp/authn/testing/MockAuthenticationProfileConfiguration.java b/idp-testing/src/main/java/net/shibboleth/idp/authn/testing/MockAuthenticationProfileConfiguration.java
index 273fe2454..3b23f2c98 100644
--- a/idp-testing/src/main/java/net/shibboleth/idp/authn/testing/MockAuthenticationProfileConfiguration.java
+++ b/idp-testing/src/main/java/net/shibboleth/idp/authn/testing/MockAuthenticationProfileConfiguration.java
@@ -102,7 +102,8 @@ public class MockAuthenticationProfileConfiguration extends AbstractInterceptorA
* @param methods default authentication methods to use
*/
public void setDefaultAuthenticationMethods(@Nonnull final List<Principal> methods) {
- defaultAuthenticationMethods = CollectionSupport.copyToList(Constraint.isNotNull(methods, "List of methods cannot be null"));
+ defaultAuthenticationMethods = CollectionSupport.copyToList(
+ Constraint.isNotNull(methods, "List of methods cannot be null"));
}
/**
@@ -162,7 +163,7 @@ public class MockAuthenticationProfileConfiguration extends AbstractInterceptorA
}
/** {@inheritDoc} */
- public boolean isForceAuthn(@Nullable ProfileRequestContext profileRequestContext) {
+ public boolean isForceAuthn(@Nullable final ProfileRequestContext profileRequestContext) {
return forceAuthnPredicate.test(profileRequestContext);
}
diff --git a/idp-testing/src/main/java/net/shibboleth/idp/authn/testing/TestPrincipal.java b/idp-testing/src/main/java/net/shibboleth/idp/authn/testing/TestPrincipal.java
index e921025c1..5baa1cbed 100644
--- a/idp-testing/src/main/java/net/shibboleth/idp/authn/testing/TestPrincipal.java
+++ b/idp-testing/src/main/java/net/shibboleth/idp/authn/testing/TestPrincipal.java
@@ -50,7 +50,7 @@ public final class TestPrincipal implements Principal {
}
/** {@inheritDoc} */
- public boolean equals(Object other) {
+ public boolean equals(final Object other) {
if (other == null) {
return false;
}
diff --git a/idp-testing/src/main/java/net/shibboleth/idp/profile/testing/ActionTestingSupport.java b/idp-testing/src/main/java/net/shibboleth/idp/profile/testing/ActionTestingSupport.java
index 6b34c8e8d..f2635a0b2 100644
--- a/idp-testing/src/main/java/net/shibboleth/idp/profile/testing/ActionTestingSupport.java
+++ b/idp-testing/src/main/java/net/shibboleth/idp/profile/testing/ActionTestingSupport.java
@@ -26,19 +26,24 @@ import net.shibboleth.shared.annotation.constraint.NotEmpty;
* Helper methods for creating/testing objects within profile action tests. When methods herein refer to mock objects
* they are always objects that have been created via Mockito unless otherwise noted.
*/
-public class ActionTestingSupport {
-
+public final class ActionTestingSupport {
+
/** ID of the inbound message. */
- @Nonnull @NotEmpty public final static String INBOUND_MSG_ID = "inbound";
+ @Nonnull @NotEmpty public static final String INBOUND_MSG_ID = "inbound";
/** Issuer of the inbound message. */
- @Nonnull @NotEmpty public final static String INBOUND_MSG_ISSUER = "http://sp.example.org";
+ @Nonnull @NotEmpty public static final String INBOUND_MSG_ISSUER = "http://sp.example.org";
/** ID of the outbound message. */
- @Nonnull @NotEmpty public final static String OUTBOUND_MSG_ID = "outbound";
+ @Nonnull @NotEmpty public static final String OUTBOUND_MSG_ID = "outbound";
/** Issuer of the outbound message. */
- @Nonnull @NotEmpty public final static String OUTBOUND_MSG_ISSUER = "http://idp.example.org";
+ @Nonnull @NotEmpty public static final String OUTBOUND_MSG_ISSUER = "http://idp.example.org";
+
+ /** Private constructor. */
+ private ActionTestingSupport() {
+
+ }
/**
* Checks that the event is not null, that the event source is not null, and that the event ID is the given id.
diff --git a/idp-testing/src/main/java/net/shibboleth/idp/saml/impl/testing/TestSources.java b/idp-testing/src/main/java/net/shibboleth/idp/saml/impl/testing/TestSources.java
index b25d1a135..f003a3f72 100644
--- a/idp-testing/src/main/java/net/shibboleth/idp/saml/impl/testing/TestSources.java
+++ b/idp-testing/src/main/java/net/shibboleth/idp/saml/impl/testing/TestSources.java
@@ -45,7 +45,6 @@ import net.shibboleth.shared.collection.CollectionSupport;
import net.shibboleth.shared.component.ComponentInitializationException;
/** Basic data sources for testing the attribute generators. */
- at SuppressWarnings({"javadoc", "removal"})
public final class TestSources {
/** The name we use in this test for the static connector. */
@Nonnull public static final String STATIC_CONNECTOR_NAME = "staticCon";
@@ -98,16 +97,16 @@ public final class TestSources {
.compile(CONNECTOR_ATTRIBUTE_VALUE_REGEXP);
/** A {@link StringAttributeValue} with value "Connect". */
- @Nonnull public static final StringAttributeValue CONNECTOR_ATTRIBUTE_VALUE_REGEXP_RESULT = new StringAttributeValue(
- "Connect");
+ @Nonnull public static final StringAttributeValue CONNECTOR_ATTRIBUTE_VALUE_REGEXP_RESULT =
+ new StringAttributeValue("Connect");
- /** Principal name for Principal method tests */
+ /** Principal name for Principal method tests. */
@Nonnull public static final String TEST_PRINCIPAL = "PrincipalName";
- /** Relying party name for Principal method tests */
+ /** Relying party name for Principal method tests. */
@Nonnull public static final String TEST_RELYING_PARTY = "RP1";
- /** Authentication method for Principal method tests */
+ /** Authentication method for Principal method tests. */
@Nonnull public static final String TEST_AUTHN_METHOD = "AuthNmEthod";
/** {@value #IDP_ENTITY_ID}. */
@@ -149,7 +148,7 @@ public final class TestSources {
*/
@SuppressWarnings("null")
@Nonnull public static DataConnector populatedStaticConnector() throws ComponentInitializationException {
- List<IdPAttribute> attributeSet = new ArrayList<>(2);
+ final List<IdPAttribute> attributeSet = new ArrayList<>(2);
IdPAttribute attr = new IdPAttribute(DEPENDS_ON_ATTRIBUTE_NAME_CONNECTOR);
attr.setValues(List.of(new StringAttributeValue(COMMON_ATTRIBUTE_VALUE_STRING),
@@ -174,8 +173,18 @@ public final class TestSources {
return populatedStaticAttribute(DEPENDS_ON_ATTRIBUTE_NAME_ATTR, 2);
}
- @Nonnull public static AttributeDefinition populatedStaticAttribute(@Nonnull String attributeName,
- int attributeValuesCount) throws ComponentInitializationException {
+ /**
+ * Build a Static attribute definition.
+ *
+ * @param attributeName name of attribute
+ * @param attributeValuesCount count of values
+ *
+ * @return the definition
+ *
+ * @throws ComponentInitializationException if the definition fails to init
+ */
+ @Nonnull public static AttributeDefinition populatedStaticAttribute(@Nonnull final String attributeName,
+ final int attributeValuesCount) throws ComponentInitializationException {
final List<IdPAttributeValue> valuesList = new ArrayList<>();
@@ -211,32 +220,41 @@ public final class TestSources {
return definition;
}
- /** return a {@link SAML2NameIDAttributeDefinition} (which doesn't carry string atribure values)
+ /**
+ * Return a {@link SAML2NameIDAttributeDefinition} (which doesn't carry string atribure values).
+ *
* @param name the name
+ *
* @return the definition
+ *
* @throws ComponentInitializationException for completeness
*/
- @Nonnull public static AttributeDefinition nonStringAttributeDefiniton(@Nonnull String name) throws ComponentInitializationException {
+ @Nonnull public static AttributeDefinition nonStringAttributeDefiniton(@Nonnull final String name)
+ throws ComponentInitializationException {
final SAML2NameIDAttributeDefinition defn = new SAML2NameIDAttributeDefinition();
defn.setId(name);
// Set the dependency on the data connector
- ResolverAttributeDefinitionDependency depend = new ResolverAttributeDefinitionDependency(TestSources.DEPENDS_ON_ATTRIBUTE_NAME_ATTR);
+ final ResolverAttributeDefinitionDependency depend =
+ new ResolverAttributeDefinitionDependency(TestSources.DEPENDS_ON_ATTRIBUTE_NAME_ATTR);
defn.setAttributeDependencies(CollectionSupport.singleton(depend));
defn.initialize();
return defn;
}
- /** create a {@link AttributeResolutionContext}.
+ /**
+ * Create a {@link AttributeResolutionContext}.
+ *
* @param principal principal
* @param issuerID issuerID
* @param recipientId recipientId
+ *
* @return the freshly minted context
*/
- public static AttributeResolutionContext createResolutionContext(@Nonnull String principal, @Nonnull String issuerID,
- @Nonnull String recipientId) {
- ProfileRequestContext parent = new ProfileRequestContext();
- AttributeResolutionContext retVal = parent.ensureSubcontext(AttributeResolutionContext.class);
+ @Nonnull public static AttributeResolutionContext createResolutionContext(@Nonnull final String principal,
+ @Nonnull final String issuerID, @Nonnull final String recipientId) {
+ final ProfileRequestContext parent = new ProfileRequestContext();
+ final AttributeResolutionContext retVal = parent.ensureSubcontext(AttributeResolutionContext.class);
retVal.setAttributeIssuerID(issuerID);
retVal.setAttributeRecipientID(recipientId);
@@ -246,12 +264,16 @@ public final class TestSources {
return retVal;
}
- /** Make a {@link ResolverAttributeDefinitionDependency}.
+ /**
+ * Make a {@link ResolverAttributeDefinitionDependency}.
+ *
* @param attributeId attributeId
+ *
* @return the dependency
*/
- @Nonnull public static ResolverAttributeDefinitionDependency makeAttributeDefinitionDependency(@Nonnull String attributeId) {
- ResolverAttributeDefinitionDependency retVal = new ResolverAttributeDefinitionDependency(attributeId);
+ @Nonnull public static ResolverAttributeDefinitionDependency makeAttributeDefinitionDependency(
+ @Nonnull final String attributeId) {
+ final ResolverAttributeDefinitionDependency retVal = new ResolverAttributeDefinitionDependency(attributeId);
return retVal;
}
@@ -260,8 +282,9 @@ public final class TestSources {
* @param attributeId attributeId
* @return the dependency
*/
- @Nonnull public static ResolverDataConnectorDependency makeDataConnectorDependency(@Nonnull String connectorId, @Nullable String attributeId) {
- ResolverDataConnectorDependency retVal = new ResolverDataConnectorDependency(connectorId);
+ @Nonnull public static ResolverDataConnectorDependency makeDataConnectorDependency(
+ @Nonnull final String connectorId, @Nullable final String attributeId) {
+ final ResolverDataConnectorDependency retVal = new ResolverDataConnectorDependency(connectorId);
if (null == attributeId) {
retVal.setAllAttributes(true);
} else {
@@ -333,7 +356,7 @@ public final class TestSources {
*
* @param newValues static values returned by this connector
*/
- public void setValues(@Nullable @NullableElements Collection<IdPAttribute> newValues) {
+ public void setValues(@Nullable @NullableElements final Collection<IdPAttribute> newValues) {
if (null == newValues) {
attributes = null;
diff --git a/idp-testing/src/main/java/net/shibboleth/idp/saml/profile/testing/ActionTestSupportAction.java b/idp-testing/src/main/java/net/shibboleth/idp/saml/profile/testing/ActionTestSupportAction.java
index 4ccf881ed..9a9596308 100644
--- a/idp-testing/src/main/java/net/shibboleth/idp/saml/profile/testing/ActionTestSupportAction.java
+++ b/idp-testing/src/main/java/net/shibboleth/idp/saml/profile/testing/ActionTestSupportAction.java
@@ -36,7 +36,7 @@ public class ActionTestSupportAction extends AbstractProfileAction {
/** {@inheritDoc} */
@Override
- protected void doExecute(@Nonnull ProfileRequestContext profileRequestContext) {
+ protected void doExecute(@Nonnull final ProfileRequestContext profileRequestContext) {
}
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list