com.gemstone.gemfire.cache

Class DynamicRegionFactory.Config

java.lang.Object

com.gemstone.gemfire.cache.DynamicRegionFactory.Config

Enclosing class:

DynamicRegionFactory

public static class DynamicRegionFactory.Config
extends Object

Configuration for dynamic region factory. The default attributes are:

• diskDir: null
• bridgeWriter: null
• persistBackup: true
• registerInterest: true

Since:

4.3

Field Summary

Fields

Modifier and Type	Field and Description
BridgeWriter	bridgeWriter The BridgeWriter to be used by the factory to communicate with the factory in its server.
File	diskDir The directory where the factory's persistBackup files are placed
boolean	persistBackup Causes the factory to be persisted on disk.
String	poolName The ${link Pool} to be used by the factory to communicate with the server-side factory.
boolean	registerInterest Causes regions created by the factory to register interest in all keys in a corresponding server cache region

Constructor Summary

Constructors

Constructor and Description
DynamicRegionFactory.Config() Creates a configuration with the default attributes.
DynamicRegionFactory.Config(File diskDir, BridgeWriter bridgeWriter) Deprecated. use a pool name instead of a bridge writer
DynamicRegionFactory.Config(File diskDir, BridgeWriter bridgeWriter, boolean persistBackup) Deprecated. use a pool name instead of a bridge writer
DynamicRegionFactory.Config(File diskDir, BridgeWriter bridgeWriter, boolean persistBackup, boolean registerInterest) Deprecated. use a pool name instead of a bridge writer
DynamicRegionFactory.Config(File diskDir, String poolName, boolean persistBackup, boolean registerInterest) Creates a configuration with the given attributes

Method Summary

Methods

Modifier and Type	Method and Description
BridgeWriter	getBridgeWriter() Returns the BridgeWriter associated with the dynamic region factory.
File	getDiskDir() Returns the disk directory that the dynamic region factory data will be written to.
boolean	getPersistBackup() Returns true if the factory is persisted to disk; false if not.
String	getPoolName() Returns the name of the Pool associated with the dynamic region factory.
boolean	getRegisterInterest() Returns true if the region will register interest in all keys of a corresponding server cache region

Methods inherited from class java.lang.Object

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

Field Detail

persistBackup

public final boolean persistBackup

Causes the factory to be persisted on disk. See diskDir

diskDir

public final File diskDir

The directory where the factory's persistBackup files are placed

registerInterest

public final boolean registerInterest

Causes regions created by the factory to register interest in all keys in a corresponding server cache region

bridgeWriter

public final BridgeWriter bridgeWriter

The BridgeWriter to be used by the factory to communicate with the factory in its server. Client factories must configure a BridgeWriter for their factory and it must be configured to establish a callback connection.

poolName

public final String poolName

The ${link Pool} to be used by the factory to communicate with the server-side factory. Client factories may use this instead of a BridgeWriter

Constructor Detail

DynamicRegionFactory.Config

public DynamicRegionFactory.Config()

Creates a configuration with the default attributes.

DynamicRegionFactory.Config

@Deprecated
public DynamicRegionFactory.Config(File diskDir,
                                      BridgeWriter bridgeWriter)

Deprecated. use a pool name instead of a bridge writer

Creates a configuration with the given attributes and defaults for other attributes.

DynamicRegionFactory.Config

@Deprecated
public DynamicRegionFactory.Config(File diskDir,
                                      BridgeWriter bridgeWriter,
                                      boolean persistBackup)

Deprecated. use a pool name instead of a bridge writer

Creates a configuration with the given attributes and defaults for other attributes.

DynamicRegionFactory.Config

@Deprecated
public DynamicRegionFactory.Config(File diskDir,
                                      BridgeWriter bridgeWriter,
                                      boolean persistBackup,
                                      boolean registerInterest)

Deprecated. use a pool name instead of a bridge writer

Creates a configuration with the given attributes

DynamicRegionFactory.Config

public DynamicRegionFactory.Config(File diskDir,
                           String poolName,
                           boolean persistBackup,
                           boolean registerInterest)

Creates a configuration with the given attributes

Method Detail

getPersistBackup

public boolean getPersistBackup()

Returns true if the factory is persisted to disk; false if not.

getRegisterInterest

public boolean getRegisterInterest()

Returns true if the region will register interest in all keys of a corresponding server cache region

getDiskDir

public File getDiskDir()

Returns the disk directory that the dynamic region factory data will be written to. Returns null if no directory has been specified. The diskDir is only used if persistBackup is true.

getBridgeWriter

public BridgeWriter getBridgeWriter()

Returns the BridgeWriter associated with the dynamic region factory. Returns null if there is no cache writer for dynamic regions. A cache writer will only exist if this is a client and the cache writer connects to a server.

getPoolName

public String getPoolName()

Returns the name of the Pool associated with the dynamic region factory. Returns null if there is no connection pool for dynamic regions.