AbstractDestinationDescriptor (FFMQ Core 4.0.9 API)

java.lang.Object
- net.timewalker.ffmq4.utils.descriptor.AbstractDescriptor
- - net.timewalker.ffmq4.utils.descriptor.AbstractSettingsBasedDescriptor
  - - net.timewalker.ffmq4.management.destination.AbstractDestinationDescriptor

All Implemented Interfaces:

DestinationDescriptorMBean, Checkable

Direct Known Subclasses:

AbstractDestinationDefinition, AbstractDestinationTemplate
```
public abstract class AbstractDestinationDescriptor
extends AbstractSettingsBasedDescriptor
implements DestinationDescriptorMBean
```
Base implementation for a destination descriptor.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`autoExtendAmount`
`protected int`	`blockSize`
`protected File`	`dataFolder`
`protected int`	`initialBlockCount`
`protected File`	`journalFolder`
`protected int`	`journalOutputBuffer`
`protected int`	`maxBlockCount`
`protected long`	`maxJournalSize`
`protected int`	`maxNonPersistentMessages`
`protected int`	`maxUncommittedStoreSize`
`protected int`	`maxUnflushedJournalSize`
`protected int`	`maxWriteBatchSize`
`protected String`	`name`
`protected boolean`	`overflowToPersistent`
`protected boolean`	`preAllocateFiles`
`protected String`	`rawDataFolder`
`protected String`	`rawJournalFolder`
`protected int`	`storageSyncMethod`
`protected boolean`	`temporary`
`protected boolean`	`useJournal`

Constructor Summary

Constructors
Constructor and Description

AbstractDestinationDescriptor()
Constructor

AbstractDestinationDescriptor(Settings settings)
Constructor

Constructors
Constructor and Description
`AbstractDestinationDescriptor()` Constructor
`AbstractDestinationDescriptor(Settings settings)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Settings`	`asSettings()` Serialize the definition to settings
`void`	`check()` Check the object consistency
`protected void`	`copyAttributesTo(AbstractDestinationDefinition target)`
`protected void`	`fillSettings(Settings settings)` Append nodes to the XML definition
`int`	`getAutoExtendAmount()`
`int`	`getBlockSize()`
`File`	`getDataFolder()`
`int`	`getInitialBlockCount()`
`File`	`getJournalFolder()`
`int`	`getJournalOutputBuffer()`
`int`	`getMaxBlockCount()`
`long`	`getMaxJournalSize()`
`int`	`getMaxNonPersistentMessages()`
`int`	`getMaxUncommittedStoreSize()`
`int`	`getMaxUnflushedJournalSize()`
`int`	`getMaxWriteBatchSize()`
`String`	`getName()` Get the destination name
`String`	`getRawDataFolder()`
`String`	`getRawJournalFolder()`
`int`	`getStorageSyncMethod()`
`boolean`	`hasPersistentStore()`
`protected void`	`initFromSettings(Settings settings)` Initialize descriptor fields from the given settings
`boolean`	`isOverflowToPersistent()`
`boolean`	`isPreAllocateFiles()`
`boolean`	`isTemporary()`
`boolean`	`isUseJournal()`
`void`	`setAutoExtendAmount(int autoExtendAmount)`
`void`	`setBlockSize(int blockSize)`
`void`	`setDataFolder(File dataFolder)`
`void`	`setInitialBlockCount(int initialBlockCount)`
`void`	`setJournalFolder(File journalFolder)`
`void`	`setJournalOutputBuffer(int journalOutputBuffer)`
`void`	`setMaxBlockCount(int maxBlockCount)`
`void`	`setMaxJournalSize(long maxJournalSize)`
`void`	`setMaxNonPersistentMessages(int maxNonPersistentMessages)`
`void`	`setMaxUncommittedStoreSize(int maxUncommittedStoreSize)`
`void`	`setMaxUnflushedJournalSize(int maxUnflushedJournalSize)`
`void`	`setMaxWriteBatchSize(int maxWriteBatchSize)`
`void`	`setName(String name)`
`void`	`setOverflowToPersistent(boolean overflowToPersistent)`
`void`	`setPreAllocateFiles(boolean preAllocateFiles)`
`void`	`setRawDataFolder(String rawDataFolder)`
`void`	`setRawJournalFolder(String rawJournalFolder)`
`void`	`setStorageSyncMethod(int storageSyncMethod)`
`void`	`setTemporary(boolean temporary)`
`void`	`setUseJournal(boolean useJournal)`
`String`	`toString()`

