api/src/main/java/org/apache/unomi/api/PluginType.java

/*
 * 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.unomi.api;

/**
 * The interface for unomi plugins.
 */
public interface PluginType {

    /**
     * Retrieves the plugin identifier, corresponding to the identifier of the OSGi bundle implementing the plugin.
     *
     * @return the plugin identifier, corresponding to the identifier of the OSGi bundle implementing the plugin
     */
    long getPluginId();

    /**
     * Associates this plugin with its associated OSGi bundle identifier.
     *
     * @param pluginId the OSGi bundle identifier associated with this plugin
     */
    void setPluginId(long pluginId);

}