GigaSpaces XAP 10.0.1 API

org.openspaces.core.gateway
Class GatewayTarget

java.lang.Object
  extended by org.openspaces.core.gateway.GatewayTarget

public class GatewayTarget
extends Object

Holds gateway target configuration.

Since:
8.0.3
Author:
Idan Moyal

Constructor Summary
GatewayTarget()
           
GatewayTarget(String name)
           
 
Method Summary
 com.gigaspaces.internal.cluster.node.impl.gateway.GatewayPolicy asGatewayPolicy()
           
 com.gigaspaces.internal.cluster.node.impl.gateway.GatewayPolicy asGatewayPolicy(com.gigaspaces.internal.cluster.node.impl.gateway.GatewayPolicy defaultGatewayPolicy)
           
 Integer getBulkSize()
           
 Long getIdleTimeThreshold()
           
 Long getMaxRedoLogCapacity()
           
 String getName()
           
 com.j_spaces.core.cluster.RedoLogCapacityExceededPolicy getOnRedoLogCapacityExceeded()
          get limited redo log capacity behavior policy for this gateway
 Integer getPendingOperationThreshold()
           
 Boolean isReplicateChangeAsUpdate()
          get replicate change as update behavior for this gateway.
 void setBulkSize(Integer bulkSize)
          Sets the number of packets in each replication bulk sent to this gateway.
 void setIdleTimeThreshold(Long idleTimeThreshold)
          Sets the maximum time (in milliseconds) pending replication packets should wait before being replicated if setPendingOperationThreshold(Integer) has not been breached.
 void setMaxRedoLogCapacity(Long maxRedoLogCapacity)
          Sets limited redo log capacity for this gateway
 void setName(String name)
          Sets the gateway's target name used for identification.
 void setOnRedoLogCapacityExceeded(com.j_spaces.core.cluster.RedoLogCapacityExceededPolicy onRedoLogCapacityExceeded)
          Sets the behavior once the defined redo log capacity is exceeded, irrelevant if the capacity is unlimited.
 void setPendingOperationThreshold(Integer pendingOperationThreshold)
          Sets the threshold count for pending replication packets that once reached, the packets will be replicated using the setBulkSize(Integer).
 void setReplicateChangeAsUpdate(Boolean replicateChangeAsUpdate)
          Sets whether change operations should be replicated as full update.
 void setUnlimitedRedoLogCapacity()
          Sets unlimited replication redo log capacity for this gateway.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GatewayTarget

public GatewayTarget()

GatewayTarget

public GatewayTarget(String name)
Method Detail

getName

public String getName()
Returns:
The gateway's target name used for identification.

setName

public void setName(String name)
Sets the gateway's target name used for identification.

Parameters:
name - The gateway name.

setBulkSize

public void setBulkSize(Integer bulkSize)
Sets the number of packets in each replication bulk sent to this gateway.

Parameters:
bulkSize - number of packets in each replication bulk sent to this gateway.

getBulkSize

public Integer getBulkSize()
Returns:
The number of packets in each replication bulk sent to this gateway

setIdleTimeThreshold

public void setIdleTimeThreshold(Long idleTimeThreshold)
Sets the maximum time (in milliseconds) pending replication packets should wait before being replicated if setPendingOperationThreshold(Integer) has not been breached.

Parameters:
idleTimeThreshold - the maximum time (in milliseconds).

getIdleTimeThreshold

public Long getIdleTimeThreshold()
Returns:
The maximum time (in milliseconds) pending replication packets should wait before being replicated if setPendingOperationThreshold(Integer) has not been breached.

setPendingOperationThreshold

public void setPendingOperationThreshold(Integer pendingOperationThreshold)
Sets the threshold count for pending replication packets that once reached, the packets will be replicated using the setBulkSize(Integer).

Parameters:
pendingOperationThreshold - the threshold count.
See Also:
setIdleTimeThreshold(Long)

getPendingOperationThreshold

public Integer getPendingOperationThreshold()
Returns:
The threshold count for pending replication packets that once reached, the packets will be replicated using the setBulkSize(Integer).

setUnlimitedRedoLogCapacity

public void setUnlimitedRedoLogCapacity()
Sets unlimited replication redo log capacity for this gateway.


setMaxRedoLogCapacity

public void setMaxRedoLogCapacity(Long maxRedoLogCapacity)
Sets limited redo log capacity for this gateway

Parameters:
maxRedoLogCapacity - redo log limit

getMaxRedoLogCapacity

public Long getMaxRedoLogCapacity()
Returns:
The limited redo log capacity for this gateway.

setOnRedoLogCapacityExceeded

public void setOnRedoLogCapacityExceeded(com.j_spaces.core.cluster.RedoLogCapacityExceededPolicy onRedoLogCapacityExceeded)
Sets the behavior once the defined redo log capacity is exceeded, irrelevant if the capacity is unlimited.

Parameters:
onRedoLogCapacityExceeded -
See Also:
setMaxRedoLogCapacity(Long)

getOnRedoLogCapacityExceeded

public com.j_spaces.core.cluster.RedoLogCapacityExceededPolicy getOnRedoLogCapacityExceeded()
get limited redo log capacity behavior policy for this gateway


setReplicateChangeAsUpdate

public void setReplicateChangeAsUpdate(Boolean replicateChangeAsUpdate)
Sets whether change operations should be replicated as full update.

Parameters:
replicateChangeAsUpdate - true if change should be replicated as update.

isReplicateChangeAsUpdate

public Boolean isReplicateChangeAsUpdate()
get replicate change as update behavior for this gateway.


asGatewayPolicy

public com.gigaspaces.internal.cluster.node.impl.gateway.GatewayPolicy asGatewayPolicy()
Returns:
A new GatewayPolicy instance from the gateway target's properties.

asGatewayPolicy

public com.gigaspaces.internal.cluster.node.impl.gateway.GatewayPolicy asGatewayPolicy(com.gigaspaces.internal.cluster.node.impl.gateway.GatewayPolicy defaultGatewayPolicy)
Returns:
A new GatewayPolicy instance from the gateway target's properties, using provided default policy for properties which are not explicitly set by this instance.

GigaSpaces XAP 10.0.1 API

Copyright © GigaSpaces.