Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.HttpHost

Modifier and Type	Field and Description
private final InetAddress	address
public static final URIScheme	DEFAULT_SCHEME The default scheme is "http".
private final Host	host
private final String	schemeName
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	HttpHost(final String the name of the scheme. `null` indicates the `default scheme` scheme, final InetAddress the inet address. Can be `null` address, final String the hostname (IP or DNS name) hostname, final int the port number. `-1` indicates the scheme default port. port) Creates a new `HttpHost`, specifying all values.
public	HttpHost(final String the name of the scheme. `null` indicates the `default scheme` scheme, final String the hostname (IP or DNS name) hostname, final int the port number. `-1` indicates the scheme default port. port) Creates `HttpHost` instance with the given scheme, hostname and port.
public	HttpHost(final String the hostname (IP or DNS name) hostname, final int the port number. `-1` indicates the scheme default port. port) Creates `HttpHost` instance with the default scheme and the given hostname and port.
public	HttpHost(final String the name of the scheme. `null` indicates the `default scheme` scheme, final String the hostname (IP or DNS name) hostname) Creates `HttpHost` instance with the given hostname and scheme and the default port for that scheme.
public	HttpHost(final String the hostname (IP or DNS name) hostname) Creates `HttpHost` instance with the default scheme and port and the given hostname.
public	HttpHost(final String the name of the scheme. `null` indicates the `default scheme` scheme, final InetAddress the inet address. address, final int the port number. `-1` indicates the scheme default port. port) Creates `HttpHost` instance with the given scheme, inet address and port.
public	HttpHost(final InetAddress the inet address. address, final int the port number. `-1` indicates the scheme default port. port) Creates `HttpHost` instance with the default scheme and the given inet address and port.
public	HttpHost(final InetAddress the inet address. address) Creates `HttpHost` instance with the default scheme and port and the given inet address.
public	HttpHost(final String scheme, final NamedEndpoint namedEndpoint)
public	HttpHost(final URIAuthority authority) Deprecated Use `HttpHost#HttpHost(String, NamedEndpoint)`

Method Summary

Modifier and Type	Method and Description
public static HttpHost	create(final String s) Creates `HttpHost` instance from a string.
public static HttpHost	Returns: a new HttpHost create(final URI scheme, host, and port. uri) Creates an `HttpHost` instance from the scheme, host, and port from the given URI.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public InetAddress	Returns: the inet address getAddress() Returns the inet address if explicitly set by a constructor, `null` otherwise.
public String	Returns: the host name (IP or DNS name) getHostName() Implements org.apache.hc.core5.net.NamedEndpoint.getHostName. Returns the host name.
public int	Returns: the host port, or `-1` if not set getPort() Implements org.apache.hc.core5.net.NamedEndpoint.getPort. Returns the port.
public String	Returns: the scheme name getSchemeName() Returns the scheme name.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public String	Returns: the host string, for example `localhost:8080` toHostString() Obtains the host string, without scheme prefix.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	Returns: the host URI toURI() Return the host URI, as a string.

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

Field Detail

address	back to summary
private final InetAddress address

DEFAULT_SCHEME	back to summary
public static final URIScheme DEFAULT_SCHEME The default scheme is "http".

host	back to summary
private final Host host

schemeName	back to summary
private final String schemeName

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final String scheme, final InetAddress address, final String hostname, final int port) Creates a new `HttpHost`, specifying all values. Constructor for HttpHost. Parameters scheme:String the name of the scheme. `null` indicates the `default scheme` address:InetAddress the inet address. Can be `null` hostname:String the hostname (IP or DNS name) port:int the port number. `-1` indicates the scheme default port. Exceptions IllegalArgumentException: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. `-1` indicates the scheme default port. Since 5.0

public HttpHost(final String scheme, final InetAddress address, final String hostname, final int port)

Creates a new HttpHost, specifying all values. Constructor for HttpHost.

Parameters

scheme:String: the name of the scheme. null indicates the default scheme
address:InetAddress: the inet address. Can be null
hostname:String: the hostname (IP or DNS name)
port:int: the port number. -1 indicates the scheme default port.

Exceptions

IllegalArgumentException:: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

Since

5.0

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final String scheme, final String hostname, final int port) Creates `HttpHost` instance with the given scheme, hostname and port. Parameters scheme:String the name of the scheme. `null` indicates the `default scheme` hostname:String the hostname (IP or DNS name) port:int the port number. `-1` indicates the scheme default port. Exceptions IllegalArgumentException: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. `-1` indicates the scheme default port.

public HttpHost(final String scheme, final String hostname, final int port)

Creates HttpHost instance with the given scheme, hostname and port.

Parameters

scheme:String: the name of the scheme. null indicates the default scheme
hostname:String: the hostname (IP or DNS name)
port:int: the port number. -1 indicates the scheme default port.

Exceptions

IllegalArgumentException:: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final String hostname, final int port) Creates `HttpHost` instance with the default scheme and the given hostname and port. Parameters hostname:String the hostname (IP or DNS name) port:int the port number. `-1` indicates the scheme default port. Exceptions IllegalArgumentException: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. `-1` indicates the scheme default port.

public HttpHost(final String hostname, final int port)

Creates HttpHost instance with the default scheme and the given hostname and port.

Parameters

hostname:String: the hostname (IP or DNS name)
port:int: the port number. -1 indicates the scheme default port.

Exceptions

IllegalArgumentException:: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final String scheme, final String hostname) Creates `HttpHost` instance with the given hostname and scheme and the default port for that scheme. Parameters scheme:String the name of the scheme. `null` indicates the `default scheme` hostname:String the hostname (IP or DNS name) Exceptions IllegalArgumentException: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. `-1` indicates the scheme default port.

