ConfigurationKey (Protocol Translator 0.21.2.Final API)

java.lang.Object
- java.lang.Enum<ConfigurationKey>
- - org.hawkular.metrics.clients.ptrans.ConfigurationKey

All Implemented Interfaces:

Serializable, Comparable<ConfigurationKey>
```
public enum ConfigurationKey
extends Enum<ConfigurationKey>
```
PTrans configuration keys.

Author:

Thomas Segismont

Enum Constant Summary

Enum Constants
Enum Constant and Description
`METRICS_AUTH_ENABLED` Authentication switch.
`METRICS_AUTH_ID` Authentication id.
`METRICS_AUTH_SECRET` Authentication secret.
`METRICS_BATCH_SIZE` Size of the metric batches sent to the backend.
`METRICS_MAX_CONNECTIONS` Maximum number of HTTP connections used to send metrics to the backend.
`METRICS_TENANT` Tenant selection.
`METRICS_TENANT_SEND` Tenant Header switch.
`METRICS_URL` Metrics service url.
`SERVICES` Services to start.
`SERVICES_COLLECTD_PORT` UDP port for collectd type of messages.
`SERVICES_GANGLIA_GROUP` Ganglia group.
`SERVICES_GANGLIA_MULTICAST_INTERFACE` Explicit multicast interface.
`SERVICES_GANGLIA_PORT` Ganglia port.
`SERVICES_GRAPHITE_PORT` TCP port for graphite type of messages.
`SERVICES_STATSD_PORT` UDP port for statsd type of messages.
`SERVICES_TCP_PORT` Multiplexed TCP port.
`SERVICES_UDP_PORT` Multiplexed UDP port.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`toString()`
`static ConfigurationKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ConfigurationKey[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SERVICES
```
public static final ConfigurationKey SERVICES
```
    Services to start.
  - SERVICES_UDP_PORT
```
public static final ConfigurationKey SERVICES_UDP_PORT
```
    Multiplexed UDP port.
  - SERVICES_TCP_PORT
```
public static final ConfigurationKey SERVICES_TCP_PORT
```
    Multiplexed TCP port.
  - SERVICES_GANGLIA_PORT
```
public static final ConfigurationKey SERVICES_GANGLIA_PORT
```
    Ganglia port.
  - SERVICES_GANGLIA_GROUP
```
public static final ConfigurationKey SERVICES_GANGLIA_GROUP
```
    Ganglia group.
  - SERVICES_GANGLIA_MULTICAST_INTERFACE
```
public static final ConfigurationKey SERVICES_GANGLIA_MULTICAST_INTERFACE
```
    Explicit multicast interface.
  - SERVICES_STATSD_PORT
```
public static final ConfigurationKey SERVICES_STATSD_PORT
```
    UDP port for statsd type of messages.
  - SERVICES_COLLECTD_PORT
```
public static final ConfigurationKey SERVICES_COLLECTD_PORT
```
    UDP port for collectd type of messages.
  - SERVICES_GRAPHITE_PORT
```
public static final ConfigurationKey SERVICES_GRAPHITE_PORT
```
    TCP port for graphite type of messages.
  - METRICS_URL
```
public static final ConfigurationKey METRICS_URL
```
    Metrics service url.
  - METRICS_TENANT_SEND
```
public static final ConfigurationKey METRICS_TENANT_SEND
```
    Tenant Header switch. Older versions of Hawkular reject requests having a tenant header.
  - METRICS_TENANT
```
public static final ConfigurationKey METRICS_TENANT
```
    Tenant selection. Ignored if METRICS_TENANT_SEND property is set to false.
  - METRICS_AUTH_ENABLED
```
public static final ConfigurationKey METRICS_AUTH_ENABLED
```
    Authentication switch.
  - METRICS_AUTH_ID
```
public static final ConfigurationKey METRICS_AUTH_ID
```
    Authentication id.
  - METRICS_AUTH_SECRET
```
public static final ConfigurationKey METRICS_AUTH_SECRET
```
    Authentication secret.
  - METRICS_MAX_CONNECTIONS
```
public static final ConfigurationKey METRICS_MAX_CONNECTIONS
```
    Maximum number of HTTP connections used to send metrics to the backend.
  - METRICS_BATCH_SIZE
```
public static final ConfigurationKey METRICS_BATCH_SIZE
```
    Size of the metric batches sent to the backend.
- Method Detail
  - values
```
public static ConfigurationKey[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ConfigurationKey c : ConfigurationKey.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ConfigurationKey valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<ConfigurationKey>
    
    Returns:
    
    string representation of this configuration key

Enum ConfigurationKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SERVICES

SERVICES_UDP_PORT

SERVICES_TCP_PORT

SERVICES_GANGLIA_PORT

SERVICES_GANGLIA_GROUP

SERVICES_GANGLIA_MULTICAST_INTERFACE

SERVICES_STATSD_PORT

SERVICES_COLLECTD_PORT

SERVICES_GRAPHITE_PORT

METRICS_URL

METRICS_TENANT_SEND

METRICS_TENANT

METRICS_AUTH_ENABLED

METRICS_AUTH_ID

METRICS_AUTH_SECRET

METRICS_MAX_CONNECTIONS

METRICS_BATCH_SIZE

Method Detail

values

valueOf

toString