org.apache.hc.client5.http.auth

Class AuthScope

java.lang.Object

org.apache.hc.client5.http.auth.AuthScope

@Contract(threading=IMMUTABLE)
public class AuthScope
extends Object

AuthScope represents an authentication scope consisting of an application protocol, a host name, a port number, a realm name and an authentication scheme name.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
AuthScope(AuthScope authScope) Creates a copy of the given credentials scope.
AuthScope(HttpHost origin) Defines auth scope for a specific host of origin.
AuthScope(HttpHost origin, String realm, String schemeName) Defines auth scope for a specific host of origin.
AuthScope(String host, int port) Defines auth scope with the given host and port.
AuthScope(String protocol, String host, int port, String realm, String schemeName) Defines auth scope with the given protocol, host, port, realm, and schemeName.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
String	getHost()
int	getPort()
String	getProtocol()
String	getRealm()
String	getSchemeName()
int	hashCode() Returns a hash code value for the object.
int	match(AuthScope that) Tests if the authentication scopes match.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthScope

public AuthScope(AuthScope authScope)

Creates a copy of the given credentials scope.

AuthScope

public AuthScope(HttpHost origin)

Defines auth scope for a specific host of origin.

Parameters:

origin - host of origin

Since:

4.2

AuthScope

public AuthScope(HttpHost origin,
                 String realm,
                 String schemeName)

Defines auth scope for a specific host of origin.

Parameters:

origin - host of origin

realm - authentication realm. May be null if applies to any realm on the host.

schemeName - authentication scheme name. May be null if applies to any auth scheme supported by the host.

Since:

4.2

AuthScope

public AuthScope(String host,
                 int port)

Defines auth scope with the given host and port.

Parameters:

host - authentication host. May be null if applies to any host.

port - authentication port. May be -1 if applies to any port of the host.

AuthScope

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

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

Parameters:

protocol - application protocol. May be null if applies to any protocol.

host - authentication host. May be null if applies to any host.

port - authentication port. May be -1 if applies to any port of the host.

realm - authentication realm. May be null if applies to any realm on the host.

schemeName - authentication scheme name. May be null if applies to any auth scheme supported by the host.

Method Detail

equals

public boolean equals(Object obj)

Description copied from class: Object

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

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

See Also:

Object.hashCode(), HashMap

getHost

public String getHost()

getPort

public int getPort()

getProtocol

public String getProtocol()

getRealm

public String getRealm()

getSchemeName

public String getSchemeName()

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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 Object.equals(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

match

public int match(AuthScope that)

Tests if the authentication scopes match.

Returns:

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

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.