org.springframework.data.gemfire.config.annotation

Annotation Type EnableGatewayReceiver

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Import(value=GatewayReceiverConfiguration.class)
public @interface EnableGatewayReceiver

The EnableGatewayReceiver annotation creates a GatewayReceiver within an Apache Geode or Pivotal GemFire peer Cache.

Since:

2.2.0

Author:

Udo Kohlmeyer

See Also:

Cache, GatewayReceiver, GatewayTransportFilter, Import

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	bindAddress The IP address or hostname that the GatewayReceiver communication socket will be bound to.
int	endPort The end port that GatewayReceiver will use when selecting a port to run on.
String	hostnameForSenders The hostname or IP Address that the GatewaySender will use to connect and communicate with the GatewayReceiver.
boolean	manualStart A boolean to allow the GatewayReceiver to be created without being started after creation.
int	maximumTimeBetweenPings An integer value in milliseconds representing the maximum time which a GatewayReceiver will wait to receive a ping back from a GatewaySender before the GatewayReceiver believes the sender to be not available.
int	socketBufferSize The socket buffer size for the GatewayReceiver.
int	startPort The starting port that GatewayReceiver will use when selecting a port to run on.
String[]	transportFilters An in-order list of GatewayTransportFilter to be applied to GatewayReceiver This property can also be configured using the spring.data.gemfire.gateway.receiver.transport-filters property Default value is an empty String array

Element Detail

bindAddress

public abstract String bindAddress

The IP address or hostname that the GatewayReceiver communication socket will be bound to. An empty String will cause the underlying socket to bind to 0.0.0.0
This property can also be configured using the spring.data.gemfire.gateway.receiver.bind-address property
Default value is

Default:

""

hostnameForSenders

public abstract String hostnameForSenders

The hostname or IP Address that the GatewaySender will use to connect and communicate with the GatewayReceiver. An empty String will cause the system to expose the hostname to the GatewaySender. Generally this property is set when there are multiple network interfaces or when they are designated as "internal" or "public" network interfaces. In a cloud environment the notion of external and internal network interfaces exist and generally the "externally"/outwardly facing network interface is used.
This property can also be configured using the spring.data.gemfire.gateway.receiver.hostname-for-senders property
Default value is

Default:

""

manualStart

public abstract boolean manualStart

A boolean to allow the GatewayReceiver to be created without being started after creation. If the manualStart is set to true then the system will create the GatewayReceiver but not start it. It then becomes the responsibility of the operator to start the GatewayReceiver at a later stage. If set to false the GatewayReceiver will start automatically after creation.
This property can also be configured using the spring.data.gemfire.gateway.receiver.manual-start property
Default is

Default:

false

maximumTimeBetweenPings

public abstract int maximumTimeBetweenPings

An integer value in milliseconds representing the maximum time which a GatewayReceiver will wait to receive a ping back from a GatewaySender before the GatewayReceiver believes the sender to be not available.
This property can also be configured using the spring.data.gemfire.gateway.receiver.maximum-time-between-pings property
Default value is

Default:

60000

startPort

public abstract int startPort

The starting port that GatewayReceiver will use when selecting a port to run on. This range of port numbers is bounded by a startPort and endPort.
This property can also be configured using the spring.data.gemfire.gateway.receiver.start-port property
Default is

Default:

5000

endPort

public abstract int endPort

The end port that GatewayReceiver will use when selecting a port to run on. This range of port numbers is bounded by a startPort and endPort.
This property can also be configured using the spring.data.gemfire.gateway.receiver.end-port property
Default is

Default:

5500

socketBufferSize

public abstract int socketBufferSize

The socket buffer size for the GatewayReceiver. This setting is in bytes.
This property can also be configured using the spring.data.gemfire.gateway.receiver.socket-buffer-size property
Default value is

Default:

524288

transportFilters

public abstract String[] transportFilters

An in-order list of GatewayTransportFilter to be applied to GatewayReceiver
This property can also be configured using the spring.data.gemfire.gateway.receiver.transport-filters property
Default value is an empty String array

Default:

{}