From 47e6f4590b1d50b474bf2df482745f417dcf2ad3 Mon Sep 17 00:00:00 2001 From: Oleg Kalnichevski Date: Thu, 13 Feb 2014 13:58:23 +0000 Subject: [PATCH] Updated AuthScope javadocs; added origin attribute git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1567925 13f79535-47bb-0310-9956-ffa450edef68 --- .../java/org/apache/http/auth/AuthScope.java | 144 +++++++++++------- 1 file changed, 85 insertions(+), 59 deletions(-) diff --git a/httpclient/src/main/java/org/apache/http/auth/AuthScope.java b/httpclient/src/main/java/org/apache/http/auth/AuthScope.java index a9e864d8e..a26705ddb 100644 --- a/httpclient/src/main/java/org/apache/http/auth/AuthScope.java +++ b/httpclient/src/main/java/org/apache/http/auth/AuthScope.java @@ -34,10 +34,11 @@ import org.apache.http.util.Args; import org.apache.http.util.LangUtils; /** - * The class represents an authentication scope consisting of a host name, - * a port number, a realm name and an authentication scheme name which - * {@link Credentials Credentials} apply to. - * + * AuthScope represents an authentication scope consisting of a host name, + * a port number, a realm name and an authentication scheme name. + *

+ * This class can also optionally contain a host of origin, if created in response + * to authentication challenge from a specific host. * * @since 4.0 */ @@ -84,74 +85,89 @@ public class AuthScope { /** The port the credentials apply to. */ private final int port; - /** Creates a new credentials scope for the given - * host, port, realm, and + /** The original host, if known */ + private final HttpHost origin; + + /** + * Defines auth scope with the given host, port, realm, and * authentication scheme. * - * @param host the host the credentials apply to. May be set - * to null if credentials are applicable to - * any host. - * @param port the port the credentials apply to. May be set - * to negative value if credentials are applicable to - * any port. - * @param realm the realm the credentials apply to. May be set - * to null if credentials are applicable to - * any realm. - * @param scheme the authentication scheme the credentials apply to. - * May be set to null if credentials are applicable to - * any authentication scheme. + * @param host authentication host. May be {@link #ANY_HOST} if applies + * to any host. + * @param port authentication port. May be {@link #ANY_PORT} if applies + * to any port of the host. + * @param realm authentication realm. May be {@link #ANY_REALM} if applies + * to any realm on the host. + * @param scheme authentication scheme. May be {@link #ANY_SCHEME} if applies + * to any scheme supported by the host. */ - public AuthScope(final String host, final int port, - final String realm, final String scheme) - { - this.host = (host == null) ? ANY_HOST: host.toLowerCase(Locale.ROOT); - this.port = (port < 0) ? ANY_PORT: port; - this.realm = (realm == null) ? ANY_REALM: realm; - this.scheme = (scheme == null) ? ANY_SCHEME: scheme.toUpperCase(Locale.ROOT); + public AuthScope( + final String host, + final int port, + final String realm, + final String schemeName) { + this.host = host == null ? ANY_HOST: host.toLowerCase(Locale.ROOT); + this.port = port < 0 ? ANY_PORT : port; + this.realm = realm == null ? ANY_REALM : realm; + this.scheme = schemeName == null ? ANY_SCHEME : schemeName.toUpperCase(Locale.ROOT); + this.origin = null; } /** - * @since 4.2 - */ - public AuthScope(final HttpHost host, final String realm, final String schemeName) { - this(host.getHostName(), host.getPort(), realm, schemeName); - } - - /** - * @since 4.2 - */ - public AuthScope(final HttpHost host) { - this(host, ANY_REALM, ANY_SCHEME); - } - - /** Creates a new credentials scope for the given - * host, port, realm, and any - * authentication scheme. + * Defines auth scope for a specific host of origin. * - * @param host the host the credentials apply to. May be set - * to null if credentials are applicable to - * any host. - * @param port the port the credentials apply to. May be set - * to negative value if credentials are applicable to - * any port. - * @param realm the realm the credentials apply to. May be set - * to null if credentials are applicable to - * any realm. + * @param origin host of origin + * @param realm authentication realm. May be {@link #ANY_REALM} if applies + * to any realm on the host. + * @param scheme authentication scheme. May be {@link #ANY_SCHEME} if applies + * to any scheme supported by the host. + * + * @since 4.2 + */ + public AuthScope( + final HttpHost origin, + final String realm, + final String schemeName) { + Args.notNull(origin, "Host"); + this.host = origin.getHostName(); + this.port = origin.getPort() < 0 ? ANY_PORT : origin.getPort(); + this.realm = realm == null ? ANY_REALM : realm; + this.scheme = schemeName == null ? ANY_SCHEME : schemeName.toUpperCase(Locale.ROOT); + this.origin = origin; + } + + /** + * Defines auth scope for a specific host of origin. + * + * @param origin host of origin + * + * @since 4.2 + */ + public AuthScope(final HttpHost origin) { + this(origin, ANY_REALM, ANY_SCHEME); + } + + /** + * Defines auth scope with the given host, port and realm. + * + * @param host authentication host. May be {@link #ANY_HOST} if applies + * to any host. + * @param port authentication port. May be {@link #ANY_PORT} if applies + * to any port of the host. + * @param realm authentication realm. May be {@link #ANY_REALM} if applies + * to any realm on the host. */ public AuthScope(final String host, final int port, final String realm) { this(host, port, realm, ANY_SCHEME); } - /** Creates a new credentials scope for the given - * host, port, any realm name, and any - * authentication scheme. + /** + * Defines auth scope with the given host and port. * - * @param host the host the credentials apply to. May be set - * to null if credentials are applicable to - * any host. - * @param port the port the credentials apply to. May be set - * to negative value if credentials are applicable to - * any port. + * @param host authentication host. May be {@link #ANY_HOST} if applies + * to any host. + * @param port authentication port. May be {@link #ANY_PORT} if applies + * to any port of the host. */ public AuthScope(final String host, final int port) { this(host, port, ANY_REALM, ANY_SCHEME); @@ -167,6 +183,16 @@ public class AuthScope { this.port = authscope.getPort(); this.realm = authscope.getRealm(); this.scheme = authscope.getScheme(); + this.origin = authscope.getOrigin(); + } + + /** + * @return host of origin. If unknown returns @null, + * + * @since 4.4 + */ + public HttpHost getOrigin() { + return this.origin; } /**