com.tibco.as.space

Class MemberDef

java.lang.Object

com.tibco.as.space.MemberDef

public abstract class MemberDef
extends java.lang.Object

MemberDef represents how ActiveSpaces makes member connections to a metaspace. MemberDef includes discovery and listen URL attributes. The discovery URL attribute is used during initial setup to discover other ActiveSpaces instances. The listen URL attribute is used for internal ActiveSpaces communication.

Discovery URL attribute:
Specifies how this instance will connect to the Metaspace, either as a fully connected peer, or as a remote client. If connecting as a fully connected peer, specifies how this instance will discover other instances in the metaspace. Discovery can be unicast (TCP) or multicast (PGM or RV).

There are three different discovery protocols:

• tcp://ip:port(;ip:port)*

  List of semicolon separated IP address/port pairs. These are well known IP address/port pairs to discover existing members. Ex. tcp://ip1:port1;ip2:port2;... If no port is specified, a default port of 50000 will be used. If user has specified some other port via TCP URL list it overrides the default discovery port. For example;
  If user has specified tcp://self_ip:8000;IP2:8001/..; ActiveSpaces will open discovery port 8000 to listen for discovery requests of new members to find the metaspace manager.

• tibpgm:// (default)

  tibpgm://port/interface;multicast-group/daemon parameters/
  Refer to documentation for PGM transport

• tibrv://

  tibrv://service/network/daemon/
  Refer to documentation for RV transport

To connect as a remote client, use a Discovery URL of the following format:

• tcp://ip:port?remote=true

Where ip and port are the IP address and the TCP port of a proxying fully connected peer that is listening on the specified TCP port for remote client connections (see remote_listen URL)

Listen URL attribute:

Defaults to tcp://
By default ActiveSpaces instance listens on the default host interface (as pointed to by 'hostname') and uses the first free port it can find starting from port 50000 and automatically increasing the port number until it finds a free port for ActiveSpaces internal data communication. If your machine has blocked this range of ports please specify an available port here. Ex: tcp://self_ip:6000.
If user did not provide any argument for listen URL, the connection definition can be used to retrieve this information after connecting to the metaspace.

Constructor Summary

Constructors

Constructor and Description
MemberDef()

Method Summary

Modifier and Type	Method and Description
static MemberDef	create() Returns a new MemberDef instance with default settings.
static MemberDef	create(java.lang.String memberName, java.lang.String discovery, java.lang.String listen) Returns a new MemberDef instance with the given attribute values.
abstract AuthenticationCallback	getAuthenticationCallback() Returns the security AuthenticationCallback instance.
abstract long	getClientTimeout() Returns the MemberDef setting for how much time (in milliseconds) to wait for a client to reconnect.
abstract int	getClusterSuspendThreshold() Returns the MemberDef setting for how many lost host connections will be allowed before membership operations are suspended.
abstract long	getConnectTimeout()
abstract Tuple	getContext() Returns the context tuple of the MemberDef instance.
abstract java.lang.String	getDataStore() Returns the data store location for shared-nothing persistence.
abstract java.lang.String	getDiscovery() Returns the discovery URL attribute value of the MemberDef instance.
abstract char[]	getIdentityPassword() Get the identity password.
abstract java.lang.String	getListen() Returns the listen URL attribute value of the MemberDef instance.
abstract java.lang.String	getMemberName() Returns the member name attribute value of the MemberDef instance.
abstract long	getMemberTimeout() Returns the MemberDef setting for how much time (in milliseconds) to wait for a member to reconnect.
abstract java.lang.String	getRemoteDiscovery() Returns the remote discovery URL attribute value of the MemberDef instance.
abstract java.lang.String	getRemoteListen() Returns the remote listen URL attribute value of the MemberDef instance.
abstract java.lang.String	getRouterListen() Returns the site router listen URL attribute value of the MemberDef instance.
abstract long	getRxBufferSize()
abstract java.lang.String	getSecurityPolicyFile() Returns the member's security policy file location.
abstract java.lang.String	getSecurityTokenFile() Returns the security token file location.
abstract long	getTimeout() Deprecated.
abstract int	getTransportThreadCount() Returns the number of threads which can be used to service transport requests.
abstract int	getWorkerThreadCount() Returns the number of threads which can be used to service remote invocations.
abstract boolean	isSystemSeeder()
abstract boolean	isSystemSiteRouter()
abstract MemberDef	setAuthenticationCallback(AuthenticationCallback callback) Sets the security authentication callback method for the member.
abstract MemberDef	setClientTimeout(long timeout) Sets the amount of time (in milliseconds) to wait for a client to reconnect.
abstract MemberDef	setClusterSuspendThreshold(int threshold) Sets the number of host connections which can be lost after which membership operations are suspended.
abstract MemberDef	setConnectTimeout(long timeout) Connect timeout helps to unnblock the connect call.
abstract MemberDef	setContext(Tuple context) Sets the context tuple of the MemberDef instance.
abstract MemberDef	setDataStore(java.lang.String dataStore) Sets the data store location for shared-nothing persistence.
abstract MemberDef	setDiscovery(java.lang.String discovery) Sets the discovery URL attribute of the MemberDef instance.
abstract MemberDef	setIdentityPassword(char[] identityPassword) Set the identity password for a token or a policy's security domain if the identity is encrypted.
abstract MemberDef	setListen(java.lang.String listen) Sets the listen URL attribute of the MemberDef instance.
abstract MemberDef	setMemberName(java.lang.String name) Sets the member name attribute value of the MemberDef instance.
abstract MemberDef	setMemberTimeout(long timeout) Sets the amount of time (in milliseconds) to wait for a member to reconnect.
abstract MemberDef	setRemoteDiscovery(java.lang.String remoteDiscoveryUrl) Sets the remote discovery URL attribute value of the MemberDef instance.
abstract MemberDef	setRemoteListen(java.lang.String remoteListen) Sets the remote listen URL attribute value of the MemberDef instance.
abstract MemberDef	setRouterListen(java.lang.String routerListen) Sets the site router listen URL attribute value of the MemberDef instance.
abstract MemberDef	setRxBufferSize(long bufferSize)
abstract MemberDef	setSecurityPolicyFile(java.lang.String policyFile) Sets the security policy file for the member.
abstract MemberDef	setSecurityTokenFile(java.lang.String tokenFile) Sets the security token file for the member.
abstract MemberDef	setSystemSeeder(boolean isSystemSeeder)
abstract MemberDef	setSystemSiteRouter(boolean isSystemSiteRouter)
abstract MemberDef	setTimeout(long timeout) Deprecated. Use SpaceDef.setWriteTimeout(long) or SpaceDef.setReadTimeout(long)
abstract MemberDef	setTransportThreadCount(int count) Sets the number of threads which can be used to service transport requests.
abstract MemberDef	setWorkerThreadCount(int count) Sets the number of threads which can be used to service remote invocations.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemberDef

public MemberDef()

Method Detail

create

public static MemberDef create()

Returns a new MemberDef instance with default settings.

Returns:

The new MemberDef instance.

create

public static MemberDef create(java.lang.String memberName,
                               java.lang.String discovery,
                               java.lang.String listen)

Returns a new MemberDef instance with the given attribute values.

Parameters:

memberName - Member name attribute value

discovery - Discovery URL attribute value

listen - Listen URL attribute value

Returns:

The new MemberDef instance.

setListen

public abstract MemberDef setListen(java.lang.String listen)

Sets the listen URL attribute of the MemberDef instance.

Parameters:

listen - The listen URL attribute value

Returns:

The updated MemberDef instance.

getListen

public abstract java.lang.String getListen()

Returns the listen URL attribute value of the MemberDef instance.

Returns:

The listen URL attribute value.

setDiscovery

public abstract MemberDef setDiscovery(java.lang.String discovery)

Sets the discovery URL attribute of the MemberDef instance.

Parameters:

discovery - The discovery URL attribute value

Returns:

The updated MemberDef instance.

getDiscovery

public abstract java.lang.String getDiscovery()

Returns the discovery URL attribute value of the MemberDef instance.

Returns:

The discovery URL attribute value.

setMemberName

public abstract MemberDef setMemberName(java.lang.String name)

Sets the member name attribute value of the MemberDef instance.

Parameters:

name - The member name attribute value

Returns:

The updated MemberDef instance.

getMemberName

public abstract java.lang.String getMemberName()

Returns the member name attribute value of the MemberDef instance.

Returns:

The member name attribute value.

setRemoteDiscovery

public abstract MemberDef setRemoteDiscovery(java.lang.String remoteDiscoveryUrl)

Sets the remote discovery URL attribute value of the MemberDef instance. Please note that a better and preferred way to connect to the metaspace as a remote client is to use a Discovery URL of the format tcp://ip:port?remote=true

Parameters:

remoteDiscoveryUrl - The remote discovery URL attribute value

Returns:

The updated MemberDef instance.

getRemoteDiscovery

public abstract java.lang.String getRemoteDiscovery()

Returns the remote discovery URL attribute value of the MemberDef instance.

Returns:

The remote discovery attribute value

setRemoteListen

public abstract MemberDef setRemoteListen(java.lang.String remoteListen)

Sets the remote listen URL attribute value of the MemberDef instance.

Parameters:

remoteListen - The remote listen URL attribute value

Returns:

The updated MemberDef instance.

getRemoteListen

public abstract java.lang.String getRemoteListen()

Returns the remote listen URL attribute value of the MemberDef instance.

Returns:

The remote listen URL attribute value

setRouterListen

public abstract MemberDef setRouterListen(java.lang.String routerListen)

Sets the site router listen URL attribute value of the MemberDef instance.

Parameters:

routerListen - The site listen URL attribute value

Returns:

The updated MemberDef instance.

getRouterListen

public abstract java.lang.String getRouterListen()

Returns the site router listen URL attribute value of the MemberDef instance.

Returns:

The site router listen URL attribute value

setContext

public abstract MemberDef setContext(Tuple context)

Sets the context tuple of the MemberDef instance.

Parameters:

context - Context tuple for member

Returns:

The updated MemberDef instance.

getContext

public abstract Tuple getContext()

Returns the context tuple of the MemberDef instance.

Returns:

The context tuple.

setTimeout

@Deprecated
public abstract MemberDef setTimeout(long timeout)

Deprecated. Use SpaceDef.setWriteTimeout(long) or SpaceDef.setReadTimeout(long)

Define the timeout per space operation. This timeout will apply all user spaces the member joins.

Parameters:

timeout - The timeout in milliseconds

Returns:

The updated MemberDef instance.

getTimeout

@Deprecated
public abstract long getTimeout()

Deprecated.

Returns the timeout (in milliseconds) to use for space operations.

Returns:

The timeout (in milliseconds) that defines the timeout for space operations

setMemberTimeout

public abstract MemberDef setMemberTimeout(long timeout)

Sets the amount of time (in milliseconds) to wait for a member to reconnect.

Parameters:

timeout - The timeout in milliseconds.

Returns:

The updated MemberDef object.

getMemberTimeout

public abstract long getMemberTimeout()

Returns the MemberDef setting for how much time (in milliseconds) to wait for a member to reconnect.

Returns:

The member reconnect timeout (in milliseconds).

setClusterSuspendThreshold

public abstract MemberDef setClusterSuspendThreshold(int threshold)

Sets the number of host connections which can be lost after which membership operations are suspended. (Used with host aware replication.)

Parameters:

threshold - The number of lost host connections which will cause membership operations to be suspended.

Returns:

The updated MemberDef object.

getClusterSuspendThreshold

public abstract int getClusterSuspendThreshold()

Returns the MemberDef setting for how many lost host connections will be allowed before membership operations are suspended. (Default -1, never suspend)

Returns:

The maximum number of lost host connections allowed.

setClientTimeout

public abstract MemberDef setClientTimeout(long timeout)

Sets the amount of time (in milliseconds) to wait for a client to reconnect.

Parameters:

timeout - The timeout in milliseconds.

Returns:

The updated MemberDef object.

getClientTimeout

public abstract long getClientTimeout()

Returns the MemberDef setting for how much time (in milliseconds) to wait for a client to reconnect. Default 30000.

Returns:

The client reconnect timeout (in milliseconds).

setWorkerThreadCount

public abstract MemberDef setWorkerThreadCount(int count)

Sets the number of threads which can be used to service remote invocations.

Parameters:

count - The number of worker threads

Returns:

The updated MemberDef instance.

getWorkerThreadCount

public abstract int getWorkerThreadCount()

Returns the number of threads which can be used to service remote invocations.

Returns:

The worker thread count.

setTransportThreadCount

public abstract MemberDef setTransportThreadCount(int count)

Sets the number of threads which can be used to service transport requests.

Parameters:

count - The number of transport threads

Returns:

The updated MemberDef instance.

getTransportThreadCount

public abstract int getTransportThreadCount()

Returns the number of threads which can be used to service transport requests.

Returns:

The transport thread count.

setRxBufferSize

public abstract MemberDef setRxBufferSize(long bufferSize)

getRxBufferSize

public abstract long getRxBufferSize()

setDataStore

public abstract MemberDef setDataStore(java.lang.String dataStore)

Sets the data store location for shared-nothing persistence.

Parameters:

dataStore - The data store location.

Returns:

The updated MemberDef instance.

getDataStore

public abstract java.lang.String getDataStore()

Returns the data store location for shared-nothing persistence.

Returns:

The data store location.

setSecurityPolicyFile

public abstract MemberDef setSecurityPolicyFile(java.lang.String policyFile)

Sets the security policy file for the member. The security policy file contains the security properties for members who are security domain controllers. If a member is a security domain controller, a security policy file must be specified. If a member is not a security domain controller, a security policy file must not be specified.

Parameters:

policyFile - The full path to the security policy file.

Returns:

The updated MemberDef instance.

setSecurityTokenFile

public abstract MemberDef setSecurityTokenFile(java.lang.String tokenFile)

Sets the security token file for the member. When security is used in a metaspace, a security token file must be specified for those members who are not security domain controllers. If a security token file is specified for the member, a security policy file must not be specified for the member.

Parameters:

tokenFile - The full path to the security token file.

Returns:

The updated MemberDef instance.

setAuthenticationCallback

public abstract MemberDef setAuthenticationCallback(AuthenticationCallback callback)

Sets the security authentication callback method for the member.

Parameters:

callback - A user provided implementation for supplying client credentials to the security authentication callback mechanism. If the security policy for the metaspace requires application-level client authentication, the ActiveSpaces framework invokes the AuthenticationCallback.createUserCredential(com.tibco.as.space.security.AuthenticationInfo)} method during the join process of this member. If authentication is required and the implementation doesn't provide the required client credential, the member will not be able to connect to the metaspace. If authentication is required and the implementation doesn't provide a callback, the default ActiveSpaces credential provider will be used. If the security domain's policy doesn't require authentication, specifying the callback is not required and any implementation provided, will be ignored.

Returns:

The updated MemberDef instance.

setIdentityPassword

public abstract MemberDef setIdentityPassword(char[] identityPassword)

Set the identity password for a token or a policy's security domain if the identity is encrypted. In case, the identity has not been encrypted, no password needs to be set and any password set, will be ignored.

Parameters:

identityPassword -

Returns:

The updated MemberDef instance.

getSecurityTokenFile

public abstract java.lang.String getSecurityTokenFile()

Returns the security token file location.

Returns:

The security token file location, may be null.

getSecurityPolicyFile

public abstract java.lang.String getSecurityPolicyFile()

Returns the member's security policy file location.

Returns:

The security policy file location, may be null.

getAuthenticationCallback

public abstract AuthenticationCallback getAuthenticationCallback()

Returns the security AuthenticationCallback instance.

Returns:

The AuthenticationCallback instance.

getIdentityPassword

public abstract char[] getIdentityPassword()

Get the identity password.

Returns:

The identity password or null if it was not set.

setConnectTimeout

public abstract MemberDef setConnectTimeout(long timeout)

Connect timeout helps to unnblock the connect call. Exception will be thrown from connect method if connection cannot be established before timeout.

Parameters:

timeout - time to wait (in milliseconds) until connection is successful.

getConnectTimeout

public abstract long getConnectTimeout()

Returns:

connect timeout value

setSystemSeeder

public abstract MemberDef setSystemSeeder(boolean isSystemSeeder)
                                   throws ASException

Parameters:

isSystemSeeder - set as system seeder default to true

Throws:

ASException

isSystemSeeder

public abstract boolean isSystemSeeder()
                                throws ASException

Returns:

if member is a system seeder

Throws:

ASException

setSystemSiteRouter

public abstract MemberDef setSystemSiteRouter(boolean isSystemSiteRouter)
                                       throws ASException

Parameters:

isSystemSiteRouter - set as system site router default to true

Throws:

ASException

isSystemSiteRouter

public abstract boolean isSystemSiteRouter()
                                    throws ASException

Returns:

if member is a system site router

Throws:

ASException