[java-identity-provider] branch main updated: Javadoc and warning fixes.
Scott Cantor
cantor.2 at osu.edu
Tue Mar 9 01:15:16 UTC 2021
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=9b0b5e5f12319990a62011e645bfe17d7aad8d6b
The following commit(s) were added to refs/heads/main by this push:
new 9b0b5e5f1 Javadoc and warning fixes.
9b0b5e5f1 is described below
commit 9b0b5e5f12319990a62011e645bfe17d7aad8d6b
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Mon Mar 8 20:15:12 2021 -0500
Javadoc and warning fixes.
---
.../shibboleth/idp/module/PropertyDrivenIdPModule.java | 5 +++++
.../shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java | 5 +++++
.../idp/module/impl/ModuleManagerArguments.java | 12 ++++++------
.../saml/impl/AbstractEntityAttributePolicyRule.java | 2 +-
.../saml/impl/AbstractEntityGroupPolicyRule.java | 9 ++++-----
.../resolver/spring/dc/impl/CacheConfigParser.java | 4 ++--
.../resolver/spring/dc/impl/DataConnectorFactoryBean.java | 1 +
.../spring/dc/ldap/impl/LDAPDataConnectorParser.java | 8 ++++++++
.../idp/authn/AuthenticationFlowDescriptor.java | 3 ++-
.../authn/impl/InitializeRequestedPrincipalContext.java | 2 +-
.../idp/cas/proxy/impl/HttpClientProxyValidator.java | 11 ++++++-----
.../net/shibboleth/idp/installer/CopyDistribution.java | 3 ++-
.../installer/plugin/impl/PluginInstallerArguments.java | 15 ++++++++++-----
.../shibboleth/idp/installer/plugin/impl/TrustStore.java | 12 ++++++++++++
.../net/shibboleth/idp/profile/AbstractProfileAction.java | 4 ++--
.../java/net/shibboleth/idp/profile/ScriptedAction.java | 2 ++
.../context/navigate/ScriptedContextLookupFunction.java | 1 +
.../shibboleth/idp/profile/logic/ScriptedPredicate.java | 1 +
.../idp/profile/audit/impl/PopulateAuditContext.java | 2 +-
.../impl/DefaultRelyingPartyConfigurationResolver.java | 4 ++--
.../impl/SignatureValidationCriteriaSetFactoryBean.java | 6 +++---
.../trustengine/impl/AbstractStaticPKIXParser.java | 4 ++--
...AbstractMetadataDrivenConfigurationLookupStrategy.java | 2 +-
.../profile/logic/MappedEntityAttributesPredicate.java | 1 +
.../impl/SAML1NameIdentifierAttributeDefinition.java | 10 +++++-----
.../resolver/impl/SAML2NameIDAttributeDefinition.java | 6 +++---
26 files changed, 89 insertions(+), 46 deletions(-)
diff --git a/idp-admin-api/src/main/java/net/shibboleth/idp/module/PropertyDrivenIdPModule.java b/idp-admin-api/src/main/java/net/shibboleth/idp/module/PropertyDrivenIdPModule.java
index 4b912ecf2..d4fa615eb 100644
--- a/idp-admin-api/src/main/java/net/shibboleth/idp/module/PropertyDrivenIdPModule.java
+++ b/idp-admin-api/src/main/java/net/shibboleth/idp/module/PropertyDrivenIdPModule.java
@@ -154,6 +154,11 @@ public class PropertyDrivenIdPModule extends AbstractIdPModule {
}
// Checkstyle: CyclomaticComplexity OFF
+ /**
+ * Load module information from properties.
+ *
+ * @throws ModuleException on errors
+ */
protected void load() throws ModuleException {
try {
moduleId = Constraint.isNotNull(
diff --git a/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java b/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java
index 0205ef80b..884e36cca 100644
--- a/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java
+++ b/idp-admin-api/src/main/java/net/shibboleth/idp/plugin/PropertyDrivenIdPPlugin.java
@@ -122,6 +122,11 @@ public abstract class PropertyDrivenIdPPlugin extends AbstractIdPPlugin {
load();
}
+ /**
+ * Load plugin information from properties.
+ *
+ * @throws PluginException on errors
+ */
protected void load() throws PluginException {
pluginId = StringSupport.trimOrNull(pluginProperties.getProperty(PLUGIN_ID_PROPERTY));
diff --git a/idp-admin-impl/src/main/java/net/shibboleth/idp/module/impl/ModuleManagerArguments.java b/idp-admin-impl/src/main/java/net/shibboleth/idp/module/impl/ModuleManagerArguments.java
index 1a1677dec..85724c3b8 100644
--- a/idp-admin-impl/src/main/java/net/shibboleth/idp/module/impl/ModuleManagerArguments.java
+++ b/idp-admin-impl/src/main/java/net/shibboleth/idp/module/impl/ModuleManagerArguments.java
@@ -80,7 +80,7 @@ public class ModuleManagerArguments extends AbstractIdPHomeAwareCommandLineArgum
/**
* Are we doing a list?
*
- * @return {@link #list}
+ * @return whether this is a list operation
*/
public boolean getList() {
return list;
@@ -89,7 +89,7 @@ public class ModuleManagerArguments extends AbstractIdPHomeAwareCommandLineArgum
/**
* Gets the module ID(s) to report on.
*
- * @return {@link #infoModuleIds}
+ * @return module ID(s) to report on
*/
@Nullable @NonnullElements @NotLive @Unmodifiable public Collection<String> getInfoModuleIds() {
return List.copyOf(StringSupport.normalizeStringCollection(infoModuleIds));
@@ -98,7 +98,7 @@ public class ModuleManagerArguments extends AbstractIdPHomeAwareCommandLineArgum
/**
* Gets the module ID(s) to test.
*
- * @return {@link #testModuleIds}
+ * @return module ID(s) to test
*/
@Nullable @NonnullElements @NotLive @Unmodifiable public Collection<String> getTestModuleIds() {
return List.copyOf(StringSupport.normalizeStringCollection(testModuleIds));
@@ -107,7 +107,7 @@ public class ModuleManagerArguments extends AbstractIdPHomeAwareCommandLineArgum
/**
* Gets the module ID(s) to enable.
*
- * @return {@link #enableModuleIds}
+ * @return module ID(s) to enable
*/
@Nullable @NonnullElements @NotLive @Unmodifiable public Collection<String> getEnableModuleIds() {
return List.copyOf(StringSupport.normalizeStringCollection(enableModuleIds));
@@ -116,7 +116,7 @@ public class ModuleManagerArguments extends AbstractIdPHomeAwareCommandLineArgum
/**
* Gets the module ID(s) to disable.
*
- * @return {@link #disableModuleIds}
+ * @return module ID(s) to disable
*/
@Nullable @NonnullElements @NotLive @Unmodifiable public Collection<String> getDisableModuleIds() {
return List.copyOf(StringSupport.normalizeStringCollection(disableModuleIds));
@@ -125,7 +125,7 @@ public class ModuleManagerArguments extends AbstractIdPHomeAwareCommandLineArgum
/**
* Are we disabling with the clean option?
*
- * @return {@link #clean}
+ * @return clean option
*/
public boolean getClean() {
return clean;
diff --git a/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AbstractEntityAttributePolicyRule.java b/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AbstractEntityAttributePolicyRule.java
index 84fc9ee83..875ec8849 100644
--- a/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AbstractEntityAttributePolicyRule.java
+++ b/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AbstractEntityAttributePolicyRule.java
@@ -141,7 +141,7 @@ public abstract class AbstractEntityAttributePolicyRule extends AbstractPolicyRu
/**
* Sets whether to ignore unmapped/decoded EntityAttribute extensions as an optimization.
*
- * <p>Defaults to false. Only applies if {@link #nameFormat} property is set.</p>
+ * <p>Defaults to false. Only applies if {@link #getNameFormat()} property is non-null.</p>
*
* @param flag flag to set
*/
diff --git a/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AbstractEntityGroupPolicyRule.java b/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AbstractEntityGroupPolicyRule.java
index 45c37ae18..426cd9102 100644
--- a/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AbstractEntityGroupPolicyRule.java
+++ b/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AbstractEntityGroupPolicyRule.java
@@ -33,6 +33,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.primitive.StringSupport;
import org.opensaml.saml.common.profile.logic.EntityGroupNamePredicate;
+import org.opensaml.saml.metadata.resolver.MetadataResolver;
import org.opensaml.saml.saml2.metadata.EntityDescriptor;
/**
@@ -70,8 +71,7 @@ public abstract class AbstractEntityGroupPolicyRule extends AbstractPolicyRule {
}
/**
- * Set whether to check a supplied {@link org.opensaml.saml.metadata.resolver.MetadataResolver}
- * for membership in an AffiliationDescriptor
+ * Set whether to check a supplied {@link MetadataResolver} for membership in an AffiliationDescriptor
* as a form of group policy.
*
* <p>Defaults to false.</p>
@@ -85,11 +85,10 @@ public abstract class AbstractEntityGroupPolicyRule extends AbstractPolicyRule {
/**
- * Returns whether we check a supplied {@link org.opensaml.saml.metadata.resolver.MetadataResolver}
- * for membership in an AffiliationDescriptor
+ * Returns whether we check a supplied {@link MetadataResolver} for membership in an AffiliationDescriptor
* as a form of group policy.
*
- * @return the value of {@link #checkAffiliations}
+ * @return whether to check for AffiliationDescriptor membership
*
* @since 4.0.0
*/
diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/CacheConfigParser.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/CacheConfigParser.java
index 3bf5d7c9c..a59654eb6 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/CacheConfigParser.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/CacheConfigParser.java
@@ -57,13 +57,13 @@ public class CacheConfigParser {
/** Documented maximumCachedElements maximum (500). Unfortunately it has to be here since
* we do not own the implemented class */
- private static final long DEFAULT_CACHE_ENTRIES = 500;
+ public static final long DEFAULT_CACHE_ENTRIES = 500;
/**
* Documented cache lifetime (4 hours). Unfortunately it has to be here since
* we do not own the implemented class.
*/
- @Nonnull private static final Duration DEFAULT_TTL_MS = Duration.ofHours(4);
+ @Nonnull public static final Duration DEFAULT_TTL_MS = Duration.ofHours(4);
/** Class logger. */
@Nonnull private final Logger log = LoggerFactory.getLogger(CacheConfigParser.class);
diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/DataConnectorFactoryBean.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/DataConnectorFactoryBean.java
index 9d1795f38..080d65a28 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/DataConnectorFactoryBean.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/DataConnectorFactoryBean.java
@@ -201,6 +201,7 @@ public class DataConnectorFactoryBean extends AbstractResolverPluginFactoryBean<
}
/** {@inheritDoc} */
+ @SuppressWarnings("removal")
@Override protected void setValues(final AbstractDataConnector what) {
super.setValues(what);
if (null != getFailoverDataConnectorId()) {
diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/ldap/impl/LDAPDataConnectorParser.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/ldap/impl/LDAPDataConnectorParser.java
index 20047f6bb..dcc8fe5b9 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/ldap/impl/LDAPDataConnectorParser.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/ldap/impl/LDAPDataConnectorParser.java
@@ -878,6 +878,14 @@ public class LDAPDataConnectorParser extends AbstractDataConnectorParser {
return validator;
}
+ /**
+ * Factory method for overriding hostname verifier.
+ *
+ * @param disableHostnameVerification whether to install a null verifier
+ * @param logPrefix log prefix
+ *
+ * @return custom verifier or null
+ */
@Nullable public static CertificateHostnameVerifier buildHostnameVerifier(
@Nullable final String disableHostnameVerification, @Nullable final String logPrefix) {
if (disableHostnameVerification != null && Boolean.valueOf(disableHostnameVerification)) {
diff --git a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/AuthenticationFlowDescriptor.java b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/AuthenticationFlowDescriptor.java
index cd362bef2..5950c300e 100644
--- a/idp-authn-api/src/main/java/net/shibboleth/idp/authn/AuthenticationFlowDescriptor.java
+++ b/idp-authn-api/src/main/java/net/shibboleth/idp/authn/AuthenticationFlowDescriptor.java
@@ -307,7 +307,8 @@ public class AuthenticationFlowDescriptor extends AbstractIdentifiableInitializa
/**
* Set condition controlling whether results from this flow should be reused for SSO.
*
- * <p>Defaults to {@link ProxyCountPredicate}.</p>
+ * <p>Defaults to a built-in condition that applies SP-imposed proxying rules on hop count
+ * when the flow is configured to enforce this.</p>
*
* @param condition condition to set
*
diff --git a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/impl/InitializeRequestedPrincipalContext.java b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/impl/InitializeRequestedPrincipalContext.java
index 9ddaedb42..8bcd3ef69 100644
--- a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/impl/InitializeRequestedPrincipalContext.java
+++ b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/impl/InitializeRequestedPrincipalContext.java
@@ -46,7 +46,7 @@ import org.slf4j.LoggerFactory;
* with an {@link AuthenticationProfileConfiguration} containing one or more default authentication
* methods.
*
- * <p>If such a context already exists, it is left in place unless the {@link #replaceExistingContext} property
+ * <p>If such a context already exists, it is left in place unless {@link #setReplaceExistingContext(boolean)}
* is set.</p>
*
* @event {@link org.opensaml.profile.action.EventIds#PROCEED_EVENT_ID}
diff --git a/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/proxy/impl/HttpClientProxyValidator.java b/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/proxy/impl/HttpClientProxyValidator.java
index 68a7fe5bd..d38f50ce3 100644
--- a/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/proxy/impl/HttpClientProxyValidator.java
+++ b/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/proxy/impl/HttpClientProxyValidator.java
@@ -74,7 +74,8 @@ import org.slf4j.LoggerFactory;
* <ol>
* <li>Proxy callback URI specifies the <code>https</code> scheme.</li>
* <li>The TLS certificate presented by the remote peer is trusted.</li>
- * <li>The HTTP response status code is in the set of {@link #allowedResponseCodes} (only 200 by default).</li>
+ * <li>The HTTP response status code is approved via {@link #setAllowedResponseCodes(Set)}
+ * (only 200 by default).</li>
* </ol>
*
* @author Marvin S. Addison
@@ -99,8 +100,7 @@ public class HttpClientProxyValidator implements ProxyValidator {
@Nonnull private final HttpClientSecurityParameters securityParameters;
/** List of HTTP response codes permitted for successful proxy callback. */
- @NotEmpty @NonnullElements private Set<Integer> allowedResponseCodes = Collections.singleton(200);
-
+ @NotEmpty @NonnullElements private Set<Integer> allowedResponseCodes;
/**
*
@@ -113,6 +113,7 @@ public class HttpClientProxyValidator implements ProxyValidator {
@Nonnull final HttpClient client, @Nonnull final HttpClientSecurityParameters parameters) {
httpClient = Constraint.isNotNull(client, "HTTP client cannot be null");
securityParameters = Constraint.isNotNull(parameters, "HTTP client security parameters cannot be null");
+ allowedResponseCodes = Collections.singleton(200);
}
/**
@@ -123,7 +124,7 @@ public class HttpClientProxyValidator implements ProxyValidator {
public void setAllowedResponseCodes(@NotEmpty @NonnullElements final Set<Integer> responseCodes) {
Constraint.isNotEmpty(responseCodes, "Response codes cannot be null or empty.");
Constraint.noNullItems(responseCodes.toArray(), "Response codes cannot contain null elements.");
- allowedResponseCodes = responseCodes;
+ allowedResponseCodes = Set.copyOf(responseCodes);
}
/** {@inheritDoc} */
@@ -180,7 +181,7 @@ public class HttpClientProxyValidator implements ProxyValidator {
if (response != null && CloseableHttpResponse.class.isInstance(response)) {
try {
CloseableHttpResponse.class.cast(response).close();
- } catch (IOException e) {
+ } catch (final IOException e) {
log.debug("Error closing HttpResponse", e);
}
}
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/CopyDistribution.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/CopyDistribution.java
index 2b9810d3f..6074ac35f 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/CopyDistribution.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/CopyDistribution.java
@@ -108,7 +108,8 @@ public final class CopyDistribution extends AbstractInitializableComponent {
* @param overwrite whether we want to overwrite
* @throws BuildException if badness occurs
*/
- private void distCopy(final Path srcDist, final Path dist, final String to, final boolean overwrite) throws BuildException {
+ private void distCopy(final Path srcDist, final Path dist, final String to, final boolean overwrite)
+ throws BuildException {
final Path toPath = dist.resolve(to);
final Path fromPath = srcDist.resolve(to);
log.debug("Copying distribution from {} to {}", fromPath, toPath);
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/PluginInstallerArguments.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/PluginInstallerArguments.java
index 153a91c45..421604334 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/PluginInstallerArguments.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/PluginInstallerArguments.java
@@ -140,14 +140,16 @@ public class PluginInstallerArguments extends AbstractIdPHomeAwareCommandLineArg
}
/** Plugin Id (if specified).
- * @return {@link #pluginId}
+ *
+ * @return plugin ID
*/
@Nullable public String getPluginId() {
return pluginId;
}
/** get TrustStore (if specified).
- * @return {@link #truststore}
+ *
+ * @return the trust store
*/
@Nullable public String getTruststore() {
return truststore;
@@ -184,14 +186,16 @@ public class PluginInstallerArguments extends AbstractIdPHomeAwareCommandLineArg
}
/** Are we doing a full List?
- * @return {@link #fullList}
+ *
+ * @return whether we're doing a full list.
*/
public boolean isFullList() {
return fullList;
}
/** Are we doing a List?
- * @return {@link #list}
+ *
+ * @return whether we're doing a list
*/
public boolean isList() {
return list;
@@ -205,7 +209,8 @@ public class PluginInstallerArguments extends AbstractIdPHomeAwareCommandLineArg
}
/** Are we doing an unattended install?
- * @return {@link #list}
+ *
+ * @return whether we're doing an unattended install
*/
public boolean isUnattended() {
return noPrompt;
diff --git a/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/TrustStore.java b/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/TrustStore.java
index 5e92a6986..6d4c48a3b 100644
--- a/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/TrustStore.java
+++ b/idp-installer/src/main/java/net/shibboleth/idp/installer/plugin/impl/TrustStore.java
@@ -366,6 +366,13 @@ import net.shibboleth.utilities.java.support.component.ComponentSupport;
/** printable key. */
@Nonnull private String keyId;
+ /**
+ * Constructor.
+ *
+ * @param input input data
+ *
+ * @throws IOException if an error occurs
+ */
protected Signature(final @Nonnull InputStream input) throws IOException {
try (final InputStream sigStream = PGPUtil.getDecoderStream(input)) {
final JcaPGPObjectFactory factory = new JcaPGPObjectFactory(sigStream);
@@ -380,6 +387,11 @@ import net.shibboleth.utilities.java.support.component.ComponentSupport;
keyId = String.format("0X%X", signature.getKeyID());
}
+ /**
+ * Get signature.
+ *
+ * @return the signature
+ */
protected PGPSignature getSignature() {
return signature;
}
diff --git a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/AbstractProfileAction.java b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/AbstractProfileAction.java
index 2a44ec31c..813dc4cf5 100644
--- a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/AbstractProfileAction.java
+++ b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/AbstractProfileAction.java
@@ -78,8 +78,8 @@ public abstract class AbstractProfileAction
/**
* Constructor.
*
- * Initializes the ID of this action to the class name. Initializes {@link #profileContextLookupStrategy} to
- * {@link WebflowRequestContextProfileRequestContextLookup}.
+ * Initializes the ID of this action to the class name and calls {@link #setProfileContextLookupStrategy(Function)}
+ * with {@link WebflowRequestContextProfileRequestContextLookup}.
*/
public AbstractProfileAction() {
profileContextLookupStrategy = new WebflowRequestContextProfileRequestContextLookup();
diff --git a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/ScriptedAction.java b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/ScriptedAction.java
index 88e9f3971..704ca33a8 100644
--- a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/ScriptedAction.java
+++ b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/ScriptedAction.java
@@ -143,6 +143,7 @@ public class ScriptedAction extends AbstractProfileAction {
* @throws ScriptException if the compile fails
* @throws IOException if the file doesn't exist.
*/
+ @SuppressWarnings("removal")
static ScriptedAction resourceScript(@Nonnull @NotEmpty final String engineName, @Nonnull final Resource resource)
throws ScriptException, IOException {
try (final InputStream is = resource.getInputStream()) {
@@ -174,6 +175,7 @@ public class ScriptedAction extends AbstractProfileAction {
* @return the predicate
* @throws ScriptException if the compile fails
*/
+ @SuppressWarnings("removal")
static ScriptedAction inlineScript(@Nonnull @NotEmpty final String engineName,
@Nonnull @NotEmpty final String scriptSource) throws ScriptException {
final EvaluableScript script = new EvaluableScript();
diff --git a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/context/navigate/ScriptedContextLookupFunction.java b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/context/navigate/ScriptedContextLookupFunction.java
index 0dacfe909..ceaa05279 100644
--- a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/context/navigate/ScriptedContextLookupFunction.java
+++ b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/context/navigate/ScriptedContextLookupFunction.java
@@ -42,6 +42,7 @@ import org.springframework.core.io.Resource;
*
* @param <T> the specific type of context
*/
+ at SuppressWarnings("removal")
public class ScriptedContextLookupFunction<T extends BaseContext> extends AbstractScriptEvaluator
implements ContextDataLookupFunction<T,Object> {
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 0c238c1ab..f93463273 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
@@ -38,6 +38,7 @@ import org.springframework.core.io.Resource;
/**
* A {@link java.util.function.Predicate} which calls out to a supplied script.
*/
+ at SuppressWarnings("removal")
public class ScriptedPredicate
extends net.shibboleth.utilities.java.support.logic.ScriptedPredicate<ProfileRequestContext> {
diff --git a/idp-profile-impl/src/main/java/net/shibboleth/idp/profile/audit/impl/PopulateAuditContext.java b/idp-profile-impl/src/main/java/net/shibboleth/idp/profile/audit/impl/PopulateAuditContext.java
index 62f1fd946..aaf42908d 100644
--- a/idp-profile-impl/src/main/java/net/shibboleth/idp/profile/audit/impl/PopulateAuditContext.java
+++ b/idp-profile-impl/src/main/java/net/shibboleth/idp/profile/audit/impl/PopulateAuditContext.java
@@ -279,7 +279,7 @@ public class PopulateAuditContext extends AbstractProfileAction {
public static class FormattingMapParser {
/** Set of parsed fields. */
- @Nonnull @NonnullElements final Set<String> fields;
+ @Nonnull @NonnullElements private final Set<String> fields;
/**
* Constructor.
diff --git a/idp-profile-impl/src/main/java/net/shibboleth/idp/relyingparty/impl/DefaultRelyingPartyConfigurationResolver.java b/idp-profile-impl/src/main/java/net/shibboleth/idp/relyingparty/impl/DefaultRelyingPartyConfigurationResolver.java
index c812e1302..3f3a59bb7 100644
--- a/idp-profile-impl/src/main/java/net/shibboleth/idp/relyingparty/impl/DefaultRelyingPartyConfigurationResolver.java
+++ b/idp-profile-impl/src/main/java/net/shibboleth/idp/relyingparty/impl/DefaultRelyingPartyConfigurationResolver.java
@@ -132,7 +132,7 @@ public class DefaultRelyingPartyConfigurationResolver
/**
* Get the {@link RelyingPartyConfiguration} to use if the configuration is found to be "unverified"
- * (via the call to the {@link #verificationPredicate}.
+ * (via use of {@link #getVerificationPredicate()}).
*
* @return unverified configuration
*/
@@ -142,7 +142,7 @@ public class DefaultRelyingPartyConfigurationResolver
/**
* Set the {@link RelyingPartyConfiguration} to use if the configuration is found to be "unverified"
- * (via the call to the {@link #verificationPredicate}.
+ * (via use of {@link #getVerificationPredicate()}).
*
* @param configuration unverified configuration
*/
diff --git a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/metadata/filter/impl/SignatureValidationCriteriaSetFactoryBean.java b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/metadata/filter/impl/SignatureValidationCriteriaSetFactoryBean.java
index 4093278ab..b717305d8 100644
--- a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/metadata/filter/impl/SignatureValidationCriteriaSetFactoryBean.java
+++ b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/metadata/filter/impl/SignatureValidationCriteriaSetFactoryBean.java
@@ -45,9 +45,9 @@ import org.springframework.beans.factory.FactoryBean;
* <p>
* The supplied list of {@link SignatureValidationConfiguration} will be resolved into
* an instance of {@link SignatureValidationParameters} and returned in the criteria set.
- * If {@link #includeOpenSAMLGlobalConfig} is true, then the OpenSAML global configuration supplied
- * from {@link SecurityConfigurationSupport#getGlobalSignatureValidationConfiguration()} will
- * be effectively added at the lowest order of precedence.
+ * If {@link #setIncludeOpenSAMLGlobalConfig(boolean)} is set true (the default), then the OpenSAML global
+ * configuration supplied from {@link SecurityConfigurationSupport#getGlobalSignatureValidationConfiguration()}
+ * will be effectively added at the lowest order of precedence.
* Resolution will be performed using the supplied instance of {@link SignatureValidationParametersResolver},
* or if not supplied then an instance of {@link BasicSignatureValidationParametersResolver}.
* </p>
diff --git a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/security/trustengine/impl/AbstractStaticPKIXParser.java b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/security/trustengine/impl/AbstractStaticPKIXParser.java
index c6567fe5a..3eb58c87a 100644
--- a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/security/trustengine/impl/AbstractStaticPKIXParser.java
+++ b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/security/trustengine/impl/AbstractStaticPKIXParser.java
@@ -130,9 +130,9 @@ public abstract class AbstractStaticPKIXParser extends AbstractTrustEngineParser
private boolean trustedNameCheckEnabled = true;
/**
- * Setter for {@link #trustedNameCheckEnabled}.
+ * Set whether to perform the trusted name check.
*
- * @param enabled whether we emit a the {@link X509CredentialNameEvaluator} .
+ * @param enabled whether we emit a {@link X509CredentialNameEvaluator} .
*/
public void setTrustedNameCheckEnabled(final boolean enabled) {
trustedNameCheckEnabled = enabled;
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/config/AbstractMetadataDrivenConfigurationLookupStrategy.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/config/AbstractMetadataDrivenConfigurationLookupStrategy.java
index 0234ca6fa..39775461e 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/config/AbstractMetadataDrivenConfigurationLookupStrategy.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/config/AbstractMetadataDrivenConfigurationLookupStrategy.java
@@ -233,7 +233,7 @@ public abstract class AbstractMetadataDrivenConfigurationLookupStrategy<T> exten
profileIdLookupStrategy = Constraint.isNotNull(strategy, "Profile ID lookup strategy cannot be null");
}
-/** {@inheritDoc} */
+ /** {@inheritDoc} */
@Override
protected void doInitialize() throws ComponentInitializationException {
super.doInitialize();
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/logic/MappedEntityAttributesPredicate.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/logic/MappedEntityAttributesPredicate.java
index 0b2d2c0cd..3cae3d114 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/logic/MappedEntityAttributesPredicate.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/logic/MappedEntityAttributesPredicate.java
@@ -27,6 +27,7 @@ import javax.annotation.Nullable;
import org.opensaml.core.xml.XMLObject;
import org.opensaml.saml.common.profile.logic.EntityAttributesPredicate;
+import org.opensaml.saml.common.profile.logic.EntityAttributesPredicate.Candidate;
import org.opensaml.saml.saml2.metadata.EntitiesDescriptor;
import org.opensaml.saml.saml2.metadata.EntityDescriptor;
import org.slf4j.Logger;
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML1NameIdentifierAttributeDefinition.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML1NameIdentifierAttributeDefinition.java
index 82bfcfe3a..322815aa6 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML1NameIdentifierAttributeDefinition.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML1NameIdentifierAttributeDefinition.java
@@ -47,8 +47,8 @@ import org.slf4j.LoggerFactory;
* An attribute definition the creates attributes whose values are {@link NameIdentifier}.
*
* <p>When building the NameIdentifier the textual content of the NameIdentifier is the value of the source attribute.
- * If a {@link #nameIdQualifier} is provided that value is used as the NameIdentifier's NameQualifier otherwise the
- * attribute issuer's entity ID is used.</p>
+ * If {@link #getNameIdQualifier()} is non-null, then that value is used as the NameIdentifier's NameQualifier otherwise
+ * the attribute issuer's entityID is used.</p>
*
* @deprecated
*/
@@ -116,9 +116,9 @@ public class SAML1NameIdentifierAttributeDefinition extends AbstractAttributeDef
}
/**
- * Builds a name ID. The provided value is the textual content of the NameIdentifier. If a {@link #nameIdQualifier}
- * is not null it is used as the NameIdentifier's name qualifier, otherwise the attribute issuer's entity id is
- * used.
+ * Builds a name ID. The provided value is the textual content of the NameIdentifier. If
+ * {@link #getNameIdQualifier()} is not null it is used as the NameIdentifier's name qualifier,
+ * otherwise the attribute issuer's entityID is used.
*
* @param nameIdValue value of the NameIdentifier
* @param resolutionContext current resolution context
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML2NameIDAttributeDefinition.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML2NameIDAttributeDefinition.java
index 136197af4..650d29107 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML2NameIDAttributeDefinition.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/attribute/resolver/impl/SAML2NameIDAttributeDefinition.java
@@ -48,9 +48,9 @@ import org.slf4j.LoggerFactory;
* An attribute definition that creates attributes whose values are {@link NameID}.
*
* <p>When building the NameID the textual content of the NameID is the value of the source attribute. If a
- * {@link #nameIdQualifier} is provided that value is used as the NameID's NameQualifier otherwise the attribute
- * issuer's entity ID is used. If a {@link #nameIdSPQualifier} is provided then that valid is used as the NameID's
- * SPNameQualifier, otherwise the attribute recipient's entityID is used.</p>
+ * {@link #getNameIdQualifier()} is non-null, then that value is used as the NameID's NameQualifier otherwise
+ * the attribute issuer's entityID is used. If {@link #getNameIdSPQualifier()} is non-null, then that valid is
+ * used as the NameID's SPNameQualifier, otherwise the attribute recipient's entityID is used.</p>
*
* @deprecated
*/
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list