PluginToRuleMsg.java

/**
 * Copyright © 2016 The Thingsboard Authors
 *
 * Licensed 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.thingsboard.server.extensions.api.plugins.msg;

import org.thingsboard.server.common.data.id.RuleId;
import org.thingsboard.server.common.data.id.TenantId;
import org.thingsboard.server.extensions.api.rules.ToRuleActorMsg;

import java.io.Serializable;
import java.util.UUID;

/**
 * The basic interface for messages that are sent from particular plugin to rule
 * instance
 * 
 * @author ashvayka
 * @see RuleToPluginMsg
 *
 */
public interface PluginToRuleMsg<V extends Serializable> extends ToRuleActorMsg, Serializable {

    /**
     * Returns the unique identifier of the message
     * 
     * @return unique identifier of the message.
     */
    UUID getUid();

    /**
     * Returns the unique identifier of the tenant that owns the rule
     *
     * @return unique identifier of the tenant that owns the rule.
     *
     */
    TenantId getTenantId();

    /**
     * Returns the unique identifier of the rule
     * 
     * @return unique identifier of the rule.
     */
    RuleId getRuleId();

    /**
     * Returns the serializable message payload.
     * 
     * @return the serializable message payload.
     */
    V getPayload();

}