com.sleepycat.je.rep.subscription

Class Subscription

java.lang.Object

com.sleepycat.je.rep.subscription.Subscription

public class Subscription
extends Object

Object to represent a subscription to receive and process replication streams from Feeder. It defines the public subscription APIs which can be called by clients.

Constructor Summary

Constructors

Constructor and Description
Subscription(SubscriptionConfig configuration, Logger logger) Create an instance of subscription from configuration

Method Summary

Modifier and Type	Method and Description
SubscriptionStat	getStatistics() Get subscription statistics
Exception	getStoredException() Retrieves the stored exception from subscription thread
SubscriptionStatus	getSubscriptionStatus() Get subscription thread status, if thread does not exit, return subscription not yet started.
void	shutdown() Shutdown a subscription completely, keep the thread object to keep the state.
void	start() Start subscription main thread, subscribe from the very first VLSN from the feeder.
void	start(VLSN vlsn) Start subscription main thread, subscribe from a specific VLSN from the feeder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Subscription

public Subscription(SubscriptionConfig configuration,
                    Logger logger)
             throws IllegalArgumentException

Create an instance of subscription from configuration

Parameters:

configuration - configuration parameters

logger - logging handler

Throws:

IllegalArgumentException - if env directory does not exist

Method Detail

start

public void start()
           throws IllegalArgumentException,
                  InsufficientLogException,
                  GroupShutdownException,
                  InternalException,
                  TimeoutException

Start subscription main thread, subscribe from the very first VLSN from the feeder. The subscriber will stay alive and consume all entries until it shuts down.

Throws:

InsufficientLogException - if feeder is unable to stream from start VLSN

GroupShutdownException - if subscription receives group shutdown

InternalException - if internal exception

TimeoutException - if subscription initialization timeout

IllegalArgumentException

start

public void start(VLSN vlsn)
           throws IllegalArgumentException,
                  InsufficientLogException,
                  GroupShutdownException,
                  InternalException,
                  TimeoutException,
                  ReplicationSecurityException

Start subscription main thread, subscribe from a specific VLSN from the feeder. The subscriber will stay alive and consume all entries until it shuts down.

Parameters:

vlsn - the start VLSN of subscription. It cannot be NULL_VLSN otherwise an IllegalArgumentException will be raised.

Throws:

InsufficientLogException - if feeder is unable to stream from start VLSN

GroupShutdownException - if subscription receives group shutdown

InternalException - if internal exception

TimeoutException - if subscription initialization timeout

ReplicationSecurityException - if security check fails

IllegalArgumentException

shutdown

public void shutdown()

Shutdown a subscription completely, keep the thread object to keep the state.

getStoredException

public Exception getStoredException()

Retrieves the stored exception from subscription thread

Returns:

the stored exception from subscription thread

getSubscriptionStatus

public SubscriptionStatus getSubscriptionStatus()

Get subscription thread status, if thread does not exit, return subscription not yet started.

Returns:

status of subscription

getStatistics

public SubscriptionStat getStatistics()

Get subscription statistics

Returns:

statistics