AbstractBusPropertiesAccessor (Spring XD 1.3.0.RELEASE API)

java.lang.Object
- org.springframework.xd.dirt.integration.bus.AbstractBusPropertiesAccessor

All Implemented Interfaces:

BusProperties
```
public abstract class AbstractBusPropertiesAccessor
extends java.lang.Object
implements BusProperties
```
Base class for bus-specific property accessors; common properties are defined here.

Author:

Gary Russell

Field Summary
- Fields inherited from interface org.springframework.xd.dirt.integration.bus.BusProperties
  BACK_OFF_INITIAL_INTERVAL, BACK_OFF_MAX_INTERVAL, BACK_OFF_MULTIPLIER, BATCH_BUFFER_LIMIT, BATCH_SIZE, BATCH_TIMEOUT, BATCHING_ENABLED, COMPRESS, CONCURRENCY, COUNT, DIRECT_BINDING_ALLOWED, DURABLE, MAX_ATTEMPTS, MAX_CONCURRENCY, MIN_PARTITION_COUNT, NEXT_MODULE_CONCURRENCY, NEXT_MODULE_COUNT, PARTITION_INDEX, PARTITION_KEY_EXPRESSION, PARTITION_KEY_EXTRACTOR_CLASS, PARTITION_SELECTOR_CLASS, PARTITION_SELECTOR_EXPRESSION, SEQUENCE

Constructor Summary

Constructors
Constructor and Description

AbstractBusPropertiesAccessor(java.util.Properties properties)

Constructors
Constructor and Description
`AbstractBusPropertiesAccessor(java.util.Properties properties)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.lang.String[]`	`asStringArray(java.lang.String value, java.lang.String[] defaultValue)` Convert a comma-delimited String property to a String[] if present, or return the default value.
`long`	`getBackOffInitialInterval(long defaultValue)` Return the 'backOffInitialInterval' property or the default value.
`long`	`getBackOffMaxInterval(long defaultValue)` Return the 'backOffMaxInterval' property or the default value.
`double`	`getBackOffMultiplier(double defaultValue)` Return the 'backOffMultiplier' property or the default value.
`int`	`getBatchSize(int defaultValue)` The batch size.
`long`	`getBatchTimeout(long defaultValue)` The batch timeout.
`int`	`getConcurrency(int defaultValue)` Return the 'concurrency' property or the default value.
`int`	`getCount()` The module count.
`int`	`geteBatchBufferLimit(int defaultValue)` The batch buffer limit.
`int`	`getMaxAttempts(int defaultValue)` Return the 'maxAttempts' property or the default value.
`int`	`getMaxConcurrency(int defaultValue)` Return the 'maxConcurrency' property or the default value.
`int`	`getNextModuleCount()` The next module count for non-sink modules
`int`	`getPartitionIndex()` The partition index that this consumer supports.
`org.springframework.expression.Expression`	`getPartitionKeyExpression()` The expression to determine the partition key, evaluated against the message as the root object.
`java.lang.String`	`getPartitionKeyExtractorClass()` A class name for extracting partition keys from messages.
`java.lang.String`	`getPartitionSelectorClass()` A class name for calculating a partition from a key.
`org.springframework.expression.Expression`	`getPartitionSelectorExpression()` The expression evaluated against the partition key to determine the partition to which the message will be sent.
`java.util.Properties`	`getProperties()` Return the underlying properties object.
`java.lang.String`	`getProperty(java.lang.String key)` Return the property for the key, or null if it doesn't exist.
`boolean`	`getProperty(java.lang.String key, boolean defaultValue)` Return the property for the key, or the default value if the property doesn't exist.
`double`	`getProperty(java.lang.String key, double defaultValue)` Return the property for the key, or the default value if the property doesn't exist.
`int`	`getProperty(java.lang.String key, int defaultValue)` Return the property for the key, or the default value if the property doesn't exist.
`long`	`getProperty(java.lang.String key, long defaultValue)` Return the property for the key, or the default value if the property doesn't exist.
`java.lang.String`	`getProperty(java.lang.String key, java.lang.String defaultValue)` Return the property for the key, or the default value if the property doesn't exist.
`int`	`getSequence()` The sequence number for this module.
`boolean`	`isBatchingEnabled(boolean defaultValue)` If true, enable batching.
`boolean`	`isCompress(boolean defaultValue)` If true, messages will be compressed.
`boolean`	`isDirectBindingAllowed()` If true, the bus can attempt a direct binding.
`boolean`	`isDurable(boolean defaultValue)` If true, subscriptions to taps/topics will be durable.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - AbstractBusPropertiesAccessor
```
public AbstractBusPropertiesAccessor(java.util.Properties properties)
```
- Method Detail
  - getProperties
```
public java.util.Properties getProperties()
```
    Return the underlying properties object.
    
    Returns:
    The properties.
  - getProperty
```
public java.lang.String getProperty(java.lang.String key)
```
    Return the property for the key, or null if it doesn't exist.
    
    Parameters:
    key - The property.
    
    Returns:
    The key.
  - getProperty
