WanPublisherConfig (Hazelcast Root 3.11-BETA-1 API)

java.lang.Object
- com.hazelcast.config.WanPublisherConfig

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, Versioned
```
public class WanPublisherConfig
extends Object
implements IdentifiedDataSerializable, Versioned
```
Configuration object for a WAN publisher. A single publisher defines how WAN events are sent to a specific endpoint. The endpoint can be a different cluster defined by static IP's or discovered using a cloud discovery mechanism. When using a custom WAN publisher implementation, the target may also be some other external system which is not a Hazelcast cluster.

See Also:

DiscoveryConfig, AwsConfig

Constructor Summary

Constructors
Constructor and Description

WanPublisherConfig()

Constructors
Constructor and Description
`WanPublisherConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsConfig`	`getAwsConfig()` Returns the `AwsConfig` used by the discovery mechanism for this WAN publisher.
`String`	`getClassName()` Returns the name of the class implementing the WanReplicationEndpoint.
`DiscoveryConfig`	`getDiscoveryConfig()` Returns the currently defined `DiscoveryConfig` used by the discovery mechanism for this WAN publisher.
`int`	`getFactoryId()` Returns DataSerializableFactory factory ID for this class.
`String`	`getGroupName()` Returns the group name of this publisher.
`int`	`getId()` Returns type identifier for this class.
`Object`	`getImplementation()` Returns the implementation of the WanReplicationEndpoint.
`WanPublisherState`	`getInitialPublisherState()` Returns the initial WAN publisher state.
`Map<String,Comparable>`	`getProperties()` Returns the WAN publisher properties.
`int`	`getQueueCapacity()` Returns the capacity of the primary and backup queue for WAN replication events.
`WANQueueFullBehavior`	`getQueueFullBehavior()` Returns the configured behaviour of this WAN publisher when the WAN queue is full.
`WanSyncConfig`	`getWanSyncConfig()` Returns the config for the WAN sync mechanism.
`void`	`readData(ObjectDataInput in)` Reads fields from the input stream
`WanPublisherConfig`	`setAwsConfig(AwsConfig awsConfig)` Sets the `AwsConfig` used by the discovery mechanism for this WAN publisher.
`WanPublisherConfig`	`setClassName(String className)` Sets the name of the class implementing the WanReplicationEndpoint.
`WanPublisherConfig`	`setDiscoveryConfig(DiscoveryConfig discoveryConfig)` Sets the `DiscoveryConfig` used by the discovery mechanism for this WAN publisher.
`WanPublisherConfig`	`setGroupName(String groupName)` Set the group name of this publisher.
`WanPublisherConfig`	`setImplementation(Object implementation)` Sets the implementation of the WanReplicationEndpoint.
`WanPublisherConfig`	`setInitialPublisherState(WanPublisherState initialPublisherState)` Sets the initial publisher state.
`WanPublisherConfig`	`setProperties(Map<String,Comparable> properties)` Sets the WAN publisher properties.
`WanPublisherConfig`	`setQueueCapacity(int queueCapacity)` Sets the capacity of the primary and backup queue for WAN replication events.
`WanPublisherConfig`	`setQueueFullBehavior(WANQueueFullBehavior queueFullBehavior)` Sets the configured behaviour of this WAN publisher when the WAN queue is full.
`WanPublisherConfig`	`setWanSyncConfig(WanSyncConfig wanSyncConfig)` Sets the config for the WAN sync mechanism.
`String`	`toString()`
`void`	`writeData(ObjectDataOutput out)` Writes object fields to output stream

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

- Constructor Detail
  - WanPublisherConfig
```
public WanPublisherConfig()
```
- Method Detail
  - getWanSyncConfig
```
public WanSyncConfig getWanSyncConfig()
```
    Returns the config for the WAN sync mechanism.
  - setWanSyncConfig
```
public WanPublisherConfig setWanSyncConfig(WanSyncConfig wanSyncConfig)
```
    Sets the config for the WAN sync mechanism.
    
    Parameters:
    
    wanSyncConfig - the WAN sync config
    
    Returns:
    
    this config
  - getGroupName
```
public String getGroupName()
```
    Returns the group name of this publisher. The group name is used for identifying the publisher in a WanReplicationConfig and for authentication on the target endpoint.
    
    Returns:
    
    the publisher group name
  - setGroupName
```
public WanPublisherConfig setGroupName(String groupName)
```
    Set the group name of this publisher. The group name is used for identifying the publisher in a WanReplicationConfig and for authentication on the target endpoint.
    
    Parameters:
    
    groupName - the publisher group name
    
    Returns:
    
    this config
  - getQueueCapacity
```
public int getQueueCapacity()
```
    Returns the capacity of the primary and backup queue for WAN replication events.
    One hazelcast instance can have up to 2*queueCapacity events since we keep up to queueCapacity primary events (events with keys for which the instance is the owner) and queueCapacity backup events (events with keys for which the instance is the backup). Events for IMap and ICache count against this limit collectively.
    When the queue capacity is reached, backup events are dropped while normal replication events behave as determined by the getQueueFullBehavior(). The default queue size for replication queues is .
    
    Returns:
    
    the queue capacity
  - setQueueCapacity
```
public WanPublisherConfig setQueueCapacity(int queueCapacity)
```
    Sets the capacity of the primary and backup queue for WAN replication events.
    One hazelcast instance can have up to 2*queueCapacity events since we keep up to queueCapacity primary events (events with keys for which the instance is the owner) and queueCapacity backup events (events with keys for which the instance is the backup). Events for IMap and ICache count against this limit collectively.
    When the queue capacity is reached, backup events are dropped while normal replication events behave as determined by the getQueueFullBehavior(). The default queue size for replication queues is .
    
    Parameters:
    
    queueCapacity - the queue capacity
    
    Returns:
    
    this config
  - getQueueFullBehavior
