Package org.springframework.data.gemfire.config.annotation

Annotation Interface EnableManager

@Target(TYPE) @Retention(RUNTIME) @Inherited @Documented @Import(ManagerConfiguration.class) @UsesGemFireProperties public @interface EnableManager
The EnableManager annotation marks a Spring @Configuration annotated Class to configure, embed and start a Pivotal GemFire/Apache Geode Manager service in this cluster member. Automatically sets jmx-manager to true just by specifying this Annotation on your Spring application @Configuration annotated Class. However, the embedded Pivotal GemFire/Apache Geode Manager can be enabled/disabled externally in application.properties by using the spring.data.gemfire.manager.enabled property even when this Annotation is present, thereby serving as a toggle.
Since:
1.9.0
Author:
John Blum
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    accessFile
    By default, the JMX Manager will allow full access to all mbeans by any client.
    String
    bindAddress
    By default, the JMX Manager (when configured with a port) will listen on all the local host's addresses.
    String
    hostnameForClients
    Lets you control what hostname will be given to clients that ask the Locator for the location of a JMX Manager.
    String
    passwordFile
    By default, the JMX Manager will allow clients without credentials to connect.
    int
    port
    The port this JMX Manager will listen to for client connections.
    boolean
    start
    If true then this member will start a JMX Manager when it creates a cache.
    int
    updateRate
    The rate, in milliseconds, at which this member will push updates to any JMX Managers.

  • Element Details

    • accessFile

      String accessFile
      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. Defaults to unset. Use the spring.data.gemfire.manager.access-file property in application.properties.
      Default:
      ""

    • bindAddress

      String bindAddress
      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 unset. Use the spring.data.gemfire.manager.bind-address property in application.properties.
      Default:
      ""

    • hostnameForClients

      String hostnameForClients
      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 unset. Use the spring.data.gemfire.manager.hostname-for-clients property in application.properties.
      Default:
      ""

    • passwordFile

      String passwordFile
      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. Defaults to unset. Use the spring.data.gemfire.manager.password-file property in application.properties.
      Default:
      ""

    • port

      int port
      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. Use the spring.data.gemfire.manager.port property in application.properties.
      Default:
      1099

    • start

      boolean start
      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. Use the spring.data.gemfire.manager.start property in application.properties.
      Default:
      false

    • updateRate

      int updateRate
      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 milliseconds. Use the spring.data.gemfire.manager.update-rate property in application.properties.
      Default:
      2000