A B C D E F G I K M N O P R S U V X

A

Activator - Class in org.apache.felix.scr.impl

This activator is used to cover requirement described in section 112.8.1 @@ -27,14 37,202 @@ in active bundles.

Activator() - Constructor for class org.apache.felix.scr.impl.Activator

addDependency(ReferenceMetadata) - Method in class org.apache.felix.scr.impl.ComponentMetadata

Used to add a reference metadata to the component

addProperty(PropertyMetadata) - Method in class org.apache.felix.scr.impl.ComponentMetadata

Used to add a property to the instance

addProvide(String) - Method in class org.apache.felix.scr.impl.ServiceMetadata

Add a provided interface to this service

B

bundleChanged(BundleEvent) - Method in class org.apache.felix.scr.impl.Activator

Loads and unloads any components provided by the bundle whose state changed.

C

characters(String) - Method in interface org.apache.felix.scr.impl.parser.KXml2SAXHandler

Method called when parsing text

characters(String) - Method in class org.apache.felix.scr.impl.XmlHandler

Component - Interface in org.apache.felix.scr

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

ComponentFactoryImpl - Class in org.apache.felix.scr.impl

The ComponentFactoryImpl TODO

ComponentManager - Interface in org.apache.felix.scr.impl

This interface is provided so that there can be multiple implementations of managers that are responsible for managing component's lifecycle.

ComponentMetadata - Class in org.apache.felix.scr.impl

This class holds the information associated to a component in the descriptor *

ComponentMetadata() - Constructor for class org.apache.felix.scr.impl.ComponentMetadata

ComponentRegistry - Class in org.apache.felix.scr.impl

The ComponentRegistry TODO

createComponent() - Method in class org.apache.felix.scr.impl.ComponentFactoryImpl

createComponent() - Method in class org.apache.felix.scr.impl.DelayedComponentManager

createComponent() - Method in class org.apache.felix.scr.impl.ServiceFactoryComponentManager

D

DelayedComponentManager - Class in org.apache.felix.scr.impl

The DelayedComponentManager TODO

DelayedComponentManager(BundleComponentActivator, ComponentMetadata, long) - Constructor for class org.apache.felix.scr.impl.DelayedComponentManager

deleteComponent() - Method in class org.apache.felix.scr.impl.ComponentFactoryImpl

deleteComponent() - Method in class org.apache.felix.scr.impl.DelayedComponentManager

deleteComponent() - Method in class org.apache.felix.scr.impl.ServiceFactoryComponentManager

deleted(String) - Method in class org.apache.felix.scr.impl.ComponentFactoryImpl

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

Disables this Component if it is enabled.

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

Disable the component.

dispose() - Method in interface org.apache.felix.scr.impl.ComponentManager

Dispose the component.

E

elements() - Method in class org.apache.felix.scr.impl.ReadOnlyDictionary

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

Enables this Component if it is disabled.

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

Enable the component

endElement(String, String) - Method in interface org.apache.felix.scr.impl.parser.KXml2SAXHandler

Method called when a tag closes

endElement(String, String) - Method in class org.apache.felix.scr.impl.XmlHandler

Method called when a tag closes

execute(String, PrintStream, PrintStream) - Method in class org.apache.felix.scr.impl.ScrCommand

F

firstElement - Variable in class org.apache.felix.scr.impl.XmlHandler

Flag for detecting the first element.

G

get(Object) - Method in class org.apache.felix.scr.impl.ReadOnlyDictionary

getBind() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Get the name of a method in the component implementation class that is used to notify that a service is bound to the component configuration

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.

getCardinality() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Get the cardinality as a string

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

Returns the class name of the Component implementation.

getComponent(long) - Method in class org.apache.felix.scr.impl.ComponentRegistry

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.

getComponentMetadata() - Method in interface org.apache.felix.scr.impl.ComponentManager

Get the component information

getComponents() - Method in class org.apache.felix.scr.impl.ComponentRegistry

getComponents(Bundle) - Method in class org.apache.felix.scr.impl.ComponentRegistry

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

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

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.

getDependencies() - Method in class org.apache.felix.scr.impl.ComponentMetadata

Returns the dependency descriptors

getException() - Method in exception org.apache.felix.scr.impl.parser.ParseException

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.

getFactoryIdentifier() - Method in class org.apache.felix.scr.impl.ComponentMetadata

Returns the factory identifier

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

Returns the component ID of this component.

getImplementationClassName() - Method in class org.apache.felix.scr.impl.ComponentMetadata

Returns the name of the implementation class

getInstance() - Method in class org.apache.felix.scr.impl.ComponentFactoryImpl

getInstance() - Method in class org.apache.felix.scr.impl.ServiceFactoryComponentManager

getInterface() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Returns the fully qualified name of the class that is used by the component to access the service

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 class org.apache.felix.scr.impl.ComponentFactoryImpl

getName() - Method in class org.apache.felix.scr.impl.ComponentMetadata

Returns the name of the component

getName() - Method in class org.apache.felix.scr.impl.PropertyMetadata

Get the name of the property

getName() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Returns the name of the reference