Methods inherited from class net.timewalker.ffmq4.utils.descriptor.AbstractDescriptor
getDescriptorFile, setDescriptorFile

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

- Field Detail
  - name
```
protected String name
```
  - initialBlockCount
```
protected int initialBlockCount
```
  - maxBlockCount
```
protected int maxBlockCount
```
  - autoExtendAmount
```
protected int autoExtendAmount
```
  - blockSize
```
protected int blockSize
```
  - rawDataFolder
```
protected String rawDataFolder
```
  - dataFolder
```
protected File dataFolder
```
  - maxNonPersistentMessages
```
protected int maxNonPersistentMessages
```
  - useJournal
```
protected boolean useJournal
```
  - rawJournalFolder
```
protected String rawJournalFolder
```
  - journalFolder
```
protected File journalFolder
```
  - maxJournalSize
```
protected long maxJournalSize
```
  - maxWriteBatchSize
```
protected int maxWriteBatchSize
```
  - maxUnflushedJournalSize
```
protected int maxUnflushedJournalSize
```
  - maxUncommittedStoreSize
```
protected int maxUncommittedStoreSize
```
  - journalOutputBuffer
```
protected int journalOutputBuffer
```
  - temporary
```
protected boolean temporary
```
  - storageSyncMethod
```
protected int storageSyncMethod
```
  - preAllocateFiles
```
protected boolean preAllocateFiles
```
  - overflowToPersistent
```
protected boolean overflowToPersistent
```
- Constructor Detail
  - AbstractDestinationDescriptor
```
public AbstractDestinationDescriptor()
```
    Constructor
  - AbstractDestinationDescriptor
```
public AbstractDestinationDescriptor(Settings settings)
```
    Constructor
- Method Detail
  - initFromSettings
```
protected void initFromSettings(Settings settings)
```
    Description copied from class: AbstractSettingsBasedDescriptor
    
    Initialize descriptor fields from the given settings
    
    Specified by:
    
    initFromSettings in class AbstractSettingsBasedDescriptor
    
    Parameters:
    
    settings - some settings
  - copyAttributesTo
```
protected void copyAttributesTo(AbstractDestinationDefinition target)
```
  - asSettings
```
public final Settings asSettings()
```
    Serialize the definition to settings
  - fillSettings
```
protected void fillSettings(Settings settings)
```
    Append nodes to the XML definition
  - getName
```
public String getName()
```
    Description copied from interface: DestinationDescriptorMBean
    
    Get the destination name
    
    Specified by:
    
    getName in interface DestinationDescriptorMBean
  - isTemporary
```
public boolean isTemporary()
```
    Specified by:
    
    isTemporary in interface DestinationDescriptorMBean
  - getDataFolder
```
public File getDataFolder()
```
  - getMaxNonPersistentMessages
```
public int getMaxNonPersistentMessages()
```
    Specified by:
    
    getMaxNonPersistentMessages in interface DestinationDescriptorMBean
  - isUseJournal
```
public boolean isUseJournal()
```
    Specified by:
    
    isUseJournal in interface DestinationDescriptorMBean
    
    Returns:
    
    useJournal
  - getInitialBlockCount
```
public int getInitialBlockCount()
```
    Specified by:
    
    getInitialBlockCount in interface DestinationDescriptorMBean
  - getBlockSize
```
public int getBlockSize()
```
    Specified by:
    
    getBlockSize in interface DestinationDescriptorMBean
  - setInitialBlockCount
