in geode-core/src/main/java/org/apache/geode/admin/jmx/internal/AgentConfigImpl.java [1265:1367]
public static String _getPropertyDescription(String prop) {
if (prop.equals(AUTO_CONNECT_NAME)) {
return "Whether the JMX agent will connect 'automatically' to the distributed system that it is configured to monitor.";
} else if (prop.equals(HTTP_ENABLED_NAME)) {
return "Whether the HTTP adapter is enabled in the JMX agent.";
} else if (prop.equals(HTTP_BIND_ADDRESS_NAME)) {
return "Bind address of HTTP adapter's sockets";
} else if (prop.equals(HTTP_PORT_NAME)) {
return "The port on which the HTTP adapter will be started. This value should be in the range: 0-65535.";
} else if (prop.equals(RMI_ENABLED_NAME)) {
return "Whether the RMI JMX adapter is enabled.";
} else if (prop.equals(RMI_REGISTRY_ENABLED_NAME)) {
return "Whether the JMX agent should start RMI registry. Alternatively, a registry outside of the JMX agent VM can be used.";
} else if (prop.equals(RMI_BIND_ADDRESS_NAME)) {
return "Bind address of RMI adapter's sockets";
} else if (prop.equals(RMI_PORT_NAME)) {
return "The port on which to contact the RMI registry. The value must be in the range: 0-65535.";
} else if (prop.equals(RMI_SERVER_PORT_NAME)) {
return "The port on which the RMI Connector Server should start. The value must be in the range: 0-65535.";
} else if (prop.equals(SNMP_ENABLED_NAME)) {
return "Whether the SNMP JMX adapter will be enabled.";
} else if (prop.equals(SNMP_BIND_ADDRESS_NAME)) {
return "Bind address of SNMP adapter's sockets";
} else if (prop.equals(SNMP_DIRECTORY_NAME)) {
return "The directory in which SNMP configuration resides";
} else if (prop.equals(AGENT_SSL_ENABLED_NAME)) {
return "Whether the JMX Agent will use the SSL protocol for communication.";
} else if (prop.equals(AGENT_SSL_PROTOCOLS_NAME)) {
return "The space-separated list of the SSL protocols to be used when connecting to the JMX agent.";
} else if (prop.equals(AGENT_SSL_CIPHERS_NAME)) {
return "The space-separated list of the SSL ciphers to be used when connecting to the JMX Agent.";
} else if (prop.equals(AGENT_SSL_REQUIRE_AUTHENTICATION_NAME)) {
return "Whether or not SSL connections to the RMI adapter require authentication. If true, needs client authentication for RMI and other non-HTTP connectors/adaptors.";
} else if (prop.equals(HTTP_SSL_REQUIRE_AUTHENTICATION_NAME)) {
return "Whether SSL connections to the HTTP adapter will need authentication.";
} else if (prop.equals(HTTP_AUTHENTICATION_ENABLED_NAME)) {
return "Whether the HTTP adapter will use HTTP authentication.";
} else if (prop.equals(HTTP_AUTHENTICATION_USER_NAME)) {
return "The user name for authentication in the HTTP JMX adapter";
} else if (prop.equals(HTTP_AUTHENTICATION_PASSWORD_NAME)) {
return "The password for authentication in the HTTP JMX adapter";
} else if (prop.equals(PROPERTY_FILE_NAME)) {
return "Name and path of the Agent's properties file from which agent reads configuration";
} else if (prop.equals(LOCATOR_HOST_NAME)) {
return "Host on which the distributed system's locator runs";
} else if (prop.equals(LOCATOR_PORT_NAME)) {
return "Host on which the distributed system's locator runs";
} else if (prop.equals(LOCATOR_PRODUCT_DIRECTORY_NAME)) {
return "GemFire product directory used to launch a locator";
} else if (prop.equals(LOCATOR_WORKING_DIRECTORY_NAME)) {
return "Directory in which a locator will be launched";
} else if (prop.equals(LOCATOR_REMOTE_COMMAND)) {
return "Command prefix used when launching a locator";
} else if (prop.equals(LOCATOR_BIND_ADDRESS)) {
return "IP address to use when contacting locator";
} else if (prop.equals(LOCATOR_DS_PROPERTIES)) {
return "Properties for configuring a locator's distributed system";
} else if (prop.equals(EMAIL_NOTIFICATIONS_ENABLED_NAME)) {
return "Whether the e-mail notifications are enabled.";
} else if (prop.equals(EMAIL_NOTIFICATIONS_FROM_NAME)) {
return "E-mail address to be used to send e-mail notifications.";
} else if (prop.equals(EMAIL_NOTIFICATIONS_HOST_NAME)) {
return "The host name of the e-mail server to be used for sending email notification.";
} else if (prop.equals(EMAIL_NOTIFICATIONS_TO_LIST_NAME)) {
return "A comma-separated list of recipient e-mail addresses to send e-mail notifications to.";
} else if (prop.equals(STATE_SAVE_FILE_NAME)) {
return "The name(not the path) of the file to be used for saving agent state. The file is stored in the same directory in which the agent.properties file is located.";
} else {
return null;
}
}