java.lang.Object | |
↳ | org.apache.http.auth.AuthScope |
The class represents an authentication scope consisting of a host name,
a port number, a realm name and an authentication scheme name which
Credentials
apply to.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
AuthScope | ANY | Default scope matching any host, port, realm and authentication scheme. | |||||||||
String | ANY_HOST | The null value represents any host. | |||||||||
int | ANY_PORT | The -1 value represents any port. | |||||||||
String | ANY_REALM | The null value represents any realm. | |||||||||
String | ANY_SCHEME | The null value represents any authentication scheme. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new credentials scope for the given
host, port, realm, and
authentication scheme.
| |||||||||||
Creates a new credentials scope for the given
host, port, realm, and any
authentication scheme.
| |||||||||||
Creates a new credentials scope for the given
host, port, any realm name, and any
authentication scheme.
| |||||||||||
Creates a copy of the given credentials scope.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Compares this instance with the specified object and indicates if they
are equal.
| |||||||||||
Returns an integer hash code for this object.
| |||||||||||
Tests if the authentication scopes match.
| |||||||||||
Returns a string containing a concise, human-readable description of this
object.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class java.lang.Object
|
Default scope matching any host, port, realm and authentication scheme. In the future versions of HttpClient the use of this parameter will be discontinued.
The null value represents any host. In the future versions of HttpClient the use of this parameter will be discontinued.
The -1 value represents any port.
The null value represents any authentication scheme.
Creates a new credentials scope for the given host, port, realm, and authentication scheme.
host | the host the credentials apply to. May be set to null if credenticals are applicable to any host. |
---|---|
port | the port the credentials apply to. May be set to negative value if credenticals are applicable to any port. |
realm | the realm the credentials apply to. May be set to null if credenticals are applicable to any realm. |
scheme | the authentication scheme the credentials apply to. May be set to null if credenticals are applicable to any authentication scheme. |
Creates a new credentials scope for the given host, port, realm, and any authentication scheme.
host | the host the credentials apply to. May be set to null if credenticals are applicable to any host. |
---|---|
port | the port the credentials apply to. May be set to negative value if credenticals are applicable to any port. |
realm | the realm the credentials apply to. May be set to null if credenticals are applicable to any realm. |
Creates a new credentials scope for the given host, port, any realm name, and any authentication scheme.
host | the host the credentials apply to. May be set to null if credenticals are applicable to any host. |
---|---|
port | the port the credentials apply to. May be set to negative value if credenticals are applicable to any port. |
Creates a copy of the given credentials scope.
Compares this instance with the specified object and indicates if they
are equal. In order to be equal, o
must represent the same object
as this instance using a class-specific comparison. The general contract
is that this comparison should be both transitive and reflexive.
The implementation in Object
returns true
only if o
is the exact same object as the receiver (using the == operator for
comparison). Subclasses often implement equals(Object)
so that
it takes into account the two object's types and states.
The general contract for the equals(Object)
and hashCode()
methods is that if equals
returns true
for
any two objects, then hashCode()
must return the same value for
these objects. This means that subclasses of Object
usually
override either both methods or none of them.
o | the object to compare this instance with. |
---|
true
if the specified object is equal to this Object
; false
otherwise.Returns an integer hash code for this object. By contract, any two
objects for which equals(Object)
returns true
must return
the same hash code value. This means that subclasses of Object
usually override both methods or neither method.
Tests if the authentication scopes match.
Returns a string containing a concise, human-readable description of this
object. Subclasses are encouraged to override this method and provide an
implementation that takes into account the object's type and data. The
default implementation simply concatenates the class name, the '@' sign
and a hexadecimal representation of the object's hashCode()
,
that is, it is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())