[java-opensaml] branch master updated: Fix some compilation and Javadoc warnings

Ian Young ian at iay.org.uk
Mon May 27 10:58:47 EDT 2019


This is an automated email from the git hooks/post-receive script.

iay pushed a commit to branch master
in repository java-opensaml.

View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=f31a74671c819c2db47cd00a4408b195f76fa18d

The following commit(s) were added to refs/heads/master by this push:
       new  f31a746   Fix some compilation and Javadoc warnings
f31a746 is described below

commit f31a74671c819c2db47cd00a4408b195f76fa18d
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Mon May 27 15:58:29 2019 +0100

    Fix some compilation and Javadoc warnings
---
 .../test/java/org/opensaml/profile/action/impl/MockMessage.java    | 2 +-
 .../saml/saml2/assertion/SAML2AssertionValidationParameters.java   | 4 ++--
 .../metadata/resolver/filter/impl/RequiredValidUntilFilter.java    | 4 ++--
 .../resolver/impl/AbstractDynamicHTTPMetadataResolver.java         | 7 +++++++
 .../opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java | 6 ++++++
 .../encryption/EncryptedElementTypeEncryptedKeyResolverTest.java   | 2 +-
 .../java/org/opensaml/xmlsec/encryption/support/Decrypter.java     | 2 +-
 .../opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java    | 1 +
 .../xmlsec/encryption/support/InlineEncryptedKeyResolverTest.java  | 2 +-
 .../impl/PopulateSignatureValidationParametersHandlerTest.java     | 2 +-
 10 files changed, 23 insertions(+), 9 deletions(-)