```
public void setInitialBlockCount(int initialBlockCount)
```
    Parameters:
    
    initialBlockCount - the initial blockCount to set
  - setMaxBlockCount
```
public void setMaxBlockCount(int maxBlockCount)
```
    Parameters:
    
    maxBlockCount - the maxBlockCount to set
  - getMaxBlockCount
```
public int getMaxBlockCount()
```
    Specified by:
    
    getMaxBlockCount in interface DestinationDescriptorMBean
    
    Returns:
    
    the maxBlockCount
  - setAutoExtendAmount
```
public void setAutoExtendAmount(int autoExtendAmount)
```
    Parameters:
    
    autoExtendAmount - the autoExtendAmount to set
  - getAutoExtendAmount
```
public int getAutoExtendAmount()
```
    Specified by:
    
    getAutoExtendAmount in interface DestinationDescriptorMBean
    
    Returns:
    
    the autoExtendAmount
  - setBlockSize
```
public void setBlockSize(int blockSize)
```
    Parameters:
    
    blockSize - the blockSize to set
  - getRawDataFolder
```
public String getRawDataFolder()
```
    Returns:
    
    the rawDataFolder
  - setRawDataFolder
```
public void setRawDataFolder(String rawDataFolder)
```
    Parameters:
    
    rawDataFolder - the rawDataFolder to set
  - setDataFolder
```
public void setDataFolder(File dataFolder)
```
    Parameters:
    
    dataFolder - the dataFolder to set
  - setUseJournal
```
public void setUseJournal(boolean useJournal)
```
    Parameters:
    
    useJournal - the useJournal to set
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - the name to set
  - setMaxNonPersistentMessages
```
public void setMaxNonPersistentMessages(int maxNonPersistentMessages)
```
    Parameters:
    
    maxNonPersistentMessages - the maxNonPersistentMessages to set
  - setTemporary
```
public void setTemporary(boolean temporary)
```
    Parameters:
    
    temporary - the temporary to set
  - getRawJournalFolder
```
public String getRawJournalFolder()
```
    Returns:
    
    the rawJournalFolder
  - setRawJournalFolder
```
public void setRawJournalFolder(String rawJournalFolder)
```
    Parameters:
    
    rawJournalFolder - the rawJournalFolder to set
  - getJournalFolder
```
public File getJournalFolder()
```
    Returns:
    
    the journalFolder
  - setJournalFolder
```
public void setJournalFolder(File journalFolder)
```
    Parameters:
    
    journalFolder - the journalFolder to set
  - getMaxJournalSize
```
public long getMaxJournalSize()
```
    Specified by:
    
    getMaxJournalSize in interface DestinationDescriptorMBean
    
    Returns:
    
    the maxJournalSize
  - setMaxJournalSize
```
public void setMaxJournalSize(long maxJournalSize)
```
    Parameters:
    
    maxJournalSize - the maxJournalSize to set
  - getMaxWriteBatchSize
```
public int getMaxWriteBatchSize()
```
    Specified by:
    
    getMaxWriteBatchSize in interface DestinationDescriptorMBean
    
    Returns:
    
    the maxWriteBatchSize
  - setMaxWriteBatchSize
```
public void setMaxWriteBatchSize(int maxWriteBatchSize)
```
    Parameters:
    
    maxWriteBatchSize - the maxWriteBatchSize to set
  - getMaxUnflushedJournalSize
```
public int getMaxUnflushedJournalSize()
```
    Specified by:
    
    getMaxUnflushedJournalSize in interface DestinationDescriptorMBean
    
    Returns:
    
    the maxUnflushedJournalSize
  - setMaxUnflushedJournalSize
```
public void setMaxUnflushedJournalSize(int maxUnflushedJournalSize)
```
    Parameters:
    
    maxUnflushedJournalSize - the maxUnflushedJournalSize to set
  - getMaxUncommittedStoreSize
