Package org.springframework.geode.config.annotation

Annotation Interface EnableDurableClient

@Target(TYPE)
@Retention(RUNTIME)
@Inherited
@Documented
@Import(DurableClientConfiguration.class)
public @interface EnableDurableClient

The EnableDurableClient annotation configures a ClientCache instance as a Durable Client.

Since:

1.0.0

See Also:

• Documented
• Inherited
• Retention
• Target
• ClientCache
• Import
• DurableClientConfiguration

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	id	Used only for clients in a client/server installation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	keepAlive	Configure whether the server should keep the durable client's queues alive for the timeout period.
boolean	readyForEvents	Configures whether the ClientCache is ready to recieve events on startup.
int	timeout	Used only for clients in a client/server installation.

Element Details

id

String id

Used only for clients in a client/server installation. If set, this indicates that the client is durable and identifies the client. The ID is used by servers to reestablish any messaging that was interrupted by client downtime.

keepAlive

boolean keepAlive

Configure whether the server should keep the durable client's queues alive for the timeout period. Defaults to true.

Default:

true

readyForEvents

boolean readyForEvents

Configures whether the ClientCache is ready to recieve events on startup. Defaults to true.

Default:

true

timeout

int timeout

Used only for clients in a client/server installation. Number of seconds this client can remain disconnected from its server and have the server continue to accumulate durable events for it. Defaults to 300 seconds, or 5 minutes.

Default:

300