VMware GemFire Java API Reference
Class GatewayReceiver
- java.lang.Object
-
- org.apache.geode.management.configuration.AbstractConfiguration<R>
-
- org.apache.geode.management.configuration.GroupableConfiguration<GatewayReceiverInfo>
-
- org.apache.geode.management.configuration.GatewayReceiver
-
- All Implemented Interfaces:
java.io.Serializable,Identifiable<java.lang.String>,JsonSerializable
public class GatewayReceiver extends GroupableConfiguration<GatewayReceiverInfo>
Use this to configure the gateway receiver in the cluster setting the bindAddress and hostname for clients are not supported by this api.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringGATEWAY_RECEIVERS_ENDPOINTSthe url end points to retrieve the gateway receivers-
Fields inherited from class org.apache.geode.management.configuration.AbstractConfiguration
CLUSTER
-
-
Constructor Summary
Constructors Constructor Description GatewayReceiver()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.IntegergetEndPort()get the end portjava.util.List<ClassName>getGatewayTransportFilters()get the list of transport filters if you modify the returned list, you will be modifying the list owned by this config object.java.lang.StringgetId()ReturnsGroupableConfiguration.getGroup()orAbstractConfiguration.CLUSTERif group is null.LinksgetLinks()java.lang.IntegergetMaximumTimeBetweenPings()get the maximum time between pings in milliseconds, the default is CacheServer.DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS = 60000java.lang.IntegergetSocketBufferSize()get the socket buffer size for socket buffers from the receiver to the sender.java.lang.IntegergetStartPort()get the starting portjava.lang.BooleanisManualStart()is this gateway receiver manually startedvoidsetEndPort(java.lang.Integer endPort)set the end portvoidsetGatewayTransportFilters(java.util.List<ClassName> gatewayTransportFilters)set the gateway transport filtersvoidsetManualStart(java.lang.Boolean manualStart)set the manualStartvoidsetMaximumTimeBetweenPings(java.lang.Integer maximumTimeBetweenPings)set the maximum time between pings in millisecondsvoidsetSocketBufferSize(java.lang.Integer socketBufferSize)set the socket buffer size for socket buffers from the receiver to the sender.voidsetStartPort(java.lang.Integer startPort)set the starting port-
Methods inherited from class org.apache.geode.management.configuration.GroupableConfiguration
equals, getGroup, hashCode, setGroup
-
Methods inherited from class org.apache.geode.management.configuration.AbstractConfiguration
getCreationCommandType, getGroupName, isCluster, isGlobalRuntime
-
-
-
-
Field Detail
-
GATEWAY_RECEIVERS_ENDPOINTS
public static final java.lang.String GATEWAY_RECEIVERS_ENDPOINTS
the url end points to retrieve the gateway receivers- See Also:
- Constant Field Values
-
-
Method Detail
-
getId
public java.lang.String getId()
ReturnsGroupableConfiguration.getGroup()orAbstractConfiguration.CLUSTERif group is null.- Specified by:
getIdin interfaceIdentifiable<java.lang.String>- Specified by:
getIdin classAbstractConfiguration<GatewayReceiverInfo>- Returns:
- an identifier uniquely identifying this Object.
-
getLinks
public Links getLinks()
- Specified by:
getLinksin classAbstractConfiguration<GatewayReceiverInfo>
-
getGatewayTransportFilters
public java.util.List<ClassName> getGatewayTransportFilters()
get the list of transport filters if you modify the returned list, you will be modifying the list owned by this config object.- Returns:
- a list of transport filters
-
setGatewayTransportFilters
public void setGatewayTransportFilters(java.util.List<ClassName> gatewayTransportFilters)
set the gateway transport filters- Parameters:
gatewayTransportFilters- a list of gateway transport filters
-
getStartPort
public java.lang.Integer getStartPort()
get the starting port- Returns:
- the starting port
-
setStartPort
public void setStartPort(java.lang.Integer startPort)
set the starting port- Parameters:
startPort- the starting port
-
getEndPort
public java.lang.Integer getEndPort()
get the end port- Returns:
- the end port
-
setEndPort
public void setEndPort(java.lang.Integer endPort)
set the end port- Parameters:
endPort- the end port
-
getMaximumTimeBetweenPings
public java.lang.Integer getMaximumTimeBetweenPings()
get the maximum time between pings in milliseconds, the default is CacheServer.DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS = 60000- Returns:
- the maximum time between pings in milliseconds
-
setMaximumTimeBetweenPings
public void setMaximumTimeBetweenPings(java.lang.Integer maximumTimeBetweenPings)
set the maximum time between pings in milliseconds- Parameters:
maximumTimeBetweenPings- the maximum time between pings in milliseconds
-
getSocketBufferSize
public java.lang.Integer getSocketBufferSize()
get the socket buffer size for socket buffers from the receiver to the sender. CacheServer.DEFAULT_SOCKET_BUFFER_SIZE = 32768;- Returns:
- the socket buffer size for socket buffers from the receiver to the sender
-
setSocketBufferSize
public void setSocketBufferSize(java.lang.Integer socketBufferSize)
set the socket buffer size for socket buffers from the receiver to the sender.- Parameters:
socketBufferSize- the socket buffer size for socket buffers from the receiver to the sender
-
isManualStart
public java.lang.Boolean isManualStart()
is this gateway receiver manually started- Returns:
- true if this gateway receiver is manually started
-
setManualStart
public void setManualStart(java.lang.Boolean manualStart)
set the manualStart- Parameters:
manualStart- whether this gateway receiver is manually started
-
-