C D E G I L N O R S

C

Component - Interface in org.apache.felix.scr

The Component interface represents a single component managed by the Service Component Runtime.

COMPONENT_FACTORY - Static variable in interface org.osgi.service.component.ComponentConstants

A service registration property for a Component Factory that contains the value of the factory attribute.

COMPONENT_ID - Static variable in interface org.osgi.service.component.ComponentConstants

A component property that contains the generated id for a component configuration.

COMPONENT_NAME - Static variable in interface org.osgi.service.component.ComponentConstants

A component property for a component configuration that contains the name of the component as specified in the name attribute of the component element.

ComponentConstants - Interface in org.osgi.service.component

Defines standard names for Service Component constants.

ComponentContext - Interface in org.osgi.service.component

A Component Context object is used by a component instance to interact with its execution context including locating services by reference name.

ComponentException - Exception in org.osgi.service.component

Unchecked exception which may be thrown by the Service Component Runtime.

ComponentException(String, Throwable) - Constructor for exception org.osgi.service.component.ComponentException

Construct a new ComponentException with the specified message and cause.

ComponentException(String) - Constructor for exception org.osgi.service.component.ComponentException

Construct a new ComponentException with the specified message.

ComponentException(Throwable) - Constructor for exception org.osgi.service.component.ComponentException

Construct a new ComponentException with the specified cause.

ComponentFactory - Interface in org.osgi.service.component

When a component is declared with the factory attribute on its component element, the Service Component Runtime will register a Component Factory service to allow new component configurations to be created and activated rather than automatically creating and activating component configuration as necessary.

ComponentInstance - Interface in org.osgi.service.component

A ComponentInstance encapsulates a component instance of an activated component configuration.

D

DEACTIVATION_REASON_BUNDLE_STOPPED - Static variable in interface org.osgi.service.component.ComponentConstants

The component configuration was deactivated because the bundle was stopped.

DEACTIVATION_REASON_CONFIGURATION_DELETED - Static variable in interface org.osgi.service.component.ComponentConstants

The component configuration was deactivated because its configuration was deleted.

DEACTIVATION_REASON_CONFIGURATION_MODIFIED - Static variable in interface org.osgi.service.component.ComponentConstants

The component configuration was deactivated because its configuration was changed.

DEACTIVATION_REASON_DISABLED - Static variable in interface org.osgi.service.component.ComponentConstants

The component configuration was deactivated because the component was disabled.

DEACTIVATION_REASON_DISPOSED - Static variable in interface org.osgi.service.component.ComponentConstants

The component configuration was deactivated because the component was disposed.

DEACTIVATION_REASON_REFERENCE - Static variable in interface org.osgi.service.component.ComponentConstants

The component configuration was deactivated because a reference became unsatisfied.

DEACTIVATION_REASON_UNSPECIFIED - Static variable in interface org.osgi.service.component.ComponentConstants

The reason the component configuration was deactivated is unspecified.

disable() - Method in interface org.apache.felix.scr.Component

Disables this Component if it is enabled.

disableComponent(String) - Method in interface org.osgi.service.component.ComponentContext

Disables the specified component name.

dispose() - Method in interface org.osgi.service.component.ComponentInstance

Dispose of the component configuration for this component instance.

E

enable() - Method in interface org.apache.felix.scr.Component

Enables this Component if it is disabled.

enableComponent(String) - Method in interface org.osgi.service.component.ComponentContext

Enables the specified component name.

G

getActivate() - Method in interface org.apache.felix.scr.Component

Returns the name of the method to be called when the component is being activated.

getBindMethodName() - Method in interface org.apache.felix.scr.Reference

Returns the name of the method called if a service is being bound to the Component or null if no such method is configued.

getBundle() - Method in interface org.apache.felix.scr.Component

Returns the Bundle declaring this component.

getBundleContext() - Method in interface org.osgi.service.component.ComponentContext

Returns the BundleContext of the bundle which contains this component.

getCause() - Method in exception org.osgi.service.component.ComponentException

Returns the cause of this exception or null if no cause was set.

getClassName() - Method in interface org.apache.felix.scr.Component

Returns the class name of the Component implementation.

getComponent(long) - Method in interface org.apache.felix.scr.ScrService

Returns the component whose component.id matches the given componentId or null if no component with the given id is currently managed.

getComponentInstance() - Method in interface org.apache.felix.scr.Component

Returns the org.osgi.service.component.ComponentInstance representing this component or null if this component is not been activated yet.

getComponentInstance() - Method in interface org.osgi.service.component.ComponentContext

Returns the Component Instance object for the component instance associated with this Component Context.

getComponents() - Method in interface org.apache.felix.scr.ScrService

Returns an array of all components managed by this SCR instance.

getComponents(String) - Method in interface org.apache.felix.scr.ScrService

Returns the components whose component.name matches the given componentName or null if no component with the given name is currently managed.

getComponents(Bundle) - Method in interface org.apache.felix.scr.ScrService

Reuturns an array of all components managed by this SCR instance on behalf of the given bundle.

getConfigurationPolicy() - Method in interface org.apache.felix.scr.Component

Reuturns the configuration policy declared in the component descriptor.

getDeactivate() - Method in interface org.apache.felix.scr.Component

Returns the name of the method to be called when the component is being deactivated.

getFactory() - Method in interface org.apache.felix.scr.Component

Returns the component factory name or null if this component is not defined as a component factory.

getId() - Method in interface org.apache.felix.scr.Component

Returns the component ID of this component.

getInstance() - Method in interface org.osgi.service.component.ComponentInstance

Returns the component instance of the activated component configuration.

getModified() - Method in interface org.apache.felix.scr.Component

Returns the name of the method to be called when the component configuration has been updated or null if such a method is not declared in the component descriptor.

getName() - Method in interface org.apache.felix.scr.Component

Returns the name of the component, which is also used as the service PID.

getName() - Method in interface org.apache.felix.scr.Reference

Returns the name of this Reference.

getProperties() - Method in interface org.apache.felix.scr.Component

Returns the properties of the Component.

getProperties() - Method in interface org.osgi.service.component.ComponentContext

Returns the component properties for this Component Context.

getReferences() - Method in interface org.apache.felix.scr.Component

Returns an array of Reference instances representing the service references (or dependencies) of this Component.

getServiceName() - Method in interface org.apache.felix.scr.Reference

Returns the name of the service used by this Reference.

getServiceReference() - Method in interface org.osgi.service.component.ComponentContext

If the component instance is registered as a service using the service element, then this method returns the service reference of the service provided by this component instance.

getServiceReferences() - Method in interface org.apache.felix.scr.Reference

Returns an array of references to the services bound to this Reference or null if no services are currently bound.

getServices() - Method in interface org.apache.felix.scr.Component

Returns an array of service names provided by this Component or null if the Component is not registered as a service.

getState() - Method in interface org.apache.felix.scr.Component

Returns the current state of the Component, which is one of the STATE_* constants defined in this interface.

getTarget() - Method in interface org.apache.felix.scr.Reference

Returns the value of the target property of this reference.

getUnbindMethodName() - Method in interface org.apache.felix.scr.Reference

Returns the name of the method called if a service is being unbound from the Component or null if no such method is configued.

getUpdatedMethodName() - Method in interface org.apache.felix.scr.Reference

Returns the name of the method called if a bound service updates its service registration properties or null if no such method is configued.

getUsingBundle() - Method in interface org.osgi.service.component.ComponentContext

If the component instance is registered as a service using the servicefactory="true" attribute, then this method returns the bundle using the service provided by the component instance.

I

initCause(Throwable) - Method in exception org.osgi.service.component.ComponentException

Initializes the cause of this exception to the specified value.

isActivateDeclared() - Method in interface org.apache.felix.scr.Component

