-
- All Known Implementing Classes:
DefaultProxyInfo
public interface ProxyInfo
Information about an available proxy process to connect to.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ProxyInfo.Exec
Information about process that should be executed when initializing a proxy.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Optional<ProxyInfo.Exec>
exec()
Access an optionalProxyInfo.Exec
implementation giving information about the process that should be executed when initializing this proxy.default boolean
isLocal()
Check whether the proxy is running on the same (local) machine.boolean
matches(String rootID, ComponentType rootType)
Check whether this proxy should be used for creating and accessing the given root ID and root type.SocketAddress
socketAddress()
Access the socket address to use to connect to the proxy.
-
-
-
Method Detail
-
socketAddress
SocketAddress socketAddress()
Access the socket address to use to connect to the proxy.- Returns:
- socket address
-
isLocal
default boolean isLocal()
Check whether the proxy is running on the same (local) machine. By default this method returns true if the socket address is an instance of InetSocketAddress and is using the loopback address. SeeInetAddress.isLoopbackAddress()
.- Returns:
- true if proxy is local
-
matches
boolean matches(String rootID, ComponentType rootType)
Check whether this proxy should be used for creating and accessing the given root ID and root type. The order of provided proxies is important as the first matching proxy will take precedence.- Parameters:
rootID
- root ID to match againstrootType
- root type to match against- Returns:
- true if this proxy should be used for this ID and type
-
exec
default Optional<ProxyInfo.Exec> exec()
Access an optionalProxyInfo.Exec
implementation giving information about the process that should be executed when initializing this proxy.- Returns:
- optional exec
-
-