```
public int getMaxUncommittedStoreSize()
```
    Specified by:
    
    getMaxUncommittedStoreSize in interface DestinationDescriptorMBean
    
    Returns:
    
    the maxUncommittedStoreSize
  - setMaxUncommittedStoreSize
```
public void setMaxUncommittedStoreSize(int maxUncommittedStoreSize)
```
    Parameters:
    
    maxUncommittedStoreSize - the maxUncommittedStoreSize to set
  - getJournalOutputBuffer
```
public int getJournalOutputBuffer()
```
    Specified by:
    
    getJournalOutputBuffer in interface DestinationDescriptorMBean
    
    Returns:
    
    the journalOutputBuffer
  - setJournalOutputBuffer
```
public void setJournalOutputBuffer(int journalOutputBuffer)
```
    Parameters:
    
    journalOutputBuffer - the journalOutputBuffer to set
  - getStorageSyncMethod
```
public int getStorageSyncMethod()
```
    Specified by:
    
    getStorageSyncMethod in interface DestinationDescriptorMBean
    
    Returns:
    
    the storageSyncMethod
  - setStorageSyncMethod
```
public void setStorageSyncMethod(int storageSyncMethod)
```
    Parameters:
    
    storageSyncMethod - the syncMethod to set
  - isPreAllocateFiles
```
public boolean isPreAllocateFiles()
```
    Specified by:
    
    isPreAllocateFiles in interface DestinationDescriptorMBean
    
    Returns:
    
    the preAllocateFiles
  - setPreAllocateFiles
```
public void setPreAllocateFiles(boolean preAllocateFiles)
```
    Parameters:
    
    preAllocateFiles - the preAllocateFiles to set
  - isOverflowToPersistent
```
public boolean isOverflowToPersistent()
```
    Returns:
    
    the overflowToPersistent
  - setOverflowToPersistent
```
public void setOverflowToPersistent(boolean overflowToPersistent)
```
    Parameters:
    
    overflowToPersistent - the overflowToPersistent to set
  - check
```
public void check()
           throws javax.jms.JMSException
```
    Description copied from interface: Checkable
    
    Check the object consistency
    
    Specified by:
    
    check in interface Checkable
    
    Throws:
    
    javax.jms.JMSException
  - hasPersistentStore
```
public boolean hasPersistentStore()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractDestinationDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.timewalker.ffmq4.utils.descriptor.AbstractDescriptor

Methods inherited from class java.lang.Object

Field Detail

name

initialBlockCount

maxBlockCount

autoExtendAmount

blockSize

rawDataFolder

dataFolder

maxNonPersistentMessages

useJournal

rawJournalFolder

journalFolder

maxJournalSize

maxWriteBatchSize

maxUnflushedJournalSize

maxUncommittedStoreSize

journalOutputBuffer

temporary

storageSyncMethod

preAllocateFiles

overflowToPersistent

Constructor Detail

AbstractDestinationDescriptor

AbstractDestinationDescriptor

Method Detail

initFromSettings

copyAttributesTo

asSettings

fillSettings

getName

isTemporary

getDataFolder

getMaxNonPersistentMessages

isUseJournal

getInitialBlockCount

getBlockSize

setInitialBlockCount

setMaxBlockCount

getMaxBlockCount

setAutoExtendAmount

getAutoExtendAmount

setBlockSize

getRawDataFolder

setRawDataFolder

setDataFolder

setUseJournal

setName

setMaxNonPersistentMessages

setTemporary

getRawJournalFolder

setRawJournalFolder

getJournalFolder

setJournalFolder

getMaxJournalSize

setMaxJournalSize

getMaxWriteBatchSize

setMaxWriteBatchSize

getMaxUnflushedJournalSize

setMaxUnflushedJournalSize

getMaxUncommittedStoreSize

setMaxUncommittedStoreSize

getJournalOutputBuffer

setJournalOutputBuffer

getStorageSyncMethod

setStorageSyncMethod

isPreAllocateFiles

setPreAllocateFiles

isOverflowToPersistent

setOverflowToPersistent

check

hasPersistentStore

toString