Top Description Inners Fields Constructors Methods
org.eclipse.jetty.client

public Class Origin

extends Object
Class Inheritance
Imports
java.net.InetSocketAddress, .SocketAddress, java.util.List, .Map, .Objects, org.eclipse.jetty.client.transport.HttpClientTransportDynamic, org.eclipse.jetty.io.ClientConnectionFactory, .EndPoint, org.eclipse.jetty.util.HostPort, .URIUtil

Class that groups the elements that uniquely identify a destination.

The elements are scheme, host, port, a Origin.Protocol and a tag object that further distinguishes destinations that have the same origin and protocol.

In general it is possible that, for the same origin, the server can speak different protocols (for example, clear-text HTTP/1.1 and clear-text HTTP/2), so the Origin.Protocol makes that distinction.

Furthermore, it may be desirable to have different destinations for the same origin and protocol (for example, when using the PROXY protocol in a reverse proxy server, you want to be able to map the client ip:port to the destination tag, so that all the connections to the server associated to that destination can specify the PROXY protocol bytes for that particular client connection.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Origin.Address

public static class
Origin.Protocol

The representation of a network protocol.

Field Summary

Modifier and TypeField and Description
private final Origin.Address
address

private final Origin.Protocol
protocol

private final String
scheme

private final Object
tag

Constructor Summary

AccessConstructor and Description
public
Origin(String scheme, String host, int port)

public
Origin(String scheme, String host, int port, Object tag)

public
Origin(String scheme, String host, int port, Object tag, Origin.Protocol protocol)

public
Origin(String scheme, Origin.Address address)

public
Origin(String scheme, Origin.Address address, Object tag)

public
Origin(String scheme, Origin.Address address, Object tag, Origin.Protocol protocol)

Method Summary

Modifier and TypeMethod and Description
public String
asString()

public boolean
equals(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 Origin.Address
getAddress()

public Origin.Protocol
getProtocol()

public String
getScheme()

public Object
getTag()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

addressback to summary
private final Origin.Address address
protocolback to summary
private final Origin.Protocol protocol
schemeback to summary
private final String scheme
tagback to summary
private final Object tag

Constructor Detail

Originback to summary
public Origin(String scheme, String host, int port)
Originback to summary
public Origin(String scheme, String host, int port, Object tag)
Originback to summary
public Origin(String scheme, String host, int port, Object tag, Origin.Protocol protocol)
Originback to summary
public Origin(String scheme, Origin.Address address)
Originback to summary
public Origin(String scheme, Origin.Address address, Object tag)
Originback to summary
public Origin(String scheme, Origin.Address address, Object tag, Origin.Protocol protocol)

Method Detail

asStringback to summary
public String asString()
equalsback to summary
public boolean equals(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
getAddressback to summary
public Origin.Address getAddress()
getProtocolback to summary
public Origin.Protocol getProtocol()
getSchemeback to summary
public String getScheme()
getTagback to summary
public Object getTag()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.eclipse.jetty.client back to summary

public Class Origin.Address

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final SocketAddress
address

private final String
host

private final int
port

Constructor Summary

AccessConstructor and Description
public
Address(String host, int port)

Method Summary

Modifier and TypeMethod and Description
public String
asString()

public boolean
equals(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 String
getHost()

public int
getPort()

public SocketAddress
getSocketAddress()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

addressback to summary
private final SocketAddress address
hostback to summary
private final String host
portback to summary
private final int port

Constructor Detail

Addressback to summary
public Address(String host, int port)

Method Detail

asStringback to summary
public String asString()
equalsback to summary
public boolean equals(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
getHostback to summary
public String getHost()
getPortback to summary
public int getPort()
getSocketAddressback to summary
public SocketAddress getSocketAddress()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.eclipse.jetty.client back to summary

public Class Origin.Protocol

extends Object
Class Inheritance

The representation of a network protocol.

A network protocol may have multiple protocol names associated to it, for example ["h2", "h2-17", "h2-16"].

A Protocol is then rendered into a ClientConnectionFactory chain, for example in HttpClientTransportDynamic#newConnection(EndPoint, Map).

Field Summary

Modifier and TypeField and Description
private final boolean
negotiate

private final List<String>
protocols

Constructor Summary

AccessConstructor and Description
public
Protocol(List<String>
the protocol names
protocols, boolean
whether the protocol should be negotiated
negotiate)

Creates a Protocol with the given list of protocol names and whether it should negotiate the protocol.

Method Summary

Modifier and TypeMethod and Description
public String
asString()

public boolean
equals(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 List<String>
getProtocols()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isNegotiate()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

negotiateback to summary
private final boolean negotiate
protocolsback to summary
private final List<String> protocols

Constructor Detail

Protocolback to summary
public Protocol(List<String> protocols, boolean negotiate)

Creates a Protocol with the given list of protocol names and whether it should negotiate the protocol.

Parameters
protocols:List<String>

the protocol names

negotiate:boolean

whether the protocol should be negotiated

Method Detail

asStringback to summary
public String asString()
equalsback to summary
public boolean equals(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
getProtocolsback to summary
public List<String> getProtocols()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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
isNegotiateback to summary
public boolean isNegotiate()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override