OSGIServiceRegistration.java

/*
 * Copyright 2010-2013 Ning, Inc.
 *
 * Ning 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 com.ning.billing.osgi.api;

import java.util.List;
import java.util.Set;

/**
 *
 * The purpose is to register within Killbill OSGI services
 * that were exported by specific Killbill plugins
 *
 * @param <T> The OSGI service exported by Killbill bundles
 */
public interface OSGIServiceRegistration<T> {

    /**
     *
     * @param pluginName the name of plugin
     * @param service    the instance that should be registered
     */
    void registerService(String pluginName, T service);

    /**
     *
     * @param pluginName the name of plugin
     */
    void unregisterService(String pluginName);

    /**
     *
     * @param pluginName the name of plugin
     * @return the instance that was registered under that name
     */
    T getServiceForPluginName(String pluginName);

    /**
     *
     * @return the set of all the plugins registered
     */
    Set<String> getAllServiceForPluginName();

    /**
     *
     * @return the type of service that is registered under that OSGIServiceRegistration
     */
    Class<T> getServiceType();
}