org.apache.hc.core5.http

Class HttpHost

java.lang.Object

org.apache.hc.core5.http.HttpHost

All Implemented Interfaces:

Serializable, NamedEndpoint

@Contract(threading=IMMUTABLE)
public final class HttpHost
extends Object
implements NamedEndpoint, Serializable

Component that holds all details needed to describe an HTTP connection to a host. This includes remote host name, port and protocol scheme.

Since:

4.0, 5.0 For constructors that take a scheme as an argument, that argument is now the first one.

See Also:

Host, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static URIScheme	DEFAULT_SCHEME The default scheme is "http".

Constructor Summary

Constructors

Constructor and Description
HttpHost(InetAddress address) Creates HttpHost instance with the default scheme and port and the given inet address.
HttpHost(InetAddress address, int port) Creates HttpHost instance with the default scheme and the given inet address and port.
HttpHost(String hostname) Creates HttpHost instance with the default scheme and port and the given hostname.
HttpHost(String scheme, InetAddress address, int port) Creates HttpHost instance with the given scheme, inet address and port.
HttpHost(String scheme, InetAddress address, String hostname, int port) Creates a new HttpHost, specifying all values.
HttpHost(String hostname, int port) Creates HttpHost instance with the default scheme and the given hostname and port.
HttpHost(String scheme, NamedEndpoint namedEndpoint)
HttpHost(String scheme, String hostname) Creates HttpHost instance with the given hostname and scheme and the default port for that scheme.
HttpHost(String scheme, String hostname, int port) Creates HttpHost instance with the given scheme, hostname and port.
HttpHost(URIAuthority authority)

Method Summary

Modifier and Type	Method and Description
static HttpHost	create(String s) Creates HttpHost instance from a string.
static HttpHost	create(URI uri) Creates an HttpHost instance from the scheme, host, and port from the given URI.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
InetAddress	getAddress() Returns the inet address if explicitly set by a constructor, null otherwise.
String	getHostName() Returns the host name.
int	getPort() Returns the port.
String	getSchemeName() Returns the scheme name.
int	hashCode() Returns a hash code value for the object.
String	toHostString() Obtains the host string, without scheme prefix.
String	toString() Returns a string representation of the object.
String	toURI() Return the host URI, as a string.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SCHEME

public static final URIScheme DEFAULT_SCHEME

The default scheme is "http".

Constructor Detail

HttpHost

public HttpHost(InetAddress address)

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

Parameters:

address - the inet address.

Throws:

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

public HttpHost(InetAddress address,
                int port)

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

Parameters:

address - the inet address.

port - the port number. -1 indicates the scheme default port.

Throws:

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

public HttpHost(String hostname)

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

Parameters:

hostname - the hostname (IP or DNS name)

Throws:

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

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

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

Parameters:

scheme - the name of the scheme. null indicates the default scheme

address - the inet address.

port - the port number. -1 indicates the scheme default port.

Throws:

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

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

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

Parameters:

scheme - the name of the scheme. null indicates the default scheme

address - the inet address. Can be null

hostname - the hostname (IP or DNS name)

port - the port number. -1 indicates the scheme default port.

Throws:

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

public HttpHost(String hostname,
                int port)

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

Parameters:

hostname - the hostname (IP or DNS name)

port - the port number. -1 indicates the scheme default port.

Throws:

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

public HttpHost(String scheme,
                NamedEndpoint namedEndpoint)

Throws:

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

public HttpHost(String scheme,
                String hostname)

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

Parameters:

scheme - the name of the scheme. null indicates the default scheme

hostname - the hostname (IP or DNS name)

Throws:

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

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

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

Parameters:

scheme - the name of the scheme. null indicates the default scheme

hostname - the hostname (IP or DNS name)

port - the port number. -1 indicates the scheme default port.

Throws:

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

public HttpHost(URIAuthority authority)

Throws:

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

Method Detail

create

public static HttpHost create(String s)
                       throws URISyntaxException

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

Throws:

URISyntaxException

Since:

4.4

create

public static HttpHost create(URI uri)

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

Parameters:

uri - scheme, host, and port.

Returns:

a new HttpHost

Since:

5.0

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

getAddress

public InetAddress getAddress()

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

Returns:

the inet address

Since:

4.3

getHostName

public String getHostName()

Returns the host name.

Specified by:

getHostName in interface NamedEndpoint

Returns:

the host name (IP or DNS name)

getPort

public int getPort()

Returns the port.

Specified by:

getPort in interface NamedEndpoint

Returns:

the host port, or -1 if not set

getSchemeName

public String getSchemeName()

Returns the scheme name.

Returns:

the scheme name

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

toHostString

public String toHostString()

Obtains the host string, without scheme prefix.

Returns:

the host string, for example localhost:8080

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.

toURI

public String toURI()

Return the host URI, as a string.

Returns:

the host URI