org.apache.hc.client5.http.auth

Class AuthScope

java.lang.Object

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

public class AuthScope
extends java.lang.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(HttpHost origin) Defines auth scope for a specific host of origin.
AuthScope(HttpHost origin, java.lang.String realm, java.lang.String schemeName) Defines auth scope for a specific host of origin.
AuthScope(java.lang.String host, int port) Defines auth scope with the given host and port.
AuthScope(java.lang.String protocol, java.lang.String host, int port, java.lang.String realm, java.lang.String schemeName) Defines auth scope with the given protocol, host, port, realm, and schemeName.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getHost()
int	getPort()
java.lang.String	getProtocol()
java.lang.String	getRealm()
java.lang.String	getSchemeName()
int	hashCode()
int	match(AuthScope that) Tests if the authentication scopes match.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthScope

public AuthScope(java.lang.String protocol,
                 java.lang.String host,
                 int port,
                 java.lang.String realm,
                 java.lang.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.

AuthScope

public AuthScope(HttpHost origin,
                 java.lang.String realm,
                 java.lang.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(HttpHost origin)

Defines auth scope for a specific host of origin.

Parameters:

origin - host of origin

Since:

4.2

AuthScope

public AuthScope(java.lang.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.

Method Detail

getProtocol

public java.lang.String getProtocol()

getHost

public java.lang.String getHost()

getPort

public int getPort()

getRealm

public java.lang.String getRealm()

getSchemeName

public java.lang.String getSchemeName()

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.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object