Apache Mina SSHD 2.15.0 · org.apache.sshd.common.forward.LocalForwardingEntry

Modifier and Type	Field and Description
private final SshdSocketAddress	bound
private final SshdSocketAddress	combined
private final SshdSocketAddress	local

Access	Constructor and Description
public	LocalForwardingEntry(SshdSocketAddress local, InetSocketAddress bound)
public	LocalForwardingEntry(SshdSocketAddress local, SshdSocketAddress bound)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static LocalForwardingEntry	findMatchingEntry(String host, int port, Collection<? extends LocalForwardingEntry> entries)
public static LocalForwardingEntry	Returns: The first entry whose local or bound address matches the host name - case insensitive and has a matching bound port - `null` if no match found findMatchingEntry(String The host - ignored if `null`/empty and not wildcard address match - i.e., no match reported host, boolean Is host the wildcard address - in which case, we try an exact match first for the host, and if that fails then only the port is matched anyLocalAddress, int The port - ignored if non-positive - i.e., no match reported port, Collection<? extends LocalForwardingEntry> The `Collection` of `LocalForwardingEntry` to check - ignored if `null`/empty - i.e., no match reported entries)
public SshdSocketAddress	Returns: The actual bound address getBoundAddress()
public SshdSocketAddress	Returns: Combined result getCombinedBoundAddress() A combined address using the following logic: If original requested local binding has a specific port and non-wildcard address then use the local binding as-is If original requested local binding has a specific address but no specific port, then combine its address with the actual auto-allocated port at binding. If original requested local binding has neither a specific address nor a specific port then use the effective bound address.
public SshdSocketAddress	Returns: The original requested local address for binding getLocalAddress()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static SshdSocketAddress	resolveCombinedBoundAddress(SshdSocketAddress local, SshdSocketAddress bound)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

bound	back to summary
private final SshdSocketAddress bound

combined	back to summary
private final SshdSocketAddress combined

local	back to summary
private final SshdSocketAddress local

LocalForwardingEntry	back to summary
public LocalForwardingEntry(SshdSocketAddress local, InetSocketAddress bound)

LocalForwardingEntry	back to summary
public LocalForwardingEntry(SshdSocketAddress local, SshdSocketAddress bound)

Method Detail

equals back to summary

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

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

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

findMatchingEntry	back to summary
public static LocalForwardingEntry findMatchingEntry(String host, int port, Collection<? extends LocalForwardingEntry> entries)

findMatchingEntry back to summary

findMatchingEntry	back to summary
public static LocalForwardingEntry findMatchingEntry(String host, boolean anyLocalAddress, int port, Collection<? extends LocalForwardingEntry> entries) Parameters host:String The host - ignored if `null`/empty and not wildcard address match - i.e., no match reported anyLocalAddress:boolean Is host the wildcard address - in which case, we try an exact match first for the host, and if that fails then only the port is matched port:int The port - ignored if non-positive - i.e., no match reported entries:Collection<? extends LocalForwardingEntry> The `Collection` of `LocalForwardingEntry` to check - ignored if `null`/empty - i.e., no match reported Returns:LocalForwardingEntry The first entry whose local or bound address matches the host name - case insensitive and has a matching bound port - `null` if no match found

public static LocalForwardingEntry findMatchingEntry(String host, boolean anyLocalAddress, int port, Collection<? extends LocalForwardingEntry> entries)

Parameters

host:String: The host - ignored if null/empty and not wildcard address match - i.e., no match reported
anyLocalAddress:boolean: Is host the wildcard address - in which case, we try an exact match first for the host, and if that fails then only the port is matched
port:int: The port - ignored if non-positive - i.e., no match reported
entries:Collection<? extends LocalForwardingEntry>: The Collection of LocalForwardingEntry to check - ignored if null/empty - i.e., no match reported

Returns:LocalForwardingEntry

The first entry whose local or bound address matches the host name - case insensitive and has a matching bound port - null if no match found

getBoundAddress	back to summary
public SshdSocketAddress getBoundAddress() Returns:SshdSocketAddress The actual bound address

getCombinedBoundAddress	back to summary
public SshdSocketAddress getCombinedBoundAddress() A combined address using the following logic: If original requested local binding has a specific port and non-wildcard address then use the local binding as-is If original requested local binding has a specific address but no specific port, then combine its address with the actual auto-allocated port at binding. If original requested local binding has neither a specific address nor a specific port then use the effective bound address. Returns:SshdSocketAddress Combined result

getCombinedBoundAddress

back to summary

public SshdSocketAddress getCombinedBoundAddress()

A combined address using the following logic:

If original requested local binding has a specific port and non-wildcard address then use the local binding as-is
If original requested local binding has a specific address but no specific port, then combine its address with the actual auto-allocated port at binding.
If original requested local binding has neither a specific address nor a specific port then use the effective bound address.

Returns:SshdSocketAddress: Combined result

getLocalAddress	back to summary
public SshdSocketAddress getLocalAddress() Returns:SshdSocketAddress The original requested local address for binding

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

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

resolveCombinedBoundAddress	back to summary
public static SshdSocketAddress resolveCombinedBoundAddress(SshdSocketAddress local, SshdSocketAddress bound)

toString back to summary

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. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

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

public Class LocalForwardingEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail