org.apache.brooklyn.api.mgmt.SubscriptionContext Maven / Gradle / Ivy
/*
* 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.api.mgmt;
import java.util.Map;
import java.util.Set;
import org.apache.brooklyn.api.entity.Entity;
import org.apache.brooklyn.api.entity.Group;
import org.apache.brooklyn.api.sensor.Sensor;
import org.apache.brooklyn.api.sensor.SensorEvent;
import org.apache.brooklyn.api.sensor.SensorEventListener;
/**
* This is the context through which an {@link Entity} can manage its subscriptions.
*/
public interface SubscriptionContext {
/**
* As {@link SubscriptionManager#subscribe(Map, Entity, Sensor, SensorEventListener)} with default subscription parameters for this context
*/
SubscriptionHandle subscribe(Map flags, Entity producer, Sensor sensor, SensorEventListener super T> listener);
/** @see #subscribe(Map, Entity, Sensor, SensorEventListener) */
SubscriptionHandle subscribe(Entity producer, Sensor sensor, SensorEventListener super T> listener);
/** @see #subscribe(Map, Entity, Sensor, SensorEventListener) */
SubscriptionHandle subscribeToChildren(Map flags, Entity parent, Sensor sensor, SensorEventListener super T> listener);
/** @see #subscribe(Map, Entity, Sensor, SensorEventListener) */
SubscriptionHandle subscribeToChildren(Entity parent, Sensor sensor, SensorEventListener super T> listener);
/** @see #subscribe(Map, Entity, Sensor, SensorEventListener) */
SubscriptionHandle subscribeToMembers(Map flags, Group parent, Sensor sensor, SensorEventListener super T> listener);
/** @see #subscribe(Map, Entity, Sensor, SensorEventListener) */
SubscriptionHandle subscribeToMembers(Group parent, Sensor sensor, SensorEventListener super T> listener);
/** @see SubscriptionManager#unsubscribe(SubscriptionHandle) */
boolean unsubscribe(SubscriptionHandle subscriptionId);
/** causes all subscriptions to be deregistered
* @return number of subscriptions removed */
int unsubscribeAll();
/** @see SubscriptionManager#publish(SensorEvent) */
void publish(SensorEvent event);
/** Return the subscriptions associated with this context */
Set getSubscriptions();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy