org.springframework.data.gemfire.config.annotation

Annotation Type EnableEmbeddedManager

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

The EnableEmbeddedLocator annotation marks a Spring Configuration class to embed a GemFire Manager service in the GemFire server-side data member node.

Since:

1.9.0

Author:

John Blum

See Also:

EmbeddedManagerConfiguration

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	jmxManager If true then this member is willing to be a JMX Manager.
String	jmxManagerAccessFile By default, the JMX Manager will allow full access to all mbeans by any client.
String	jmxManagerBindAddress By default, the JMX Manager (when configured with a port) will listen on all the local host's addresses.
String	jmxManagerHostnameForClients Lets you control what hostname will be given to clients that ask the Locator for the location of a JMX Manager.
String	jmxManagerPasswordFile By default, the JMX Manager will allow clients without credentials to connect.
int	jmxManagerPort The port this JMX Manager will listen to for client connections.
String	jmxManagerSslCiphers A space-separated list of the valid SSL ciphers for JMX Manager connections.
boolean	jmxManagerSslEnabled Enables or disables SSL for connections to the JMX Manager.
String	jmxManagerSslProtocols A space-separated list of the valid SSL protocols for JMX Manager connections.
boolean	jmxManagerSslRequireAuthentication Boolean indicating whether to require authentication for JMX Manager connections.
boolean	jmxManagerStart If true then this member will start a JMX Manager when it creates a cache.
int	jmxManagerUpdateRate The rate, in milliseconds, at which this member will push updates to any JMX Managers.

Element Detail

jmxManager

public abstract boolean jmxManager

If true then this member is willing to be a JMX Manager. All the other JMX Manager properties will be used when it does become a manager. If this property is false then all other jmx-manager-* properties are ignored. Defaults to true.

Default:

true

jmxManagerAccessFile

public abstract String jmxManagerAccessFile

By default, the JMX Manager will allow full access to all mbeans by any client. If this property is set to the name of a file then it can restrict clients to only being able to read MBeans; they will not be able to modify MBeans. The access level can be configured differently in this file for each user name defined in the password file. For more information about the format of this file see Oracle's documentation of the com.sun.management.jmxremote.access.file System property. Ignored if jmx-manager is false or if jmx-manager-port is zero.

Default:

""

jmxManagerBindAddress

public abstract String jmxManagerBindAddress

By default, the JMX Manager (when configured with a port) will listen on all the local host's addresses. You can use this property to configure what IP address or host name the JMX Manager will listen on for non-HTTP connections. Ignored if JMX Manager is false or jmx-manager-port is zero. Defaults to localhost.

Default:

"localhost"

jmxManagerHostnameForClients

public abstract String jmxManagerHostnameForClients

Lets you control what hostname will be given to clients that ask the Locator for the location of a JMX Manager. By default, the IP address that the JMX Manager reports is used. But for clients on a different network this property allows you to configure a different hostname that will be given to clients. Ignored if jmx-manager is false or jmx-manager-port is zero. Defaults to localhost.

Default:

"localhost"

jmxManagerPasswordFile

public abstract String jmxManagerPasswordFile

By default, the JMX Manager will allow clients without credentials to connect. If this property is set to the name of a file then only clients that connect with credentials that match an entry in this file will be allowed. Most JVMs require that the file is only readable by the owner. For more information about the format of this file see Oracle's documentation of the com.sun.management.jmxremote.password.file System property. Ignored if jmx-manager is false or jmx-manager-port is zero.

Default:

""

jmxManagerPort

public abstract int jmxManagerPort

The port this JMX Manager will listen to for client connections. If this property is set to zero then GemFire will not allow remote client connections but you can alternatively use the standard System properties supported by the JVM for configuring access from remote JMX clients. Ignored if jmx-manager is false. Defaults to 1099.

Default:

1099

jmxManagerSslEnabled

public abstract boolean jmxManagerSslEnabled

Enables or disables SSL for connections to the JMX Manager. If true and jmx-manager-port is not zero, then the JMX Manager will only accept SSL connections. If this property is not set, then GemFire uses the value of cluster-ssl-enabled to determine whether JMX connections should use SSL. Defaults to false.

Default:

false

jmxManagerSslCiphers

public abstract String jmxManagerSslCiphers

A space-separated list of the valid SSL ciphers for JMX Manager connections. A setting of 'any' uses any ciphers that are enabled by default in the configured JSSE provider. If this property is not set, then GemFire uses the value of cluster-ssl-ciphers to determine which SSL ciphers are used for JMX connections. Defaults to any.

Default:

"any"

jmxManagerSslProtocols

public abstract String jmxManagerSslProtocols

A space-separated list of the valid SSL protocols for JMX Manager connections. A setting of 'any' uses any protocol that is enabled by default in the configured JSSE provider. If this property is not set, then GemFire uses the value of cluster-ssl-protocols to determine which SSL protocols are used for JMX connections. Defaults to any.

Default:

"any"

jmxManagerSslRequireAuthentication

public abstract boolean jmxManagerSslRequireAuthentication

Boolean indicating whether to require authentication for JMX Manager connections. If this property is not set, then GemFire uses the value of cluster-ssl-require-authentication to determine whether JMX connections require authentication. Defaults to true.

Default:

true

jmxManagerStart

public abstract boolean jmxManagerStart

If true then this member will start a JMX Manager when it creates a cache. Management tools like Gfsh can be configured to connect to the JMX Manager. In most cases you should not set this because a JMX Manager will automatically be started when needed on a member that sets jmx-manager to true. Ignored if jmx-manager is false. Defaults to false.

Default:

false

jmxManagerUpdateRate

public abstract int jmxManagerUpdateRate

The rate, in milliseconds, at which this member will push updates to any JMX Managers. Currently this value should be greater than or equal to the statistic-sample-rate. Setting this value too high will cause stale values to be seen by Gfsh and GemFire Pulse. Defaults to 2000.

Default:

2000