Apache HttpClient 4.5.14 · org.apache.http.auth.AuthScope

Modifier and Type	Field and Description
public static final AuthScope	ANY Default scope matching any host, port, realm and authentication scheme.
public static final String	ANY_HOST The `null` value represents any host.
public static final int	ANY_PORT The `-1` value represents any port.
public static final String	ANY_REALM The `null` value represents any realm.
public static final String	ANY_SCHEME The `null` value represents any authentication scheme.
private final String	host The host the credentials apply to.
private final HttpHost	origin The original host, if known
private final int	port The port the credentials apply to.
private final String	realm The realm the credentials apply to.
private final String	scheme The authentication scheme the credentials apply to.

Constructor Summary

Access	Constructor and Description
public	AuthScope(final String authentication host. May be `ANY_HOST` if applies to any host. host, final int authentication port. May be `ANY_PORT` if applies to any port of the host. port, final String authentication realm. May be `ANY_REALM` if applies to any realm on the host. realm, final String authentication scheme. May be `ANY_SCHEME` if applies to any scheme supported by the host. schemeName) Defines auth scope with the given `host`, `port`, `realm`, and `schemeName`.
public	AuthScope(final HttpHost host of origin origin, final String authentication realm. May be `ANY_REALM` if applies to any realm on the host. realm, final String authentication scheme. May be `ANY_SCHEME` if applies to any scheme supported by the host. schemeName) Defines auth scope for a specific host of origin.
public	AuthScope(final HttpHost host of origin origin) Defines auth scope for a specific host of origin.
public	AuthScope(final String authentication host. May be `ANY_HOST` if applies to any host. host, final int authentication port. May be `ANY_PORT` if applies to any port of the host. port, final String authentication realm. May be `ANY_REALM` if applies to any realm on the host. realm) Defines auth scope with the given `host`, `port` and `realm`.
public	AuthScope(final String authentication host. May be `ANY_HOST` if applies to any host. host, final int authentication port. May be `ANY_PORT` if applies to any port of the host. port) Defines auth scope with the given `host` and `port`.
public	AuthScope(final AuthScope authscope) Creates a copy of the given credentials scope.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the host getHost()
public HttpHost	Returns: host of origin. If unknown returns @null, getOrigin()
public int	Returns: the port getPort()
public String	Returns: the realm name getRealm()
public String	Returns: the scheme type getScheme()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public int	Returns: the match factor. Negative value signifies no match. Non-negative signifies a match. The greater the returned value the closer the match. match(final AuthScope that) Tests if the authentication scopes match.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

ANY	back to summary
public static final AuthScope ANY Default scope matching any host, port, realm and authentication scheme. In the future versions of HttpClient the use of this parameter will be discontinued.

ANY_HOST	back to summary
public static final String ANY_HOST The `null` value represents any host. In the future versions of HttpClient the use of this parameter will be discontinued.

ANY_PORT	back to summary
public static final int ANY_PORT The `-1` value represents any port.

ANY_REALM	back to summary
public static final String ANY_REALM The `null` value represents any realm.

ANY_SCHEME	back to summary
public static final String ANY_SCHEME The `null` value represents any authentication scheme.

host	back to summary
private final String host The host the credentials apply to.

origin	back to summary
private final HttpHost origin The original host, if known

port	back to summary
private final int port The port the credentials apply to.

realm	back to summary
private final String realm The realm the credentials apply to.

scheme	back to summary
private final String scheme The authentication scheme the credentials apply to.

Constructor Detail

AuthScope back to summary

AuthScope	back to summary
public AuthScope(final String host, final int port, final String realm, final String schemeName) Defines auth scope with the given `host`, `port`, `realm`, and `schemeName`. Parameters host:String authentication host. May be `ANY_HOST` if applies to any host. port:int authentication port. May be `ANY_PORT` if applies to any port of the host. realm:String authentication realm. May be `ANY_REALM` if applies to any realm on the host. schemeName:String authentication scheme. May be `ANY_SCHEME` if applies to any scheme supported by the host.

