Module org.praxislive.hub.net

Package org.praxislive.hub.net

Class DefaultProxyInfo

java.lang.Object

org.praxislive.hub.net.DefaultProxyInfo

All Implemented Interfaces:

ProxyInfo

public class DefaultProxyInfo
extends Object
implements ProxyInfo

Default implementation of ProxyInfo that can be parsed from a PMap, used by HubConfiguration.

Method Summary

Modifier and Type	Method	Description
Optional<ProxyInfo.Exec>	exec()	Access an optional ProxyInfo.Exec implementation giving information about the process that should be executed when initializing this proxy.
static DefaultProxyInfo	fromMap(PMap conf)	Parse a DefaultProxyInfo from a provided PMap.
boolean	matches(String rootID, ComponentType rootType)	Check whether this proxy should be used for creating and accessing the given root ID and root type.
InetSocketAddress	socketAddress()	Access the socket address to use to connect to the proxy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.praxislive.hub.net.ProxyInfo

isLocal

Method Detail

socketAddress

public InetSocketAddress socketAddress()

Description copied from interface: ProxyInfo

Access the socket address to use to connect to the proxy.

Specified by:

socketAddress in interface ProxyInfo

Returns:

socket address

matches

public boolean matches(String rootID,
                       ComponentType rootType)

Description copied from interface: ProxyInfo

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.

Specified by:

matches in interface ProxyInfo

Parameters:

rootID - root ID to match against

rootType - root type to match against

Returns:

true if this proxy should be used for this ID and type

exec

public Optional<ProxyInfo.Exec> exec()

Description copied from interface: ProxyInfo

Access an optional ProxyInfo.Exec implementation giving information about the process that should be executed when initializing this proxy.

Specified by:

exec in interface ProxyInfo

Returns:

optional exec

fromMap

public static DefaultProxyInfo fromMap(PMap conf)

Parse a DefaultProxyInfo from a provided PMap.

Parameters:

conf - proxy info as PMap

Returns:

DefaultProxyInfo parsed from configuration map

Throws:

IllegalArgumentException - if map is incorrectly structured