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:
Serializable,Identifiable<String>,JsonSerializable
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringthe url end points to retrieve the gateway receiversFields inherited from class org.apache.geode.management.configuration.AbstractConfiguration
CLUSTER -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget the end portget the list of transport filters if you modify the returned list, you will be modifying the list owned by this config object.getId()ReturnsGroupableConfiguration.getGroup()orAbstractConfiguration.CLUSTERif group is null.getLinks()get the maximum time between pings in milliseconds, the default is CacheServer.DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS = 60000get the socket buffer size for socket buffers from the receiver to the sender.get the starting portis this gateway receiver manually startedvoidsetEndPort(Integer endPort) set the end portvoidsetGatewayTransportFilters(List<ClassName> gatewayTransportFilters) set the gateway transport filtersvoidsetManualStart(Boolean manualStart) set the manualStartvoidsetMaximumTimeBetweenPings(Integer maximumTimeBetweenPings) set the maximum time between pings in millisecondsvoidsetSocketBufferSize(Integer socketBufferSize) set the socket buffer size for socket buffers from the receiver to the sender.voidsetStartPort(Integer startPort) set the starting portMethods inherited from class org.apache.geode.management.configuration.GroupableConfiguration
equals, getGroup, hashCode, setGroupMethods inherited from class org.apache.geode.management.configuration.AbstractConfiguration
getCreationCommandType, getGroupName, isCluster, isGlobalRuntime
-
Field Details
-
GATEWAY_RECEIVERS_ENDPOINTS
the url end points to retrieve the gateway receivers- See Also:
-
-
Constructor Details
-
GatewayReceiver
public GatewayReceiver()
-
-
Method Details
-
getId
ReturnsGroupableConfiguration.getGroup()orAbstractConfiguration.CLUSTERif group is null.- Specified by:
getIdin interfaceIdentifiable<String>- Specified by:
getIdin classAbstractConfiguration<GatewayReceiverInfo>- Returns:
- an identifier uniquely identifying this Object.
-
getLinks
- Specified by:
getLinksin classAbstractConfiguration<GatewayReceiverInfo>
-
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
set the gateway transport filters- Parameters:
gatewayTransportFilters- a list of gateway transport filters
-
getStartPort
get the starting port- Returns:
- the starting port
-
setStartPort
set the starting port- Parameters:
startPort- the starting port
-
getEndPort
get the end port- Returns:
- the end port
-
setEndPort
set the end port- Parameters:
endPort- the end port
-
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
set the maximum time between pings in milliseconds- Parameters:
maximumTimeBetweenPings- the maximum time between pings in milliseconds
-
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
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
is this gateway receiver manually started- Returns:
- true if this gateway receiver is manually started
-
setManualStart
set the manualStart- Parameters:
manualStart- whether this gateway receiver is manually started
-