getName() - Method in class org.apache.felix.scr.impl.ScrCommand

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

Returns the name of this Reference.

getPolicy() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Get the policy as a string

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

Returns the properties of the Component.

getProperties() - Method in class org.apache.felix.scr.impl.ComponentFactoryImpl

getProperties() - Method in class org.apache.felix.scr.impl.ComponentMetadata

Returns the properties.

getProvides() - Method in class org.apache.felix.scr.impl.ServiceMetadata

Returns the implemented interfaces

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

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

getService() - Method in class org.apache.felix.scr.impl.ComponentFactoryImpl

getService() - Method in class org.apache.felix.scr.impl.DelayedComponentManager

getService(Bundle, ServiceRegistration) - Method in class org.apache.felix.scr.impl.DelayedComponentManager

getService() - Method in class org.apache.felix.scr.impl.ServiceFactoryComponentManager

getService(Bundle, ServiceRegistration) - Method in class org.apache.felix.scr.impl.ServiceFactoryComponentManager

getServiceMetadata() - Method in class org.apache.felix.scr.impl.ComponentMetadata

Returns the associated ServiceMetadata

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

Returns the name of the service used by this Reference.

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.

getShortDescription() - Method in class org.apache.felix.scr.impl.ScrCommand

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 class org.apache.felix.scr.impl.ReferenceMetadata

Returns the filter expression that further constrains the set of target services

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

Returns the value of the target property of this reference.

getTargetPropertyName() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Returns the name of the component property referring to the target property of this reference.

getType() - Method in class org.apache.felix.scr.impl.PropertyMetadata

Get the type of the property

getUnbind() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Get the name of a method in the component implementation class that is used to notify that a service is unbound from the component configuration

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.

getUsage() - Method in class org.apache.felix.scr.impl.ScrCommand

getValue() - Method in class org.apache.felix.scr.impl.PropertyMetadata

Get the value of the property

I

isComponent - Variable in class org.apache.felix.scr.impl.XmlHandler

Flag for elements inside a component element

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

Returns whether the Component is declared to be enabled initially.

isEmpty() - Method in class org.apache.felix.scr.impl.ReadOnlyDictionary

isEnabled() - Method in class org.apache.felix.scr.impl.ComponentMetadata

Returns the value of the enabled flag

isFactory() - Method in class org.apache.felix.scr.impl.ComponentMetadata

Test to see if this service is a factory

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

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

isImmediate() - Method in class org.apache.felix.scr.impl.ComponentMetadata

Returns the flag that defines the activation policy for the component.

isMultiple() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Test if dependency is multiple (0..n or 1..n)

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

Returns whether this reference is multiple.

isOptional() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Test if dependency is optional (0..1 or 0..n)

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.

isServiceFactory() - Method in class org.apache.felix.scr.impl.ServiceMetadata

Return the flag that defines if it is a service factory or not

isStatic() - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Test if dependency's binding policy is static

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

Returns true if the reference is defined with static policy.

K

keys() - Method in class org.apache.felix.scr.impl.ReadOnlyDictionary

KXml2SAXHandler - Interface in org.apache.felix.scr.impl.parser

Interface for a SAX like handler with kXML

KXml2SAXParser - Class in org.apache.felix.scr.impl.parser

The KXml2SAXParser extends the XmlParser from kxml.

KXml2SAXParser(Reader) - Constructor for class org.apache.felix.scr.impl.parser.KXml2SAXParser

The constructor for a parser, it receives a java.io.Reader.

M

ManagerFactory - Class in org.apache.felix.scr.impl

This factory allows other types of ComponentManagers to be provided.

ManagerFactory() - Constructor for class org.apache.felix.scr.impl.ManagerFactory

N

NAMESPACE_URI - Static variable in class org.apache.felix.scr.impl.XmlHandler

newInstance(Dictionary) - Method in class org.apache.felix.scr.impl.ComponentFactoryImpl

O

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

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

org.apache.felix.scr.impl.parser - package org.apache.felix.scr.impl.parser

overrideNamespace - Variable in class org.apache.felix.scr.impl.XmlHandler

Override namespace.

P

ParseException - Exception in org.apache.felix.scr.impl.parser

ParseException(String, Exception) - Constructor for exception org.apache.felix.scr.impl.parser.ParseException

parseXML(KXml2SAXHandler) - Method in class org.apache.felix.scr.impl.parser.KXml2SAXParser

Parser from the reader provided in the constructor, and call the startElement and endElement in a KxmlHandler

processingInstruction(String, String) - Method in interface org.apache.felix.scr.impl.parser.KXml2SAXHandler

processingInstruction(String, String) - Method in class org.apache.felix.scr.impl.XmlHandler

PropertyMetadata - Class in org.apache.felix.scr.impl

A property descriptor that contains the information for properties defined in the descriptor

PropertyMetadata() - Constructor for class org.apache.felix.scr.impl.PropertyMetadata

put(Object, Object) - Method in class org.apache.felix.scr.impl.ReadOnlyDictionary

This method has no effect and always returns null as this instance is read-only and cannot modify and properties.

R

ReadOnlyDictionary - Class in org.apache.felix.scr.impl