```
public java.lang.String getProperty(java.lang.String key,
                           java.lang.String defaultValue)
```
    Return the property for the key, or the default value if the property doesn't exist.
    
    Parameters:
    key - The key.
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getProperty
```
public boolean getProperty(java.lang.String key,
                  boolean defaultValue)
```
    Return the property for the key, or the default value if the property doesn't exist.
    
    Parameters:
    key - The key.
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getProperty
```
public int getProperty(java.lang.String key,
              int defaultValue)
```
    Return the property for the key, or the default value if the property doesn't exist.
    
    Parameters:
    key - The key.
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getProperty
```
public long getProperty(java.lang.String key,
               long defaultValue)
```
    Return the property for the key, or the default value if the property doesn't exist.
    
    Parameters:
    key - The key.
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getProperty
```
public double getProperty(java.lang.String key,
                 double defaultValue)
```
    Return the property for the key, or the default value if the property doesn't exist.
    
    Parameters:
    key - The key.
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getConcurrency
```
public int getConcurrency(int defaultValue)
```
    Return the 'concurrency' property or the default value. The meaning of concurrency depends on the bus implementation.
    
    Parameters:
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getMaxConcurrency
```
public int getMaxConcurrency(int defaultValue)
```
    Return the 'maxConcurrency' property or the default value. The meaning of maxConcurrency depends on the bus implementation.
    
    Parameters:
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getMaxAttempts
```
public int getMaxAttempts(int defaultValue)
```
    Return the 'maxAttempts' property or the default value. This is used in the retry template's SimpleRetryPolicy in buses that support retry.
    
    Parameters:
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getBackOffInitialInterval
```
public long getBackOffInitialInterval(long defaultValue)
```
    Return the 'backOffInitialInterval' property or the default value. This is used in the retry template's ExponentialBackOffPolicy in buses that support retry.
    
    Parameters:
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getBackOffMultiplier
```
public double getBackOffMultiplier(double defaultValue)
```
    Return the 'backOffMultiplier' property or the default value. This is used in the retry template's ExponentialBackOffPolicy in buses that support retry.
    
    Parameters:
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getBackOffMaxInterval
```
public long getBackOffMaxInterval(long defaultValue)
```
    Return the 'backOffMaxInterval' property or the default value. This is used in the retry template's ExponentialBackOffPolicy in buses that support retry.
    
    Parameters:
    defaultValue - The default value.
    
    Returns:
    The property or default value.
  - getPartitionKeyExtractorClass
```
public java.lang.String getPartitionKeyExtractorClass()
```
    A class name for extracting partition keys from messages.
    
    Returns:
    The class name,
  - getPartitionKeyExpression
```
public org.springframework.expression.Expression getPartitionKeyExpression()
```
    The expression to determine the partition key, evaluated against the message as the root object.
    
    Returns:
    The key.
  - getPartitionSelectorClass
```
public java.lang.String getPartitionSelectorClass()
```
    A class name for calculating a partition from a key.
    
    Returns:
    The class name,
  - getPartitionSelectorExpression
```
public org.springframework.expression.Expression getPartitionSelectorExpression()
```
    The expression evaluated against the partition key to determine the partition to which the message will be sent. The result should be an integer that will subsequently be mod'd with the module's partition count.
    
    Returns:
    The expression.
  - getSequence
```
public int getSequence()
```
    The sequence number for this module.
    
    Returns:
    the sequence number.
  - getCount
```
public int getCount()
```
    The module count.
    
    Returns:
    the module count.
  - getNextModuleCount
```
public int getNextModuleCount()
```
    The next module count for non-sink modules
    
    Returns:
    the next module count
  - getPartitionIndex
```
public int getPartitionIndex()
```
    The partition index that this consumer supports.
    
    Returns:
    The partition index.
  - isDirectBindingAllowed
```
public boolean isDirectBindingAllowed()
```
    If true, the bus can attempt a direct binding.
  - isBatchingEnabled
```
public boolean isBatchingEnabled(boolean defaultValue)
```
    If true, enable batching.
    
    Parameters:
    defaultValue - the default value.
    
    Returns:
    the property or default value.
  - getBatchSize
```
public int getBatchSize(int defaultValue)
```
    The batch size.
    
    Parameters:
    defaultValue - the default value.
    
    Returns:
    the property or default value.
  - geteBatchBufferLimit
```
public int geteBatchBufferLimit(int defaultValue)
```
    The batch buffer limit.
    
    Parameters:
    defaultValue - the default value.
    
    Returns:
    the property or default value.
  - getBatchTimeout
```
public long getBatchTimeout(long defaultValue)
```
    The batch timeout.
    
    Parameters:
    defaultValue - the default value.
    
    Returns:
    the property or default value.
  - isCompress
```
public boolean isCompress(boolean defaultValue)
```
    If true, messages will be compressed.
    
    Parameters:
    defaultValue - the default value.
    
    Returns:
    the property or default value.
  - isDurable
```
public boolean isDurable(boolean defaultValue)
```
    If true, subscriptions to taps/topics will be durable.
    
    Parameters:
    defaultValue - the default value.
    
    Returns:
    the property or default value.
  - asStringArray
```
protected java.lang.String[] asStringArray(java.lang.String value,
                               java.lang.String[] defaultValue)
```
    Convert a comma-delimited String property to a String[] if present, or return the default value.
    
    Parameters:
    value - The property value.
    defaultValue - The default value.
    
    Returns:
    The converted property or default value.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AbstractBusPropertiesAccessor

Field Summary

Fields inherited from interface org.springframework.xd.dirt.integration.bus.BusProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractBusPropertiesAccessor

Method Detail

getProperties

getProperty

getProperty

getProperty

getProperty

getProperty

getProperty

getConcurrency

getMaxConcurrency

getMaxAttempts

getBackOffInitialInterval

getBackOffMultiplier

getBackOffMaxInterval

getPartitionKeyExtractorClass

getPartitionKeyExpression

getPartitionSelectorClass

getPartitionSelectorExpression

getSequence

getCount

getNextModuleCount

getPartitionIndex

isDirectBindingAllowed

isBatchingEnabled

getBatchSize

geteBatchBufferLimit

getBatchTimeout

isCompress

isDurable

asStringArray

toString