| /* |
| * 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.dm; |
| |
| import java.util.Dictionary; |
| |
| /** |
| * Generic dependency for a component. A dependency can be required or not. |
| * A dependency will be activated by the component it belongs to. The component |
| * will call the <code>start(Service service)</code> and |
| * <code>stop(Service service)</code> methods. |
| * |
| * After it has been started, a dependency must callback |
| * the associated component's <code>dependencyAvailable()</code> and |
| * <code>dependencyUnavailable()</code> |
| * methods. State changes of the dependency itself may only be made as long as |
| * the dependency is not 'active', meaning it is associated with a running component. |
| * |
| * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a> |
| */ |
| public interface Dependency { |
| /** |
| * Returns <code>true</code> if this a required dependency. Required dependencies |
| * are dependencies that must be available before the component can be activated. |
| * |
| * @return <code>true</code> if the dependency is required |
| */ |
| public boolean isRequired(); |
| |
| /** |
| * Returns <code>true</code> if the dependency is available. |
| * |
| * @return <code>true</code> if the dependency is available |
| */ |
| public boolean isAvailable(); |
| |
| /** |
| * As soon as the instance is created, keep it around, even if this dependency |
| * goes away. |
| * |
| * @return <code>true</code> if the dependency is instance bound |
| */ |
| public boolean isInstanceBound(); |
| |
| /** |
| * Returns <code>true>code> if auto configuration is enabled for this dependency. |
| * Auto configuration means that a dependency is injected in the component instance |
| * when it's available, and if it's unavailable, a "null object" will be inserted |
| * instead. |
| * |
| * @return <code>true</code> if auto configuration is enabled for this dependency |
| */ |
| public boolean isAutoConfig(); |
| |
| /** |
| * Returns the type of the instance that is injected. |
| * |
| * @return the type of the instance that is injected |
| */ |
| public Class getAutoConfigType(); |
| |
| /** |
| * Returns the instance that is injected. |
| * |
| * @return the instance that is injected |
| */ |
| public Object getAutoConfigInstance(); |
| |
| /** |
| * Returns the name of the member in the class of the component instance |
| * to inject into. If you specify this, not all members of the right |
| * type will be injected, only the member whose name matches. |
| * |
| * @return |
| */ |
| public String getAutoConfigName(); |
| |
| /** |
| * Invoke the "added" callback on a required dependency. |
| * |
| * @param service |
| */ |
| public void invokeAdded(DependencyService service); |
| |
| /** |
| * Invoke the "removed" callback on a required dependency. |
| * |
| * @param service |
| */ |
| public void invokeRemoved(DependencyService service); |
| |
| public boolean isPropagated(); |
| public Dictionary getProperties(); |
| |
| /** |
| * Creates a copy of this dependency, cloning all declared state, but not the runtime state. |
| */ |
| public Dependency createCopy(); |
| } |