/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.brooklyn.core.entity;
import java.net.URI;
import java.util.List;
import java.util.Map;
import org.apache.brooklyn.api.mgmt.ManagementContext;
import org.apache.brooklyn.api.sensor.AttributeSensor;
import org.apache.brooklyn.api.sensor.Sensor;
import org.apache.brooklyn.core.config.render.RendererHints;
import org.apache.brooklyn.core.entity.lifecycle.Lifecycle;
import org.apache.brooklyn.core.sensor.BasicAttributeSensor;
import org.apache.brooklyn.core.sensor.BasicAttributeSensorAndConfigKey;
import org.apache.brooklyn.core.sensor.BasicNotificationSensor;
import org.apache.brooklyn.core.sensor.PortAttributeSensorAndConfigKey;
import org.apache.brooklyn.core.sensor.Sensors;
import org.apache.brooklyn.util.net.UserAndHostAndPort;
import com.google.common.annotations.Beta;
import com.google.common.collect.ImmutableList;
import com.google.common.reflect.TypeToken;
/**
* This interface should be used to access {@link Sensor} definitions.
*/
public interface Attributes {
BasicNotificationSensor<Void> LOCATION_CHANGED = new BasicNotificationSensor<Void>(
Void.class, "entity.locationChanged", "Indicates that an entity's location has been changed");
// TODO these should switch to being TemplatedStringAttributeSensorAndConfigKey
BasicAttributeSensorAndConfigKey<String> DOWNLOAD_URL = new BasicAttributeSensorAndConfigKey<String>(
String.class, "download.url", "URL pattern for downloading the installer (will substitute things like ${version} automatically)");
@SuppressWarnings({ "unchecked", "rawtypes" })
BasicAttributeSensorAndConfigKey<Map<String,String>> DOWNLOAD_ADDON_URLS = new BasicAttributeSensorAndConfigKey(
Map.class, "download.addon.urls", "URL patterns for downloading named add-ons (will substitute things like ${version} automatically)");
/*
* Port number attributes.
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
AttributeSensor<List<Integer>> PORT_NUMBERS = new BasicAttributeSensor(
List.class, "port.list", "List of port numbers");
@SuppressWarnings({ "unchecked", "rawtypes" })
AttributeSensor<List<Sensor<Integer>>> PORT_SENSORS = new BasicAttributeSensor(
List.class, "port.list.sensors", "List of port number attributes");
PortAttributeSensorAndConfigKey HTTP_PORT = new PortAttributeSensorAndConfigKey(
"http.port", "HTTP port", ImmutableList.of(8080,"18080+"));
PortAttributeSensorAndConfigKey HTTPS_PORT = new PortAttributeSensorAndConfigKey(
"https.port", "HTTP port (with SSL/TLS)", ImmutableList.of(8443,"18443+"));
PortAttributeSensorAndConfigKey SSH_PORT = new PortAttributeSensorAndConfigKey("ssh.port", "SSH port", 22);
PortAttributeSensorAndConfigKey SMTP_PORT = new PortAttributeSensorAndConfigKey("smtp.port", "SMTP port", 25);
PortAttributeSensorAndConfigKey DNS_PORT = new PortAttributeSensorAndConfigKey("dns.port", "DNS port", 53);
PortAttributeSensorAndConfigKey AMQP_PORT = new PortAttributeSensorAndConfigKey("amqp.port", "AMQP port", "5672+");
/*
* Location/connection attributes.
*/
AttributeSensor<String> HOSTNAME = Sensors.newStringSensor( "host.name", "Host name");
AttributeSensor<String> ADDRESS = Sensors.newStringSensor( "host.address", "Host IP address");
AttributeSensor<UserAndHostAndPort> SSH_ADDRESS = Sensors.newSensor(
UserAndHostAndPort.class,
"host.sshAddress",
"user@host:port for ssh'ing (or null if inappropriate)");
AttributeSensor<UserAndHostAndPort> WINRM_ADDRESS = Sensors.newSensor(
UserAndHostAndPort.class,
"host.winrmAddress",
"user@host:port for WinRM'ing (or null if inappropriate)");
AttributeSensor<String> SUBNET_HOSTNAME = Sensors.newStringSensor( "host.subnet.hostname", "Host name as known internally in " +
"the subnet where it is running (if different to host.name)");
AttributeSensor<String> SUBNET_ADDRESS = Sensors.newStringSensor( "host.subnet.address", "Host address as known internally in " +
"the subnet where it is running (if different to host.name)");
AttributeSensor<String> HOST_AND_PORT = Sensors.newStringSensor( "hostandport", "host:port" );
/*
* Lifecycle attributes
*/
AttributeSensor<Boolean> SERVICE_UP = Sensors.newBooleanSensor("service.isUp",
"Whether the service is active and availability (confirmed and monitored)");
@SuppressWarnings("serial")
AttributeSensor<Map<String,Object>> SERVICE_NOT_UP_INDICATORS = Sensors.newSensor(
new TypeToken<Map<String,Object>>() {},
"service.notUp.indicators",
"A map of namespaced indicators that the service is not up");
@SuppressWarnings("serial")
AttributeSensor<Map<String,Object>> SERVICE_PROBLEMS = Sensors.newSensor(
new TypeToken<Map<String,Object>>() {},
"service.problems",
"A map of namespaced indicators of problems with a service");
/**
* @since 0.8.0
*/
@SuppressWarnings("serial")
AttributeSensor<Map<String,Object>> SERVICE_NOT_UP_DIAGNOSTICS = Sensors.newSensor(
new TypeToken<Map<String,Object>>() {},
"service.notUp.diagnostics",
"A map of namespaced diagnostics, from when the service is not up");
AttributeSensor<Lifecycle> SERVICE_STATE_ACTUAL = Sensors.newSensor(Lifecycle.class,
"service.state", "Actual lifecycle state of the service");
AttributeSensor<Lifecycle.Transition> SERVICE_STATE_EXPECTED = Sensors.newSensor(Lifecycle.Transition.class,
"service.state.expected", "Last controlled change to service state, indicating what the expected state should be");
/** @deprecated since 0.7.0 use {@link #SERVICE_STATE_ACTUAL} or {@link #SERVICE_STATE_EXPECTED} as appropriate. */
@Deprecated
AttributeSensor<Lifecycle> SERVICE_STATE = SERVICE_STATE_ACTUAL;
/*
* Other metadata (optional)
*/
AttributeSensor<Integer> PID = Sensors.newIntegerSensor("pid", "Process ID for the previously launched instance");
AttributeSensor<String> LOG_FILE_LOCATION = Sensors.newStringSensor("log.location", "Log file location");
AttributeSensor<URI> MAIN_URI = MainUri.MAIN_URI;
// this class is added because the MAIN_URI relies on a static initialization which unfortunately can't be added to an interface.
class MainUri {
private final static AttributeSensor<URI> MAIN_URI = Sensors.newSensor(URI.class, "main.uri", "Main URI for contacting the service/endpoint offered by this entity");
static {
RendererHints.register(MAIN_URI, RendererHints.namedActionWithUrl());
}
}
/*
* Brooklyn management attributes (optional)
*/
/**
* Used by entities registering a {@link ManagementContext.PropertiesReloadListener} to store a persistent
* reference to it, for use when unregistering the listener.
*/
@Beta
AttributeSensor<ManagementContext.PropertiesReloadListener> PROPERTIES_RELOAD_LISTENER = Sensors.newSensor(
ManagementContext.PropertiesReloadListener.class,
"brooklyn.management.propertiesReloadListener", "Properties reload listener");
}