GemFireDescription (GemFire XD Java API Documentation)

java.lang.Object
- hydra.AbstractDescription
- - hydra.GemFireDescription

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FakeDescription
```
public class GemFireDescription
extends AbstractDescription
implements Serializable
```
Encodes information needed to manage a GemFire system.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GemFireDescription()

Constructors
Constructor and Description
`GemFireDescription()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`configure(TestConfig config)` Creates gemfire descriptions from the gemfire parameters in the test configuration.
`Integer`	`getAckSevereAlertThreshold()`
`Integer`	`getAckWaitThreshold()`
`Integer`	`getArchiveDiskSpaceLimit()`
`Integer`	`getArchiveFileSizeLimit()`
`Integer`	`getAsyncDistributionTimeout()`
`Integer`	`getAsyncMaxQueueSize()`
`Integer`	`getAsyncQueueTimeout()`
`Boolean`	`getConserveSockets()`
`Boolean`	`getDeltaPropagation()`
`Boolean`	`getDisableAutoReconnect()`
`Boolean`	`getDisableTcp()`
`String`	`getDistributedSystem()`
`Integer`	`getDistributedSystemId()`
`Properties`	`getDistributedSystemProperties()` Generates and returns the distributed system properties for this gemfire description, including security and SSL and JMX manager properties, if any.
`Integer`	`getDurableClientTimeout()`
`Boolean`	`getEnableDurableClient()`
`Boolean`	`getEnableMcast()`
`Boolean`	`getEnableNetworkPartitionDetection()`
`Boolean`	`getEnableTimeStatistics()`
`Boolean`	`getEnforceUniqueHost()` Returns the enforce unique host
`String`	`getExtraLocatorVMArgs()`
`HostDescription`	`getHostDescription()`
`Boolean`	`getJMXManager()` Returns the JMX manager.
`String`	`getJMXManagerAccessFile()` Returns the JMX manager access file.
`protected Boolean`	`getJMXManagerHttpPort()` Returns the JMX manager http port.
`String`	`getJMXManagerPasswordFile()` Returns the JMX manager password file.
`protected Boolean`	`getJMXManagerPort()` Returns the JMX manager port.
`protected Boolean`	`getJMXManagerSSL()` Returns the JMX manager SSL.
`Boolean`	`getJMXManagerStart()` Returns the JMX manager start.
`String`	`getLocatorClassPath()`
`Boolean`	`getLockMemory()`
`Integer`	`getLogDiskSpaceLimit()`
`protected String`	`getLogFileName()` For internal hydra use only.
`Integer`	`getLogFileSizeLimit()`
`String`	`getLogLevel()`
`Integer`	`getMaxNumReconnectTries()`
`String`	`getMcastAddress()`
`Integer`	`getMcastFlowControlByteAllowance()`
`Integer`	`getMcastFlowControlRechargeBlockMs()`
`Float`	`getMcastFlowControlRechargeThreshold()`
`Integer`	`getMcastPort()`
`Integer`	`getMcastRecvBufferSize()`
`Integer`	`getMcastSendBufferSize()`
`Integer`	`getMcastTtl()`
`String`	`getMembershipPortRange()`
`Integer`	`getMemberTimeout()`
`String`	`getName()`
`String`	`getOffHeapMemorySize()` Returns off-heap memory size.
`String`	`getRedundancyZone()` Returns the redundancy zone
`List<String>`	`getRemoteDistributedSystems()`
`String`	`getRoles()` Returns the role names for this GemFire system.
`SecurityDescription`	`getSecurityDescription()` Returns the security description.
`String`	`getSecurityName()` Returns the security name.
`Long`	`getSocketBufferSize()`
`Long`	`getSocketLeaseTime()`
`SSLDescription`	`getSSLDescription()` Returns the SSL description.
`String`	`getSSLName()` Returns the SSL name.
`String`	`getStatisticArchiveFile()`
`Integer`	`getStatisticSampleRate()`
`Boolean`	`getStatisticSamplingEnabled()`
`String`	`getSysDirName()` For internal hydra use only.
`File`	`getSystemDirectory()`
`String`	`getSystemDirectoryStr()`
`Integer`	`getTcpPort()`
`Integer`	`getUdpFragmentSize()`
`Integer`	`getUdpRecvBufferSize()`
`Integer`	`getUdpSendBufferSize()`
`Boolean`	`getUseLocator()`
`Boolean`	`isPeerLocator()`
`Boolean`	`isServerLocator()`
`protected void`	`setMcastPort(Integer port)`
`protected void`	`setMembershipPortRange(String range)`
`protected void`	`setTcpPort(Integer port)`
`boolean`	`stopSystemAfterTest()`
`SortedMap`	`toSortedMap()` Returns a sorted map of description fields and their values.

Methods inherited from class hydra.AbstractDescription
addProperties, asList, convertPrm, convertPrmDefault, getBooleanFor, getClass, getClassname, getInstance, getIntegerFor, getNonnegativeIntegerFor, getParametersAndDefaults, getPath, getSSLDescription, loadClass, parseMethod, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- GemFireDescription
```
public GemFireDescription()
```

Method Detail

getName
```
public String getName()
```

getHostDescription

public HostDescription getHostDescription()

stopSystemAfterTest
```
public boolean stopSystemAfterTest()
```

getDistributedSystem
```
public String getDistributedSystem()
```

getRemoteDistributedSystems

public List<String> getRemoteDistributedSystems()

getDistributedSystemId

public Integer getDistributedSystemId()

getSystemDirectoryStr
```
public String getSystemDirectoryStr()
```

getSystemDirectory
```
public File getSystemDirectory()
```

getAckWaitThreshold
```
public Integer getAckWaitThreshold()
```

getLogLevel
```
public String getLogLevel()
```

getLogFileSizeLimit
```
public Integer getLogFileSizeLimit()
```

getLogDiskSpaceLimit
```
public Integer getLogDiskSpaceLimit()
```

getStatisticArchiveFile

public String getStatisticArchiveFile()

getStatisticSamplingEnabled

public Boolean getStatisticSamplingEnabled()

getStatisticSampleRate

public Integer getStatisticSampleRate()

getEnableTimeStatistics

public Boolean getEnableTimeStatistics()

getArchiveFileSizeLimit

public Integer getArchiveFileSizeLimit()

getArchiveDiskSpaceLimit

public Integer getArchiveDiskSpaceLimit()

getUseLocator
```
public Boolean getUseLocator()
```

isPeerLocator
```
public Boolean isPeerLocator()
```

isServerLocator
```
public Boolean isServerLocator()
```

getEnableMcast
```
public Boolean getEnableMcast()
```

getMcastAddress
```
public String getMcastAddress()
```

getMcastPort
```
public Integer getMcastPort()
```

setMcastPort

protected void setMcastPort(Integer port)

getMcastTtl
```
public Integer getMcastTtl()
```

getMcastSendBufferSize

public Integer getMcastSendBufferSize()

getMcastRecvBufferSize

public Integer getMcastRecvBufferSize()

getMcastFlowControlByteAllowance

public Integer getMcastFlowControlByteAllowance()

getMcastFlowControlRechargeThreshold

public Float getMcastFlowControlRechargeThreshold()

getMcastFlowControlRechargeBlockMs

public Integer getMcastFlowControlRechargeBlockMs()

getUdpFragmentSize
```
public Integer getUdpFragmentSize()
```

getUdpSendBufferSize
```
public Integer getUdpSendBufferSize()
```

getUdpRecvBufferSize
```
public Integer getUdpRecvBufferSize()
```

getTcpPort
```
public Integer getTcpPort()
```

setTcpPort

protected void setTcpPort(Integer port)

getDisableTcp
```
public Boolean getDisableTcp()
```

getMembershipPortRange

public String getMembershipPortRange()

setMembershipPortRange

protected void setMembershipPortRange(String range)

getMemberTimeout
```
public Integer getMemberTimeout()
```

getLocatorClassPath
```
public String getLocatorClassPath()
```

getExtraLocatorVMArgs
```
public String getExtraLocatorVMArgs()
```

getEnableDurableClient

public Boolean getEnableDurableClient()

getDurableClientTimeout

public Integer getDurableClientTimeout()

getAckSevereAlertThreshold

public Integer getAckSevereAlertThreshold()

getEnableNetworkPartitionDetection

public Boolean getEnableNetworkPartitionDetection()

getDisableAutoReconnect

public Boolean getDisableAutoReconnect()

getRoles
```
public String getRoles()
```
Returns the role names for this GemFire system.

Since:

5.0

getMaxNumReconnectTries

public Integer getMaxNumReconnectTries()

getConserveSockets
```
public Boolean getConserveSockets()
```

getDeltaPropagation
```
public Boolean getDeltaPropagation()
```

getSocketLeaseTime
```
public Long getSocketLeaseTime()
```

getSocketBufferSize
```
public Long getSocketBufferSize()
```

getAsyncDistributionTimeout

public Integer getAsyncDistributionTimeout()

getAsyncQueueTimeout
```
public Integer getAsyncQueueTimeout()
```

getAsyncMaxQueueSize
```
public Integer getAsyncMaxQueueSize()
```

getEnforceUniqueHost
```
public Boolean getEnforceUniqueHost()
```
Returns the enforce unique host

getRedundancyZone
```
public String getRedundancyZone()
```
Returns the redundancy zone

getJMXManager
```
public Boolean getJMXManager()
```
Returns the JMX manager.

getJMXManagerAccessFile
```
public String getJMXManagerAccessFile()
```
Returns the JMX manager access file.

getJMXManagerHttpPort
```
protected Boolean getJMXManagerHttpPort()
```
Returns the JMX manager http port.

getJMXManagerPasswordFile
```
public String getJMXManagerPasswordFile()
```
Returns the JMX manager password file.

getJMXManagerPort
```
protected Boolean getJMXManagerPort()
```
Returns the JMX manager port.

getJMXManagerSSL
```
protected Boolean getJMXManagerSSL()
```
Returns the JMX manager SSL.

getJMXManagerStart
```
public Boolean getJMXManagerStart()
```
Returns the JMX manager start.

getSecurityName
```
public String getSecurityName()
```
Returns the security name.

getSecurityDescription

public SecurityDescription getSecurityDescription()

Returns the security description.

getSSLName
```
public String getSSLName()
```
Returns the SSL name.

getSSLDescription

public SSLDescription getSSLDescription()

Returns the SSL description.

getOffHeapMemorySize
```
public String getOffHeapMemorySize()
```
Returns off-heap memory size.

getLockMemory
```
public Boolean getLockMemory()
```

getSysDirName
```
public String getSysDirName()
```
For internal hydra use only. Hydra client-side method only.
Returns the name of the system directory for this incarnation of the logical vm, and lazily creates and registers it.

getLogFileName
```
protected String getLogFileName()
```
For internal hydra use only. Hydra client-side method only.
Returns the name of the log file in the system directory.

getDistributedSystemProperties
```
public Properties getDistributedSystemProperties()
```
Generates and returns the distributed system properties for this gemfire description, including security and SSL and JMX manager properties, if any.
If SSL is enabled or a JMX manager is enabled with SSL, sets SSL-related properties on the JVM as a side-effect.

toSortedMap
```
public SortedMap toSortedMap()
```
Description copied from class: AbstractDescription

Returns a sorted map of description fields and their values.

Specified by:

toSortedMap in class AbstractDescription

configure
```
protected static void configure(TestConfig config)
```
Creates gemfire descriptions from the gemfire parameters in the test configuration.

Class GemFireDescription

Constructor Summary

Method Summary

Methods inherited from class hydra.AbstractDescription

Methods inherited from class java.lang.Object

Constructor Detail

GemFireDescription

Method Detail

getName

getHostDescription

stopSystemAfterTest

getDistributedSystem

getRemoteDistributedSystems

getDistributedSystemId

getSystemDirectoryStr

getSystemDirectory

getAckWaitThreshold

getLogLevel

getLogFileSizeLimit

getLogDiskSpaceLimit

getStatisticArchiveFile

getStatisticSamplingEnabled

getStatisticSampleRate

getEnableTimeStatistics

getArchiveFileSizeLimit

getArchiveDiskSpaceLimit

getUseLocator

isPeerLocator

isServerLocator

getEnableMcast

getMcastAddress

getMcastPort

setMcastPort

getMcastTtl

getMcastSendBufferSize

getMcastRecvBufferSize

getMcastFlowControlByteAllowance

getMcastFlowControlRechargeThreshold

getMcastFlowControlRechargeBlockMs

getUdpFragmentSize

getUdpSendBufferSize

getUdpRecvBufferSize

getTcpPort

setTcpPort

getDisableTcp

getMembershipPortRange

setMembershipPortRange

getMemberTimeout

getLocatorClassPath

getExtraLocatorVMArgs

getEnableDurableClient

getDurableClientTimeout

getAckSevereAlertThreshold

getEnableNetworkPartitionDetection

getDisableAutoReconnect

getRoles

getMaxNumReconnectTries

getConserveSockets

getDeltaPropagation

getSocketLeaseTime

getSocketBufferSize

getAsyncDistributionTimeout

getAsyncQueueTimeout

getAsyncMaxQueueSize

getEnforceUniqueHost

getRedundancyZone

getJMXManager

getJMXManagerAccessFile

getJMXManagerHttpPort

getJMXManagerPasswordFile

getJMXManagerPort

getJMXManagerSSL

getJMXManagerStart

getSecurityName

getSecurityDescription

getSSLName

getSSLDescription

getOffHeapMemorySize

getLockMemory

getSysDirName