The ReadOnlyDictionary is a Dictionary whose ReadOnlyDictionary.put(Object, Object) and ReadOnlyDictionary.remove(Object) methods have no effect and always return null.

reconfigure() - Method in interface org.apache.felix.scr.impl.ComponentManager

Reconfigure the component with configuration data newly retrieved from the Configuration Admin Service.

Reference - Interface in org.apache.felix.scr

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

ReferenceMetadata - Class in org.apache.felix.scr.impl

Information associated to a dependency

ReferenceMetadata() - Constructor for class org.apache.felix.scr.impl.ReferenceMetadata

registerComponentService() - Method in class org.apache.felix.scr.impl.ComponentFactoryImpl

remove(Object) - Method in class org.apache.felix.scr.impl.ReadOnlyDictionary

This method has no effect and always returns null as this instance is read-only and cannot modify and properties.

S

ScrCommand - Class in org.apache.felix.scr.impl

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.

ServiceFactoryComponentManager - Class in org.apache.felix.scr.impl

The ServiceFactoryComponentManager TODO

ServiceFactoryComponentManager(BundleComponentActivator, ComponentMetadata, long) - Constructor for class org.apache.felix.scr.impl.ServiceFactoryComponentManager

ServiceMetadata - Class in org.apache.felix.scr.impl

This class contains the metadata associated to a service that is provided by a component

ServiceMetadata() - Constructor for class org.apache.felix.scr.impl.ServiceMetadata

setBind(String) - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Setter for the bind method attribute

setCardinality(String) - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Setter for the cardinality attribute

setColumnNumber(int) - Method in interface org.apache.felix.scr.impl.parser.KXml2SAXHandler

setColumnNumber(int) - Method in class org.apache.felix.scr.impl.XmlHandler

setEnabled(boolean) - Method in class org.apache.felix.scr.impl.ComponentMetadata

Setter for the enabled property

setFactoryIdentifier(String) - Method in class org.apache.felix.scr.impl.ComponentMetadata

setImmediate(boolean) - Method in class org.apache.felix.scr.impl.ComponentMetadata

Setter for the immediate property

setImplementationClassName(String) - Method in class org.apache.felix.scr.impl.ComponentMetadata

Sets the name of the implementation class

setInterface(String) - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Setter for the interfaceName attribute

setLineNumber(int) - Method in interface org.apache.felix.scr.impl.parser.KXml2SAXHandler

setLineNumber(int) - Method in class org.apache.felix.scr.impl.XmlHandler

setName(String) - Method in class org.apache.felix.scr.impl.ComponentMetadata

Setter for the name

setName(String) - Method in class org.apache.felix.scr.impl.PropertyMetadata

Set the name

setName(String) - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Setter for the name attribute

setPolicy(String) - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Setter for the policy attribute

setService(ServiceMetadata) - Method in class org.apache.felix.scr.impl.ComponentMetadata

Used to set a ServiceMetadata object.

setServiceFactory(boolean) - Method in class org.apache.felix.scr.impl.ServiceMetadata

Setter for the servicefactory attribute of the service element

setTarget(String) - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Setter for the target attribute (filter)

setType(String) - Method in class org.apache.felix.scr.impl.PropertyMetadata

Set the type

setUnbind(String) - Method in class org.apache.felix.scr.impl.ReferenceMetadata

Setter for the unbind method attribute

setValue(String) - Method in class org.apache.felix.scr.impl.PropertyMetadata

Set the value

setValues(String) - Method in class org.apache.felix.scr.impl.PropertyMetadata

Set multiple values as an array, where the values are contained in the string as one value per line.

size() - Method in class org.apache.felix.scr.impl.ReadOnlyDictionary

start(BundleContext) - Method in class org.apache.felix.scr.impl.Activator

Registers this instance as a (synchronous) bundle listener and loads the components of already registered bundles.

startElement(String, String, Properties) - Method in interface org.apache.felix.scr.impl.parser.KXml2SAXHandler

Method called when a tag opens

startElement(String, String, Properties) - Method in class org.apache.felix.scr.impl.XmlHandler

Method called when a tag opens

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

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

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_ENABLED - Static variable in interface org.apache.felix.scr.Component

The Component has been enabled and is now going to be activated (value is 2).

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

The Component is a Component Factory ready 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).

stop(BundleContext) - Method in class org.apache.felix.scr.impl.Activator

Unregisters this instance as a bundle listener and unloads all components which have been registered during the active life time of the SCR implementation bundle.

U

ungetService(Bundle, ServiceRegistration, Object) - Method in class org.apache.felix.scr.impl.DelayedComponentManager

ungetService(Bundle, ServiceRegistration, Object) - Method in class org.apache.felix.scr.impl.ServiceFactoryComponentManager

updated(String, Dictionary) - Method in class org.apache.felix.scr.impl.ComponentFactoryImpl

V

validate(ComponentMetadata) - Method in class org.apache.felix.scr.impl.PropertyMetadata

Method used to verify if the semantics of this metadata are correct

X

XmlHandler - Class in org.apache.felix.scr.impl

A B C D E F G I K M N O P R S U V X