Returns true if the name of the method to be called on component activation (see Component.getActivate() is declared in the component descriptor or not.

isDeactivateDeclared() - Method in interface org.apache.felix.scr.Component

Returns true if the name of the method to be called on component deactivation (see Component.getDeactivate() is declared in the component descriptor or not.

isDefaultEnabled() - Method in interface org.apache.felix.scr.Component

Returns whether the Component is declared to be enabled initially.

isImmediate() - Method in interface org.apache.felix.scr.Component

Returns whether the Component is an Immediate or a Delayed Component.

isMultiple() - Method in interface org.apache.felix.scr.Reference

Returns whether this reference is multiple.

isOptional() - Method in interface org.apache.felix.scr.Reference

Returns whether this reference is optional.

isSatisfied() - Method in interface org.apache.felix.scr.Reference

Returns whether this reference is satisified.

isServiceFactory() - Method in interface org.apache.felix.scr.Component

Returns true if this component is a service factory.

isStatic() - Method in interface org.apache.felix.scr.Reference

Returns true if the reference is defined with static policy.

L

locateService(String) - Method in interface org.osgi.service.component.ComponentContext

Returns the service object for the specified reference name.

locateService(String, ServiceReference) - Method in interface org.osgi.service.component.ComponentContext

Returns the service object for the specified reference name and ServiceReference.

locateServices(String) - Method in interface org.osgi.service.component.ComponentContext

Returns the service objects for the specified reference name.

N

newInstance(Dictionary) - Method in interface org.osgi.service.component.ComponentFactory

Create and activate a new component configuration.

O

org.apache.felix.scr - package org.apache.felix.scr

org.osgi.service.component - package org.osgi.service.component

Service Component Package Version 1.2.

R

Reference - Interface in org.apache.felix.scr

The Reference interface represents a single reference (or dependency) to a service used by a Component.

REFERENCE_TARGET_SUFFIX - Static variable in interface org.osgi.service.component.ComponentConstants

The suffix for reference target properties.

S

ScrService - Interface in org.apache.felix.scr

The ScrService represents the Declarative Services main controller also known as the Service Component Runtime or SCR for short.

SERVICE_COMPONENT - Static variable in interface org.osgi.service.component.ComponentConstants

Manifest header specifying the XML documents within a bundle that contain the bundle's Service Component descriptions.

STATE_ACTIVATING - Static variable in interface org.apache.felix.scr.Component

The Component is currently being activated either because it has been enabled or because any dependency which was previously unsatisfied has become satisfied (value is 8).

STATE_ACTIVE - Static variable in interface org.apache.felix.scr.Component

The Component has successfully been activated and is fully functional (value is 16).

STATE_DEACTIVATING - Static variable in interface org.apache.felix.scr.Component

The Component is being deactivated either because it is being disabled or because a dependency is not satisfied any more (value is 128).

STATE_DESTROYED - Static variable in interface org.apache.felix.scr.Component

Deprecated. as of version 1.2 this constant has been renamed to Component.STATE_DISPOSED.

STATE_DISABLED - Static variable in interface org.apache.felix.scr.Component

The Component has just been created and is still disabled or it has been disabled by calling the Component.disable() method (value is 1).

STATE_DISABLING - Static variable in interface org.apache.felix.scr.Component

The Component is being disabled (value is 1024).

STATE_DISPOSED - Static variable in interface org.apache.felix.scr.Component

The Component has been disposed off and cannot be used any more (value is 256).

STATE_DISPOSING - Static variable in interface org.apache.felix.scr.Component

The Component is being disposed off (value is 2048).

STATE_ENABLED - Static variable in interface org.apache.felix.scr.Component

Deprecated. as of version 1.2 the enabled state is collapsed into the Component.STATE_UNSATISFIED state. This status code is never returned from the Component.getState() method.

STATE_ENABLING - Static variable in interface org.apache.felix.scr.Component

The Component is being enabled (value is 512).

STATE_FACTORY - Static variable in interface org.apache.felix.scr.Component

The Component is a Component Factory ready to create Component instances with the ComponentFactory.newInstance(Dictionary) method or (if enabled with the ds.factory.enabled configuration) to manage Component instances from configuration data received from the Configuration Admin Service (value is 64).

STATE_REGISTERED - Static variable in interface org.apache.felix.scr.Component

The Component has successfully been activated but is a Delayed or Service Factory Component pending instantiation on first use (value is 32).

STATE_UNSATISFIED - Static variable in interface org.apache.felix.scr.Component

The Component activation failed because any dependency is not satisfied (value is 4).

C D E G I L N O R S