public AuthScope(final String host, final int port, final String realm, final String schemeName)

Defines auth scope with the given host, port, realm, and schemeName.

Parameters

host:String: authentication host. May be ANY_HOST if applies to any host.
port:int: authentication port. May be ANY_PORT if applies to any port of the host.
realm:String: authentication realm. May be ANY_REALM if applies to any realm on the host.
schemeName:String: authentication scheme. May be ANY_SCHEME if applies to any scheme supported by the host.

AuthScope back to summary

AuthScope	back to summary
public AuthScope(final HttpHost origin, final String realm, final String schemeName) Defines auth scope for a specific host of origin. Parameters origin:HttpHost host of origin realm:String authentication realm. May be `ANY_REALM` if applies to any realm on the host. schemeName:String authentication scheme. May be `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)

Defines auth scope for a specific host of origin.

Parameters

origin:HttpHost: host of origin
realm:String: authentication realm. May be ANY_REALM if applies to any realm on the host.
schemeName:String: authentication scheme. May be ANY_SCHEME if applies to any scheme supported by the host.

Since

4.2

AuthScope	back to summary
public AuthScope(final HttpHost origin) Defines auth scope for a specific host of origin. Parameters origin:HttpHost host of origin Since 4.2

AuthScope

back to summary

public AuthScope(final HttpHost origin)

Defines auth scope for a specific host of origin.

Parameters

origin:HttpHost: host of origin

Since

4.2

AuthScope back to summary

AuthScope	back to summary
public AuthScope(final String host, final int port, final String realm) Defines auth scope with the given `host`, `port` and `realm`. Parameters host:String authentication host. May be `ANY_HOST` if applies to any host. port:int authentication port. May be `ANY_PORT` if applies to any port of the host. realm:String authentication realm. May be `ANY_REALM` if applies to any realm on the host.

public AuthScope(final String host, final int port, final String realm)

Defines auth scope with the given host, port and realm.

Parameters

host:String: authentication host. May be ANY_HOST if applies to any host.
port:int: authentication port. May be ANY_PORT if applies to any port of the host.
realm:String: authentication realm. May be ANY_REALM if applies to any realm on the host.

AuthScope back to summary

AuthScope	back to summary
public AuthScope(final String host, final int port) Defines auth scope with the given `host` and `port`. Parameters host:String authentication host. May be `ANY_HOST` if applies to any host. port:int authentication port. May be `ANY_PORT` if applies to any port of the host.

public AuthScope(final String host, final int port)

Defines auth scope with the given host and port.

Parameters

host:String: authentication host. May be ANY_HOST if applies to any host.
port:int: authentication port. May be ANY_PORT if applies to any port of the host.

AuthScope	back to summary
public AuthScope(final AuthScope authscope) Creates a copy of the given credentials scope.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override See Also `java.lang.Object#equals(Object)`

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

See Also

java.lang.Object#equals(Object)

getHost	back to summary
public String getHost() Returns:String the host

getOrigin	back to summary
public HttpHost getOrigin() Returns:HttpHost host of origin. If unknown returns @null, Since 4.4

getPort	back to summary
public int getPort() Returns:int the port

getRealm	back to summary
public String getRealm() Returns:String the realm name

getScheme	back to summary
public String getScheme() Returns:String the scheme type

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override See Also `java.lang.Object#hashCode()`

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

See Also

java.lang.Object#hashCode()

match	back to summary
public int match(final AuthScope that) Tests if the authentication scopes match. Returns:int the match factor. Negative value signifies no match. Non-negative signifies a match. The greater the returned value the closer the match.

match

back to summary

public int match(final AuthScope that)

Tests if the authentication scopes match.

Returns:int: the match factor. Negative value signifies no match. Non-negative signifies a match. The greater the returned value the closer the match.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override See Also `java.lang.Object#toString()`

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

See Also

java.lang.Object#toString()

public Class AuthScope

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail