com.sleepycat.je.rep.subscription

Class SubscriptionConfig

java.lang.Object

com.sleepycat.je.rep.subscription.SubscriptionConfig

All Implemented Interfaces:

Cloneable

public class SubscriptionConfig
extends Object
implements Cloneable

Object to represent parameters to configure a subscription.

Field Summary

Fields

Modifier and Type	Field and Description
static InetSocketAddress	ANY_ADDRESS
boolean	BLOCKING_MODE_CHANNEL
static long	QUEUE_POLL_INTERVAL_MS
static String	SERVICE_HANDSHAKE_AUTH_METHOD
boolean	TCP_NO_DELAY

Constructor Summary

Constructors

Constructor and Description
SubscriptionConfig(String subNodeName, String subHome, String subHostPortPair, String feederHostPortPair, String groupName) Create a subscription configuration
SubscriptionConfig(String subNodeName, String subHome, String subHostPortPair, String feederHostPortPair, String groupName, UUID groupUUID) Create a subscription configuration with group UUID.
SubscriptionConfig(String subNodeName, String subHome, String subHostPortPair, String feederHostPortPair, String groupName, UUID groupUUID, NodeType nodeType) Create a subscription configuration with group UUID.
SubscriptionConfig(String subNodeName, String subHome, String subHostPortPair, String feederHostPortPair, String groupName, UUID groupUUID, NodeType nodeType, SubscriptionAuthHandler authenticator) Create a subscription configuration with group UUID.
SubscriptionConfig(String subNodeName, String subHome, String subHostPortPair, String feederHostPortPair, String groupName, UUID groupUUID, NodeType nodeType, SubscriptionAuthHandler authenticator, Properties props) Create a subscription configuration with group UUID.

Method Summary

Modifier and Type	Method and Description
SubscriptionConfig	clone()
EnvironmentConfig	createEnvConfig() Create an environment configuration for subscription
SubscriptionAuthHandler	getAuthenticator()
SubscriptionCallback	getCallBack()
long	getChannelTimeout(TimeUnit unit)
FeederFilter	getFeederFilter()
String	getFeederHost()
InetAddress	getFeederHostAddr()
int	getFeederPort()
String	getGroupName()
UUID	getGroupUUID()
int	getHeartbeatIntervalMs()
InetSocketAddress	getInetSocketAddress()
int	getInputMessageQueueSize()
int	getMaxConnectRetries()
int	getMinProtocolVersion()
NodeType	getNodeType()
int	getOutputMessageQueueSize()
String	getPartGenDBName()
long	getPollIntervalMs()
long	getPollTimeoutMs()
long	getPreHeartbeatTimeout(TimeUnit unit)
int	getReceiveBufferSize()
long	getSleepBeforeRetryMs()
BaseProtocol.EntryRequestType	getStreamMode()
long	getStreamOpenTimeout(TimeUnit unit)
String	getSubNodeHostPort()
String	getSubNodeName()
String	getSubscriberHome()
void	setCallback(SubscriptionCallback cbk)
void	setChannelTimeout(long timeout, TimeUnit unit)
void	setFeederFilter(FeederFilter filter) Set the feeder filter which will be transmitted to Feeder.
void	setGroupUUID(UUID gID)
void	setHeartbeatInterval(int ms)
void	setInputMessageQueueSize(int size)
void	setMinProtocolVersion(int ver)
void	setOutputMessageQueueSize(int size)
void	setPartGenDBName(String dbName)
void	setPreHeartbeatTimeout(long timeout, TimeUnit unit)
void	setReceiveBufferSize(int val)
void	setStreamMode(BaseProtocol.EntryRequestType type)
void	setStreamOpenTimeout(long timeout, TimeUnit unit)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

QUEUE_POLL_INTERVAL_MS

public static final long QUEUE_POLL_INTERVAL_MS

See Also:

Constant Field Values

SERVICE_HANDSHAKE_AUTH_METHOD

public static final String SERVICE_HANDSHAKE_AUTH_METHOD

See Also:

Constant Field Values

ANY_ADDRESS

public static final InetSocketAddress ANY_ADDRESS

TCP_NO_DELAY

public final boolean TCP_NO_DELAY

See Also:

Constant Field Values

BLOCKING_MODE_CHANNEL

public final boolean BLOCKING_MODE_CHANNEL

See Also:

Constant Field Values

Constructor Detail

SubscriptionConfig

public SubscriptionConfig(String subNodeName,
                          String subHome,
                          String subHostPortPair,
                          String feederHostPortPair,
                          String groupName)
                   throws UnknownHostException

Create a subscription configuration

Parameters:

subNodeName - id of the subscription

subHome - home directory of subscriber

subHostPortPair - subscriber host and port

feederHostPortPair - feeder host and port

groupName - name of replication group feeder belong to

Throws:

UnknownHostException

SubscriptionConfig

public SubscriptionConfig(String subNodeName,
                          String subHome,
                          String subHostPortPair,
                          String feederHostPortPair,
                          String groupName,
                          UUID groupUUID)
                   throws UnknownHostException

Create a subscription configuration with group UUID.

Parameters:

subNodeName - id of the subscription

subHome - home directory of subscriber

subHostPortPair - subscriber host and port

feederHostPortPair - feeder host and port

groupName - name of replication group feeder belong to

groupUUID - id of replication group feeder belong to

Throws:

UnknownHostException

SubscriptionConfig

