org.jboss.osgi.spi.capability
Class Capability

java.lang.Object
  org.jboss.osgi.spi.capability.Capability

Direct Known Subclasses:

CompendiumCapability, ConfigAdminCapability, EventAdminCapability, HttpServiceCapability, LogServiceCapability

public abstract class Capability
extends java.lang.Object

An abstract OSGi capability that can be installed in an OSGiRuntime. The capability is only installed if the service name given in the constructor is not already registered with the OSGi framework. It maintains an ordered set of dependent capabilities and bundles that must be installed to provide the functionality advertised by this capability.

Since:

05-May-2009

Author:

thomas.diesler@jboss.com

Constructor Summary

Capability(java.lang.String serviceName)
Construct a capability that is identified by the given service name.

Capability(java.lang.String serviceName, java.lang.String filter)
Construct a capability that is identified by the given service name and filter string.

Method Summary

protected void	addBundle(java.lang.String location)
protected void	addDependency(Capability dependency)
void	addSystemProperty(java.lang.String key, java.lang.String value) Add a system property provided by this capability.
java.util.List<BundleInfo>	getBundles()
java.util.List<Capability>	getDependencies()
java.lang.String	getFilter() Get the filter that is used for service lookup.
java.lang.String	getServiceName() Get the service name associated with this capability.
java.util.Map<java.lang.String,java.lang.String>	getSystemProperties() Get the system properties for this capability.
void	setFilter(java.lang.String filter) Set the filter that is used for service lookup.

Methods inherited from class java.lang.Object

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

Constructor Detail

Capability

public Capability(java.lang.String serviceName)

Construct a capability that is identified by the given service name. If the service name is already registered with the OSGiRuntime adding this capability does nothing. If the service name is null the capability will install each associated bundle unless a bundle with the same symbolic name is already installed.

Parameters:

serviceName - The service that would be registered by this capability.

Capability

public Capability(java.lang.String serviceName,
                  java.lang.String filter)

Construct a capability that is identified by the given service name and filter string. If the service is already registered with the OSGiRuntime adding this capability does nothing.

Method Detail

getServiceName

public java.lang.String getServiceName()

Get the service name associated with this capability.

getFilter

public java.lang.String getFilter()

Get the filter that is used for service lookup.

setFilter

public void setFilter(java.lang.String filter)

Set the filter that is used for service lookup.

addSystemProperty

public void addSystemProperty(java.lang.String key,
                              java.lang.String value)

Add a system property provided by this capability. Adding this capability will set the associated system properties if a propperty is not set already.

getSystemProperties

public java.util.Map<java.lang.String,java.lang.String> getSystemProperties()

Get the system properties for this capability.

getDependencies

public java.util.List<Capability> getDependencies()

addDependency

protected void addDependency(Capability dependency)

getBundles

public java.util.List<BundleInfo> getBundles()

addBundle

protected void addBundle(java.lang.String location)