[java-opensaml COMMIT] /trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataR...

[noreply at shibboleth.net]

Author: putmanb
Date: Wed Mar 26 20:28:06 2014
New Revision: 3737

URL: http://svn.shibboleth.net/view/java-opensaml?rev=3737&view=rev
Log:
Make setting of Basic auth username/password more Spring-friendly.

Modified:
    trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java

Modified: trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
URL: http://svn.shibboleth.net/view/java-opensaml/trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java?rev=3737&r1=3736&r2=3737&view=diff
==============================================================================
--- trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java (original)
+++ trunk/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java Wed Mar 26 20:28:06 2014
@@ -23,6 +23,9 @@
 import java.net.URISyntaxException;
 import java.util.Timer;
 
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
 import net.shibboleth.utilities.java.support.component.ComponentSupport;
 import net.shibboleth.utilities.java.support.resolver.ResolverException;
 
@@ -119,29 +122,43 @@
     public String getMetadataURI() {
         return metadataURI.toASCIIString();
     }
-
-    /**
-     * Sets the username and password used to access the metadata URL. To disable BASIC authentication set the username
-     * and password to null. If the <code>authScope</code> is null, one will be generated based off of 
+    
+    /**
+     * Sets the username and password used to access the metadata URL. To disable BASIC authentication pass 
+     * null for the credentials instance.
+     * 
+     * An {@link AuthScope} will be generated based off of the metadata URI's hostname and port.
+     * 
+     * @param credentials the username and password credentials to user
+     */
+    public void setBasicCredentials(@Nullable final UsernamePasswordCredentials credentials) {
+        setBasicCredentials(credentials, null);
+    }
+    
+    /**
+     * Sets the username and password used to access the metadata URL. To disable BASIC authentication pass 
+     * null for the credentials instance.
+     * 
+     * <p>
+     * If the <code>authScope</code> is null, an {@link AuthScope} will be generated based off of 
      * the metadata URI's hostname and port.
-     * 
-     * @param username the username
-     * @param password the password
+     * </p>
+     * 
+     * @param
      * @param scope the HTTP client auth scope with which to scope the credentials, may be null
      */
-    public void setBasicCredentials(String username, String password, AuthScope scope) {
+    public void setBasicCredentials(@Nullable final UsernamePasswordCredentials credentials, 
+            @Nullable final AuthScope scope) {
         ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
         ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
 
-        if (username != null && password != null) {
-            UsernamePasswordCredentials usernamePasswordCredentials = 
-                    new UsernamePasswordCredentials(username, password);
+        if (credentials != null) {
             AuthScope authScope = scope;
             if (authScope == null) {
                 authScope = new AuthScope(metadataURI.getHost(), metadataURI.getPort());
             }
             BasicCredentialsProvider provider = new BasicCredentialsProvider();
-            provider.setCredentials(authScope, usernamePasswordCredentials);
+            provider.setCredentials(authScope, credentials);
             credentialsProvider = provider;
         } else {
             log.debug("Either username or password were null, disabling basic auth");