public SubscriptionConfig(String subNodeName,
                          String subHome,
                          String subHostPortPair,
                          String feederHostPortPair,
                          String groupName,
                          UUID groupUUID,
                          NodeType nodeType)
                   throws UnknownHostException

Create a subscription configuration with group UUID.

Parameters:

subNodeName - id of the subscription

subHome - home directory of subscriber

subHostPortPair - subscriber host and port

feederHostPortPair - feeder host and port

groupName - name of replication group feeder belong to

groupUUID - id of replication group feeder belong to

nodeType - type of subscription node

Throws:

UnknownHostException

SubscriptionConfig

public SubscriptionConfig(String subNodeName,
                          String subHome,
                          String subHostPortPair,
                          String feederHostPortPair,
                          String groupName,
                          UUID groupUUID,
                          NodeType nodeType,
                          SubscriptionAuthHandler authenticator)
                   throws UnknownHostException

Create a subscription configuration with group UUID.

Parameters:

subNodeName - id of the subscription

subHome - home directory of subscriber

subHostPortPair - subscriber host and port

feederHostPortPair - feeder host and port

groupName - name of replication group feeder belong to

groupUUID - id of replication group feeder belong to

nodeType - type of subscription node

authenticator - the stream authentication handler or null

Throws:

UnknownHostException

SubscriptionConfig

public SubscriptionConfig(String subNodeName,
                          String subHome,
                          String subHostPortPair,
                          String feederHostPortPair,
                          String groupName,
                          UUID groupUUID,
                          NodeType nodeType,
                          SubscriptionAuthHandler authenticator,
                          Properties props)
                   throws UnknownHostException

Create a subscription configuration with group UUID.

Parameters:

subNodeName - id of the subscription

subHome - home directory of subscriber

subHostPortPair - subscriber host and port

feederHostPortPair - feeder host and port

groupName - name of replication group feeder belong to

groupUUID - id of replication group feeder belong to

nodeType - type of subscription node

authenticator - the stream authentication handler or null

props - connection parameters

Throws:

UnknownHostException

Method Detail

createEnvConfig

public EnvironmentConfig createEnvConfig()

Create an environment configuration for subscription

Returns:

an environment configuration

getFeederFilter

public FeederFilter getFeederFilter()

getAuthenticator

public SubscriptionAuthHandler getAuthenticator()

getCallBack

public SubscriptionCallback getCallBack()

getSubscriberHome

public String getSubscriberHome()

getFeederHost

public String getFeederHost()

getFeederPort

public int getFeederPort()

getFeederHostAddr

public InetAddress getFeederHostAddr()
                              throws UnknownHostException

Throws:

UnknownHostException

getSubNodeName

public String getSubNodeName()

getSubNodeHostPort

public String getSubNodeHostPort()

getGroupName

public String getGroupName()

getGroupUUID

public UUID getGroupUUID()

getMaxConnectRetries

public int getMaxConnectRetries()

getSleepBeforeRetryMs

public long getSleepBeforeRetryMs()

getChannelTimeout

public long getChannelTimeout(TimeUnit unit)

getPollIntervalMs

public long getPollIntervalMs()

getPollTimeoutMs

public long getPollTimeoutMs()

getPreHeartbeatTimeout

public long getPreHeartbeatTimeout(TimeUnit unit)

getStreamOpenTimeout

public long getStreamOpenTimeout(TimeUnit unit)

getHeartbeatIntervalMs

public int getHeartbeatIntervalMs()

getReceiveBufferSize

public int getReceiveBufferSize()

getInputMessageQueueSize

public int getInputMessageQueueSize()

getOutputMessageQueueSize

public int getOutputMessageQueueSize()

getInetSocketAddress

public InetSocketAddress getInetSocketAddress()
                                       throws UnknownHostException

Throws:

UnknownHostException

getStreamMode

public BaseProtocol.EntryRequestType getStreamMode()

getPartGenDBName

public String getPartGenDBName()

setPartGenDBName

public void setPartGenDBName(String dbName)

setMinProtocolVersion

public void setMinProtocolVersion(int ver)

setGroupUUID

public void setGroupUUID(UUID gID)

setCallback

public void setCallback(SubscriptionCallback cbk)

setChannelTimeout

public void setChannelTimeout(long timeout,
                              TimeUnit unit)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

setPreHeartbeatTimeout

public void setPreHeartbeatTimeout(long timeout,
                                   TimeUnit unit)
                            throws IllegalArgumentException

Throws:

IllegalArgumentException

setHeartbeatInterval

public void setHeartbeatInterval(int ms)
                          throws IllegalArgumentException

Throws:

IllegalArgumentException

setStreamOpenTimeout

public void setStreamOpenTimeout(long timeout,
                                 TimeUnit unit)
                          throws IllegalArgumentException

Throws:

IllegalArgumentException

setReceiveBufferSize

public void setReceiveBufferSize(int val)

setInputMessageQueueSize

public void setInputMessageQueueSize(int size)

setOutputMessageQueueSize

public void setOutputMessageQueueSize(int size)

getNodeType

public NodeType getNodeType()

getMinProtocolVersion

public int getMinProtocolVersion()

clone

public SubscriptionConfig clone()

Overrides:

clone in class Object

setFeederFilter

public void setFeederFilter(FeederFilter filter)

Set the feeder filter which will be transmitted to Feeder.

Parameters:

filter - the non-null feeder filter

setStreamMode

public void setStreamMode(BaseProtocol.EntryRequestType type)

toString

public String toString()

Overrides:

toString in class Object