Package com.tangosol.net

Class URLMemberIdentityProvider

java.lang.Object

com.tangosol.net.URLMemberIdentityProvider

All Implemented Interfaces:

MemberIdentityProvider

public class URLMemberIdentityProvider
extends Object
implements MemberIdentityProvider

A MemberIdentityProvider that retrieves identity values from URLs, files, or class path resources.

Since:

22.06

Author:

Jonathan Knight

Field Summary

Fields

Modifier and Type	Field	Description
static com.oracle.coherence.common.util.Duration	DURATION_HTTP_TIMEOUT	The default http connection timeout.
static com.oracle.coherence.common.util.Duration	DURATION_RETRY_PERIOD	The default retry period.
static com.oracle.coherence.common.util.Duration	DURATION_RETRY_TIMEOUT	The default retry timeout.
protected HttpClient	m_client	The http client used to access http or https URLs.
protected ClusterDependencies	m_dependencies	The cluster dependencies.
static String	PROP_HTTP_TIMEOUT	The system property to use to set the http connection timeout.
static String	PROP_MACHINE	The system property to use to set the URL to read the machine name from.
static String	PROP_MEMBER	The system property to use to set the URL to read the member name from.
static String	PROP_RACK	The system property to use to set the URL to read the rack name from.
static String	PROP_RETRY_PERIOD	The system property to use to set the retry period.
static String	PROP_RETRY_TIMEOUT	The system property to use to set the retry timeout.
static String	PROP_ROLE	The system property to use to set the URL to read the role name from.
static String	PROP_SITE	The system property to use to set the URL to read the site name from.
static String	PROP_SOCKET_PROVIDER	The system property to use to set the URL to read the role name from.

Fields inherited from interface com.tangosol.net.MemberIdentityProvider

PROPERTY

Constructor Summary

Constructors

Constructor	Description
URLMemberIdentityProvider()

Method Summary

Modifier and Type	Method	Description
protected String	doHttpRequest(URI uri)
protected HttpClient	ensureClient()
String	getMachineName()	Return the name for the Machine (such as a host name) in which this Member resides.
String	getMemberName()	Return the name for the Member.
String	getRackName()	Return the name for the Rack (such as a physical rack, cage or blade frame) in which this Member resides.
String	getRoleName()	Return the role name for the Member.
String	getSiteName()	Return the name for the Site (such as a data center) in which this Member resides.
void	setDependencies(ClusterDependencies deps)	Set the cluster dependencies.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_MACHINE

public static final String PROP_MACHINE

The system property to use to set the URL to read the machine name from.

See Also:

Constant Field Values

PROP_MEMBER

public static final String PROP_MEMBER

The system property to use to set the URL to read the member name from.

See Also:

Constant Field Values

PROP_SITE

public static final String PROP_SITE

The system property to use to set the URL to read the site name from.

See Also:

Constant Field Values

PROP_RACK

public static final String PROP_RACK

The system property to use to set the URL to read the rack name from.

See Also:

Constant Field Values

PROP_ROLE

public static final String PROP_ROLE

The system property to use to set the URL to read the role name from.

See Also:

Constant Field Values

PROP_SOCKET_PROVIDER

public static final String PROP_SOCKET_PROVIDER

The system property to use to set the URL to read the role name from.

See Also:

Constant Field Values

PROP_RETRY_PERIOD

public static final String PROP_RETRY_PERIOD

The system property to use to set the retry period.

See Also:

Constant Field Values

DURATION_RETRY_PERIOD

public static final com.oracle.coherence.common.util.Duration DURATION_RETRY_PERIOD

The default retry period.

PROP_RETRY_TIMEOUT

public static final String PROP_RETRY_TIMEOUT

The system property to use to set the retry timeout.

See Also:

Constant Field Values

DURATION_RETRY_TIMEOUT

public static final com.oracle.coherence.common.util.Duration DURATION_RETRY_TIMEOUT

The default retry timeout.

PROP_HTTP_TIMEOUT

public static final String PROP_HTTP_TIMEOUT

The system property to use to set the http connection timeout.

See Also:

Constant Field Values

DURATION_HTTP_TIMEOUT

public static final com.oracle.coherence.common.util.Duration DURATION_HTTP_TIMEOUT

The default http connection timeout.

m_dependencies

protected ClusterDependencies m_dependencies

The cluster dependencies.

m_client

protected volatile HttpClient m_client

The http client used to access http or https URLs.

Constructor Detail

URLMemberIdentityProvider

public URLMemberIdentityProvider()

Method Detail

getMachineName

public String getMachineName()

Description copied from interface: MemberIdentityProvider

Return the name for the Machine (such as a host name) in which this Member resides. This name is used for logging purposes and to differentiate among multiple servers, and may be used as the basis for determining the MachineId property.

Specified by:

getMachineName in interface MemberIdentityProvider

Returns:

the configured Machine name or null

getMemberName

public String getMemberName()

Description copied from interface: MemberIdentityProvider

Return the name for the Member. This name is used for logging purposes and to differentiate among Members running within a particular process.

Specified by:

getMemberName in interface MemberIdentityProvider

Returns:

the configured Member name or null

getRackName

public String getRackName()

Description copied from interface: MemberIdentityProvider

Return the name for the Rack (such as a physical rack, cage or blade frame) in which this Member resides. This name is used for logging purposes and to differentiate among multiple racks within a particular data center, for example.

Specified by:

getRackName in interface MemberIdentityProvider

Returns:

the configured Rack name or null

getRoleName

public String getRoleName()

Description copied from interface: MemberIdentityProvider

Return the role name for the Member. This role is completely definable by the application, and can be used to determine what Members to use for specific purposes.

Specified by:

getRoleName in interface MemberIdentityProvider

Returns:

the configured role name for the Member or null

getSiteName

public String getSiteName()

Description copied from interface: MemberIdentityProvider

Return the name for the Site (such as a data center) in which this Member resides. This name is used for logging purposes and to differentiate among multiple geographic sites.

Specified by:

getSiteName in interface MemberIdentityProvider

Returns:

the configured Site name or null

setDependencies

public void setDependencies(ClusterDependencies deps)

Description copied from interface: MemberIdentityProvider

Set the cluster dependencies.

Specified by:

setDependencies in interface MemberIdentityProvider

Parameters:

deps - the cluster dependencies

doHttpRequest

protected String doHttpRequest(URI uri)
                        throws IOException

Throws:

IOException

ensureClient

protected HttpClient ensureClient()