org.apache.felix.scr.ScrService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.felix.scr.compat Show documentation
Extensions of the DS Implementation to provide compatibility with API from older Apache Felix DS implementations.
The newest version!
/*
 * 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.felix.scr;


import org.osgi.framework.Bundle;


/**
 * The ScrService represents the Declarative Services main
 * controller also known as the Service Component Runtime or SCR for short.
 * It provides access to the components managed the SCR.
 *
 * @deprecated Use the ServiceComponentRuntime service.
 */
@Deprecated
public interface ScrService
{

    /**
     * Returns an array of all components managed by this SCR instance. The
     * components are returned in ascending order of their component.id. If
     * there are no components currently managed by the SCR, null
     * is returned.
     *
     * @return The components or null if there are none.
     */
    Component[] getComponents();


    /**
     * Returns the component whose component.id matches the given
     * componentId or null if no component with the
     * given id is currently managed.
     *
     * @param componentId The ID of the component to return
     *
     * @return The indicated component or null if no such
     *      component exists.
     */
    Component getComponent( long componentId );


    /**
     * Returns the components whose component.name matches the
     * given componentName or null if no component
     * with the given name is currently managed.
     * 
     * If the component name refers to a component factory component or a
     * component configured with multiple factory configurations this method
     * returns multiple component instances.
     *
     * @param componentName The name of the component to return
     *
     * @return The indicated components or null if no such
     *      component exists.
     * @since 1.5 (Apache Felix Declarative Services 1.4.2)
     */
    Component[] getComponents( String componentName );


    /**
     * Reuturns an array of all components managed by this SCR instance on
     * behalf of the given bundle. The components are returned in ascending
     * order of their component.id. If there are no components managed by the
     * SCR for the given bundle, null is returned.
     *
     * @param bundle The Bundle whose components are to be
     *      returned.
     *
     * @return The bundle's components or null if the bundle
     *      has none.
     */
    Component[] getComponents( Bundle bundle );

}