public HttpHost(final String scheme, final String hostname)

Creates HttpHost instance with the given hostname and scheme and the default port for that scheme.

Parameters

scheme:String: the name of the scheme. null indicates the default scheme
hostname:String: the hostname (IP or DNS name)

Exceptions

IllegalArgumentException:: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final String hostname) Creates `HttpHost` instance with the default scheme and port and the given hostname. Parameters hostname:String the hostname (IP or DNS name) Exceptions IllegalArgumentException: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. `-1` indicates the scheme default port.

public HttpHost(final String hostname)

Creates HttpHost instance with the default scheme and port and the given hostname.

Parameters

hostname:String: the hostname (IP or DNS name)

Exceptions

IllegalArgumentException:: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final String scheme, final InetAddress address, final int port) Creates `HttpHost` instance with the given scheme, inet address and port. Parameters scheme:String the name of the scheme. `null` indicates the `default scheme` address:InetAddress the inet address. port:int the port number. `-1` indicates the scheme default port. Exceptions IllegalArgumentException: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. `-1` indicates the scheme default port. Since 5.0

public HttpHost(final String scheme, final InetAddress address, final int port)

Creates HttpHost instance with the given scheme, inet address and port.

Parameters

scheme:String: the name of the scheme. null indicates the default scheme
address:InetAddress: the inet address.
port:int: the port number. -1 indicates the scheme default port.

Exceptions

IllegalArgumentException:: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

Since

5.0

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final InetAddress address, final int port) Creates `HttpHost` instance with the default scheme and the given inet address and port. Parameters address:InetAddress the inet address. port:int the port number. `-1` indicates the scheme default port. Exceptions IllegalArgumentException: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. `-1` indicates the scheme default port. Since 4.3

public HttpHost(final InetAddress address, final int port)

Creates HttpHost instance with the default scheme and the given inet address and port.

Parameters

address:InetAddress: the inet address.
port:int: the port number. -1 indicates the scheme default port.

Exceptions

IllegalArgumentException:: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

Since

4.3

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final InetAddress address) Creates `HttpHost` instance with the default scheme and port and the given inet address. Parameters address:InetAddress the inet address. Exceptions IllegalArgumentException: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. `-1` indicates the scheme default port. Since 4.3

public HttpHost(final InetAddress address)

Creates HttpHost instance with the default scheme and port and the given inet address.

Parameters

address:InetAddress: the inet address.

Exceptions

IllegalArgumentException:: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. -1 indicates the scheme default port.

Since

4.3

HttpHost	back to summary
public HttpHost(final String scheme, final NamedEndpoint namedEndpoint) Exceptions IllegalArgumentException: If the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. `-1` indicates the scheme default port. Since 5.0

HttpHost	back to summary
public HttpHost(final URIAuthority authority) Deprecated Use `HttpHost#HttpHost(String, NamedEndpoint)` Annotations @Deprecated Since 5.0

Method Detail

create back to summary

create	back to summary
public static HttpHost create(final String s) throws URISyntaxException Creates `HttpHost` instance from a string. Text may not contain any blanks. Since 4.4

public static HttpHost create(final String s) throws URISyntaxException

Creates HttpHost instance from a string. Text may not contain any blanks.

Since: 4.4

create back to summary

create	back to summary
public static HttpHost create(final URI uri) Creates an `HttpHost` instance from the scheme, host, and port from the given URI. Other URI elements are ignored. Parameters uri:URI scheme, host, and port. Returns:HttpHost a new HttpHost Since 5.0

public static HttpHost create(final URI uri)

Creates an HttpHost instance from the scheme, host, and port from the given URI. Other URI elements are ignored.

Parameters

uri:URI: scheme, host, and port.

Returns:HttpHost

a new HttpHost

Since

5.0

equals back to summary

equals	back to summary
public boolean equals(final Object obj) 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 obj: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

public boolean equals(final Object obj)

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

obj: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

getAddress back to summary

getAddress	back to summary
public InetAddress getAddress() Returns the inet address if explicitly set by a constructor, `null` otherwise. Returns:InetAddress the inet address Since 4.3

public InetAddress getAddress()

Returns the inet address if explicitly set by a constructor, null otherwise.

Returns:InetAddress: the inet address
Since: 4.3

getHostName	back to summary
public String getHostName() Implements org.apache.hc.core5.net.NamedEndpoint.getHostName. Returns the host name. Returns:String the host name (IP or DNS name) Annotations @Override

getHostName

back to summary

public String getHostName()

Implements org.apache.hc.core5.net.NamedEndpoint.getHostName.

Returns the host name.

Returns:String

the host name (IP or DNS name)

Annotations

@Override

getPort back to summary

getPort	back to summary
public int getPort() Implements org.apache.hc.core5.net.NamedEndpoint.getPort. Returns the port. Returns:int the host port, or `-1` if not set Annotations @Override

public int getPort()

Implements org.apache.hc.core5.net.NamedEndpoint.getPort.

Returns the port.

Returns:int

the host port, or -1 if not set

Annotations

@Override

getSchemeName	back to summary
public String getSchemeName() Returns the scheme name. Returns:String the scheme name

getSchemeName

back to summary

public String getSchemeName()

Returns the scheme name.

Returns:String: the scheme name

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()

toHostString back to summary

toHostString	back to summary
public String toHostString() Obtains the host string, without scheme prefix. Returns:String the host string, for example `localhost:8080`

public String toHostString()

Obtains the host string, without scheme prefix.

Returns:String: the host string, for example localhost:8080

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

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