diff --git a/opensaml-profile-impl/src/test/java/org/opensaml/profile/action/impl/MockMessage.java b/opensaml-profile-impl/src/test/java/org/opensaml/profile/action/impl/MockMessage.java
index d969c23..cf62709 100644
--- a/opensaml-profile-impl/src/test/java/org/opensaml/profile/action/impl/MockMessage.java
+++ b/opensaml-profile-impl/src/test/java/org/opensaml/profile/action/impl/MockMessage.java
@@ -50,7 +50,7 @@ public class MockMessage {
 
     /**
      * Get the encoded form of the message properties, which will be in the form 
-     * "key1=value1&key2=value2&...&keyN=valueN", sorted ascending by key.
+     * "key1=value1&key2=value2&...&keyN=valueN", sorted ascending by key.
      * 
      * @return the encoded form of the message
      */
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML2AssertionValidationParameters.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML2AssertionValidationParameters.java
index a43e6f2..bcd3e97 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML2AssertionValidationParameters.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML2AssertionValidationParameters.java
@@ -36,7 +36,7 @@ public final class SAML2AssertionValidationParameters {
     public static final String STMT_INFIX = ".Statement";
     
     /**
-     * Carries a {@link java.lang.Duration} specifying a clock skew value.
+     * Carries a {@link java.time.Duration} specifying a clock skew value.
      */
     public static final String CLOCK_SKEW = STD_PREFIX + ".ClockSkew";
 
@@ -95,7 +95,7 @@ public final class SAML2AssertionValidationParameters {
     public static final String COND_VALID_AUDIENCES = STD_PREFIX + COND_INFIX + ".ValidAudiences";
 
     /**
-     * Carries a {@link java.lang.Duration} representing the per-invocation value for the Assertion 
+     * Carries a {@link java.time.Duration} representing the per-invocation value for the Assertion 
      * replay cache expiration.
      */
     public static final String COND_ONE_TIME_USE_EXPIRES = STD_PREFIX + COND_INFIX + ".OneTimeUseExpires";
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/RequiredValidUntilFilter.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/RequiredValidUntilFilter.java
index d038616..fd72b43 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/RequiredValidUntilFilter.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/RequiredValidUntilFilter.java
@@ -54,7 +54,7 @@ public class RequiredValidUntilFilter implements MetadataFilter {
 
     /**
      * Get the maximum interval between now and the <code>validUntil</code> date.
-     * A value <=0 indicates that there is no restriction.
+     * A value <=0 indicates that there is no restriction.
      * 
      * @return maximum interval between now and the <code>validUntil</code> date
      */
@@ -64,7 +64,7 @@ public class RequiredValidUntilFilter implements MetadataFilter {
     
     /**
      * Set the maximum interval between now and the <code>validUntil</code> date.
-     * A value <=0 indicates that there is no restriction.
+     * A value <=0 indicates that there is no restriction.
      * 
      * @param validity time between now and the <code>validUntil</code> date
      */
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
index ae3aeba..792735b 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
@@ -110,11 +110,13 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
     /** HttpClient credentials provider. 
      * @deprecated use {@link #httpClientSecurityParameters}.
      * */
+    @Deprecated
     @Nullable private CredentialsProvider credentialsProvider;
     
     /** Optional trust engine used in evaluating server TLS credentials.
      * @deprecated use {@link #httpClientSecurityParameters}.
      *  */
+    @Deprecated
     @Nullable private TrustEngine<? super X509Credential> tlsTrustEngine;
     
     /** Optional HttpClient security parameters.*/
@@ -157,6 +159,7 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
      * 
      * @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
      */
+    @Deprecated
     public void setTLSTrustEngine(@Nullable final TrustEngine<? super X509Credential> engine) {
         DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setTLSTrustEngine", 
                 null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
@@ -170,6 +173,7 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
      * 
      * @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
      */
+    @Deprecated
     public void setCredentialsProvider(@Nullable final CredentialsProvider provider) {
         ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
         ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
@@ -194,6 +198,7 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
      * 
      * @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
      */
+    @Deprecated
     public void setBasicCredentials(@Nullable final UsernamePasswordCredentials credentials) {
         DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setBasicCredentials", 
                 null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
@@ -217,6 +222,7 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
      * 
      * @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
      */
+    @Deprecated
     public void setBasicCredentialsWithScope(@Nullable final UsernamePasswordCredentials credentials,
             @Nullable final AuthScope scope) {
         ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
@@ -445,6 +451,7 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
      * 
      * @deprecated use {@link #buildHttpClientContext(HttpUriRequest)}
      */
+    @Deprecated
     protected HttpClientContext buildHttpClientContext() {
         //TODO when we remove this deprecated method, change called method to @Nonnull for request
         DeprecationSupport.warn(ObjectType.METHOD, getClass().getName() + ".buildHttpClientContext()", null, null);
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
index c8aecfd..bc430a4 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
@@ -86,11 +86,13 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
     /** HttpClient credentials provider. 
      * @deprecated use {@link #httpClientSecurityParameters}.
      * */
+    @Deprecated
     @Nullable private BasicCredentialsProvider credentialsProvider;
     
     /** Optional trust engine used in evaluating server TLS credentials. 
      * @deprecated use {@link #httpClientSecurityParameters}.
      * */
+    @Deprecated
     @Nullable private TrustEngine<? super X509Credential> tlsTrustEngine;
     
     /** Optional HttpClient security parameters.*/
@@ -154,6 +156,7 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
      * 
      * @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
      */
+    @Deprecated
     public void setTLSTrustEngine(@Nullable final TrustEngine<? super X509Credential> engine) {
         DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setTLSTrustEngine", 
                 null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
@@ -170,6 +173,7 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
      * 
      * @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
      */
+    @Deprecated
     public void setBasicCredentials(@Nullable final UsernamePasswordCredentials credentials) {
         DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".setBasicCredentials", 
                 null, "setHttpClientSecurityParameters(HttpClientSecurityParameters)");
@@ -190,6 +194,7 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
      * 
      * @deprecated use {@link #setHttpClientSecurityParameters(HttpClientSecurityParameters)}
      */
+    @Deprecated
     public void setBasicCredentialsWithScope(@Nullable final UsernamePasswordCredentials credentials,
             @Nullable final AuthScope scope) {
         ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
@@ -374,6 +379,7 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
      * 
      * @deprecated use {@link #buildHttpClientContext(HttpUriRequest)}
      */
+    @Deprecated
     protected HttpClientContext buildHttpClientContext() {
         //TODO when we remove this deprecated method, change called method to @Nonnull for request
         DeprecationSupport.warn(ObjectType.METHOD, getClass().getName() + ".buildHttpClientContext()", null, null);
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/encryption/EncryptedElementTypeEncryptedKeyResolverTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/encryption/EncryptedElementTypeEncryptedKeyResolverTest.java
index 7e8cc62..2aa2aca 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/encryption/EncryptedElementTypeEncryptedKeyResolverTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/encryption/EncryptedElementTypeEncryptedKeyResolverTest.java
@@ -146,7 +146,7 @@ public class EncryptedElementTypeEncryptedKeyResolverTest extends XMLObjectBaseT
         Assert.assertTrue(resolved.get(3) == allKeys.get(3), "Unexpected EncryptedKey instance found");
     }
     
-    /** One recipient specified to resolver, one matching & and one recipient-less 
+    /** One recipient specified to resolver, one matching and one recipient-less 
      *  EncryptedKey in instance. */
     @Test
     public void  testMultiEKOneRecipientWithMatch() {
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java
index 8bc18d3..f505b9e 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java
@@ -28,7 +28,6 @@ import java.util.Set;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
-import javax.xml.XMLConstants;
 
 import net.shibboleth.utilities.java.support.logic.Constraint;
 import net.shibboleth.utilities.java.support.primitive.StringSupport;
@@ -981,6 +980,7 @@ public class Decrypter {
      * 
      * @deprecated
      */
+    @Deprecated
     protected ParserPool buildParserPool() {
         // Note: we don't really build this here anymore, so the method name is semantically misleading.
         // We should remove this method in next major release and just move this call to the ctor.
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java
index c0468be..2636748 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java
@@ -230,6 +230,7 @@ public class BasicEncryptionParametersResolver extends AbstractSecurityParameter
      * 
      * @deprecated use {@link #validate(EncryptionParameters, boolean)}.
      */
+    @Deprecated
     protected boolean validate(@Nonnull final EncryptionParameters params) {
         DeprecationSupport.warnOnce(ObjectType.METHOD, getClass().getName() + ".validate(EncryptionParameters)", 
                 null, "validate(EncryptionParameters, boolean)");
diff --git a/opensaml-xmlsec-impl/src/test/java/org/opensaml/xmlsec/encryption/support/InlineEncryptedKeyResolverTest.java b/opensaml-xmlsec-impl/src/test/java/org/opensaml/xmlsec/encryption/support/InlineEncryptedKeyResolverTest.java
index 2d5352b..613692d 100644
--- a/opensaml-xmlsec-impl/src/test/java/org/opensaml/xmlsec/encryption/support/InlineEncryptedKeyResolverTest.java
+++ b/opensaml-xmlsec-impl/src/test/java/org/opensaml/xmlsec/encryption/support/InlineEncryptedKeyResolverTest.java
@@ -117,7 +117,7 @@ public class InlineEncryptedKeyResolverTest extends XMLObjectBaseTestCase {
         Assert.assertTrue(resolved.get(3) == allKeys.get(3), "Unexpected EncryptedKey instance found");
     }
     
-    /** One recipient specified to resolver, one matching & and one recipient-less 
+    /** One recipient specified to resolver, one matching and one recipient-less 
      *  inline EncryptedKey in instance. */
     @Test
     public void  testMultiEKOneRecipientWithMatch() {
diff --git a/opensaml-xmlsec-impl/src/test/java/org/opensaml/xmlsec/messaging/impl/PopulateSignatureValidationParametersHandlerTest.java b/opensaml-xmlsec-impl/src/test/java/org/opensaml/xmlsec/messaging/impl/PopulateSignatureValidationParametersHandlerTest.java
index 212e937..2b6f5d4 100644
--- a/opensaml-xmlsec-impl/src/test/java/org/opensaml/xmlsec/messaging/impl/PopulateSignatureValidationParametersHandlerTest.java
+++ b/opensaml-xmlsec-impl/src/test/java/org/opensaml/xmlsec/messaging/impl/PopulateSignatureValidationParametersHandlerTest.java
@@ -36,7 +36,7 @@ import net.shibboleth.utilities.java.support.logic.ConstraintViolationException;
 import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
 import net.shibboleth.utilities.java.support.resolver.ResolverException;
 
-/** Unit test for {@link PopulateSignatureValidationParameters}. */
+/** Unit test for {@link PopulateSignatureValidationParametersHandler}. */
 public class PopulateSignatureValidationParametersHandlerTest extends OpenSAMLInitBaseTestCase {
 
     private MessageContext messageContext;

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list