org.apache.felix.dm.diagnostics

Class DependencyGraph

java.lang.Object

org.apache.felix.dm.diagnostics.DependencyGraph

public class DependencyGraph
extends java.lang.Object

The dependency graph is a view of all components managed by the dependency manager and of their dependencies. Using this API you can get the dependencies of a given component, the components providing a given service, the circular dependencies that might exist.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DependencyGraph.ComponentState Use this to specify which components the dependency graph should contain
static class	DependencyGraph.DependencyState Use this to specify which dependencies the graph should contain

Method Summary

Modifier and Type	Method and Description
java.util.List<ComponentDeclaration>	getAllComponents() Returns the list of components in the graph
java.util.List<ComponentDependencyDeclaration>	getAllDependencies() Returns a list all dependencies in the graph
java.util.List<CircularDependency>	getCircularDependencies() Returns the list of circular dependencies in the graph
java.util.List<ComponentDependencyDeclaration>	getDependecies(ComponentDeclaration componentDeclaration) For a given component declaration, it returns a list of its dependencies in the state specified when the graph was built.
static DependencyGraph	getGraph(DependencyGraph.ComponentState componentState, DependencyGraph.DependencyState dependencyState) Build the dependency graph.
java.util.List<MissingDependency>	getMissingCustomDependencies() Returns all custom missing dependencies.
java.util.List<MissingDependency>	getMissingDependencies(java.lang.String type) Returns all the missing dependencies of a given type.
java.util.List<ComponentDeclaration>	getProviders(ComponentDependencyDeclaration dependency) Returns the list of components that provide the given dependency.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getGraph

public static DependencyGraph getGraph(DependencyGraph.ComponentState componentState,
                                       DependencyGraph.DependencyState dependencyState)

Build the dependency graph. It will contain all the components managed by the dependency manager, provided that those components are in the given state, and all dependencies of their dependencies, provided that the dependencies are in the given state.

This implementation currently only builds a graph of unregistered components and required unavailable dependencies.

Parameters:

componentState - Include only the components in this state

dependencyState - Include only the dependencies in this state

Returns:

getAllComponents

public java.util.List<ComponentDeclaration> getAllComponents()

Returns the list of components in the graph

Returns:

the list of components in the graph

getAllDependencies

public java.util.List<ComponentDependencyDeclaration> getAllDependencies()

Returns a list all dependencies in the graph

Returns:

the list of all dependencies in the graph

getDependecies

public java.util.List<ComponentDependencyDeclaration> getDependecies(ComponentDeclaration componentDeclaration)

For a given component declaration, it returns a list of its dependencies in the state specified when the graph was built.

Parameters:

componentDeclaration -

Returns:

the list of dependencies or null if the component declaration is not in the graph

getProviders

public java.util.List<ComponentDeclaration> getProviders(ComponentDependencyDeclaration dependency)

Returns the list of components that provide the given dependency. This only returns the components managed by the dependency manager that are in the state specified when the graph was built. The dependency can only be a service dependency.

Parameters:

dependency -

Returns:

the list of components providing this dependency or null if the dependency declaration is not in the graph

getCircularDependencies

public java.util.List<CircularDependency> getCircularDependencies()

Returns the list of circular dependencies in the graph

Returns:

the list of circular dependencies

getMissingDependencies

public java.util.List<MissingDependency> getMissingDependencies(java.lang.String type)

Returns all the missing dependencies of a given type.

Parameters:

type - The type of the dependencies to be returned. This can be either one of the types known by the DependencyManager (service, bundle, configuration, resource), a user defined type or null, in which case all missing dependencies must be returned.

Returns:

The missing dependencies of the given type or all the missing dependencies.

getMissingCustomDependencies

public java.util.List<MissingDependency> getMissingCustomDependencies()

Returns all custom missing dependencies. Custom dependencies are not 'out of the box' dependencies (service, resource, bundle, configuration).

Returns:

The missing dependencies which are not 'out of the box dependencies'.