/*
* 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.entity.stock;
import java.util.Map;
import org.apache.brooklyn.api.entity.Entity;
import org.apache.brooklyn.api.entity.ImplementedBy;
import org.apache.brooklyn.api.sensor.AttributeSensor;
import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.config.ConfigKeys;
import org.apache.brooklyn.core.entity.trait.Startable;
import org.apache.brooklyn.util.core.flags.SetFromFlag;
import com.google.common.base.Supplier;
import com.google.common.reflect.TypeToken;
/**
* An entity that supplies data as {@link AttributeSensor} values.
* <p>
* Usage:
* <pre>{@code
* EntitySpec.create(DataEntity.class)
* .configure(SENSOR_DATA_MAP, MutableMap.builder()
* .put(Sensors.newStringSensor("string.data"), new Supplier<String>() { ... })
* .put(Sensors.newLongSensor("long.data"), new Supplier<Long>() { ... })
* .build());
* }</pre>
*/
@ImplementedBy(DataEntityImpl.class)
public interface DataEntity extends Entity, Startable {
@SetFromFlag("pollPeriod")
ConfigKey<Long> POLL_PERIOD = ConfigKeys.newLongConfigKey(
"data.sensorpoll", "Poll period (in milliseconds)", 1000L);
@SetFromFlag("sensorSuppliers")
ConfigKey<Map<AttributeSensor<?>, Supplier<?>>> SENSOR_SUPPLIER_MAP = ConfigKeys.newConfigKey(
new TypeToken<Map<AttributeSensor<?>, Supplier<?>>>() { },
"data.sensorSupplierMap", "Map linking sensors and data suppliers");
}