```
public WANQueueFullBehavior getQueueFullBehavior()
```
    Returns the configured behaviour of this WAN publisher when the WAN queue is full.
  - setQueueFullBehavior
```
public WanPublisherConfig setQueueFullBehavior(WANQueueFullBehavior queueFullBehavior)
```
    Sets the configured behaviour of this WAN publisher when the WAN queue is full.
    
    Parameters:
    
    queueFullBehavior - the behaviour of this publisher when the WAN queue is full
    
    Returns:
    
    this config
  - getInitialPublisherState
```
public WanPublisherState getInitialPublisherState()
```
    Returns the initial WAN publisher state.
  - setInitialPublisherState
```
public WanPublisherConfig setInitialPublisherState(WanPublisherState initialPublisherState)
```
    Sets the initial publisher state.
    
    Parameters:
    
    initialPublisherState - the state
    
    Returns:
    
    this configuration
  - getProperties
```
public Map<String,Comparable> getProperties()
```
    Returns the WAN publisher properties.
  - setProperties
```
public WanPublisherConfig setProperties(Map<String,Comparable> properties)
```
    Sets the WAN publisher properties.
    
    Parameters:
    
    properties - WAN publisher properties
    
    Returns:
    
    this config
  - getClassName
```
public String getClassName()
```
    Returns the name of the class implementing the WanReplicationEndpoint. NOTE: OS and EE have different interfaces that this class should implement. For OS see WanReplicationEndpoint.
  - setClassName
```
public WanPublisherConfig setClassName(String className)
```
    Sets the name of the class implementing the WanReplicationEndpoint. NOTE: OS and EE have different interfaces that this class should implement. For OS see WanReplicationEndpoint.
    
    Parameters:
    
    className - the name of the class implementation for the WAN replication
    
    Returns:
    
    this config
  - getImplementation
```
public Object getImplementation()
```
    Returns the implementation of the WanReplicationEndpoint. NOTE: OS and EE have different interfaces that this object should implement. For OS see WanReplicationEndpoint.
  - setImplementation
```
public WanPublisherConfig setImplementation(Object implementation)
```
    Sets the implementation of the WanReplicationEndpoint. NOTE: OS and EE have different interfaces that this object should implement. For OS see WanReplicationEndpoint.
    
    Parameters:
    
    implementation - the implementation for the WAN replication
    
    Returns:
    
    this config
  - getAwsConfig
```
public AwsConfig getAwsConfig()
```
    Returns the AwsConfig used by the discovery mechanism for this WAN publisher.
  - setAwsConfig
```
public WanPublisherConfig setAwsConfig(AwsConfig awsConfig)
```
    Sets the AwsConfig used by the discovery mechanism for this WAN publisher.
    
    Parameters:
    
    awsConfig - the AWS discovery configuration
    
    Returns:
    
    this config
    
    Throws:
    
    IllegalArgumentException - if awsConfig is null
  - getDiscoveryConfig
```
public DiscoveryConfig getDiscoveryConfig()
```
    Returns the currently defined DiscoveryConfig used by the discovery mechanism for this WAN publisher.
    
    Returns:
    
    current DiscoveryProvidersConfig instance
  - setDiscoveryConfig
```
public WanPublisherConfig setDiscoveryConfig(DiscoveryConfig discoveryConfig)
```
    Sets the DiscoveryConfig used by the discovery mechanism for this WAN publisher.
    
    Parameters:
    
    discoveryConfig - configuration to set
    
    Returns:
    
    this config
    
    Throws:
    
    IllegalArgumentException - if discoveryProvidersConfig is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getFactoryId
```
public int getFactoryId()
```
    Description copied from interface: IdentifiedDataSerializable
    
    Returns DataSerializableFactory factory ID for this class.
    
    Specified by:
    
    getFactoryId in interface IdentifiedDataSerializable
    
    Returns:
    
    factory ID
  - getId
```
public int getId()
```
    Description copied from interface: IdentifiedDataSerializable
    
    Returns type identifier for this class. It should be unique per DataSerializableFactory.
    
    Specified by:
    
    getId in interface IdentifiedDataSerializable
    
    Returns:
    
    type ID
  - writeData
```
public void writeData(ObjectDataOutput out)
               throws IOException
```
    Description copied from interface: DataSerializable
    
    Writes object fields to output stream
    
    Specified by:
    
    writeData in interface DataSerializable
    
    Parameters:
    
    out - output
    
    Throws:
    
    IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
  - readData
```
public void readData(ObjectDataInput in)
              throws IOException
```
    Description copied from interface: DataSerializable
    
    Reads fields from the input stream
    
    Specified by:
    
    readData in interface DataSerializable
    
    Parameters:
    
    in - input
    
    Throws:
    
    IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

Class WanPublisherConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WanPublisherConfig

Method Detail

getWanSyncConfig

setWanSyncConfig

getGroupName

setGroupName

getQueueCapacity

setQueueCapacity

getQueueFullBehavior

setQueueFullBehavior

getInitialPublisherState

setInitialPublisherState

getProperties

setProperties

getClassName

setClassName

getImplementation

setImplementation

getAwsConfig

setAwsConfig

getDiscoveryConfig

setDiscoveryConfig

toString

getFactoryId

getId

writeData

readData