Knopflerfish OSGi 5.2.0

org.apache.felix.scr
Interface Reference


public interface Reference

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


Method Summary
 java.lang.String getBindMethodName()
          Returns the name of the method called if a service is being bound to the Component or null if no such method is configued.
 java.lang.String getName()
          Returns the name of this Reference.
 java.lang.String getServiceName()
          Returns the name of the service used by this Reference.
 ServiceReference[] getServiceReferences()
          Returns an array of references to the services bound to this Reference or null if no services are currently bound.
 java.lang.String getTarget()
          Returns the value of the target property of this reference.
 java.lang.String getUnbindMethodName()
          Returns the name of the method called if a service is being unbound from the Component or null if no such method is configued.
 java.lang.String getUpdatedMethodName()
          Returns the name of the method called if a bound service updates its service registration properties or null if no such method is configued.
 boolean isMultiple()
          Returns whether this reference is multiple.
 boolean isOptional()
          Returns whether this reference is optional.
 boolean isSatisfied()
          Returns whether this reference is satisified.
 boolean isStatic()
          Returns true if the reference is defined with static policy.
 

Method Detail

getName

java.lang.String getName()
Returns the name of this Reference. This method provides access to the name attribute of the referenec element.


getServiceName

java.lang.String getServiceName()
Returns the name of the service used by this Reference. This method provides access to the interface attribute of the reference element.


getServiceReferences

ServiceReference[] getServiceReferences()
Returns an array of references to the services bound to this Reference or null if no services are currently bound.


isSatisfied

boolean isSatisfied()
Returns whether this reference is satisified. A optional component is always satsified. Otherwise true is only returned if at least one service is bound.


isOptional

boolean isOptional()
Returns whether this reference is optional. This method provides access to the lower bound of the cardinality attribute of the reference element. In other words, this method returns true if the cardinality is 0..1 or 0..n.


isMultiple

boolean isMultiple()
Returns whether this reference is multiple. This method provides access to the upper bound of the cardinality attribute of the reference element. In other words, this method returns true if the cardinality is 0..n or 1..n.


isStatic

boolean isStatic()
Returns true if the reference is defined with static policy. This method provides access to the policy element of the reference element. true is returned if the policy is defined as static.


getTarget

java.lang.String getTarget()
Returns the value of the target property of this reference. Initially (without overwriting configuration) this method provides access to the target attribute of the reference element. If configuration overwrites the target property, this method returns the value of the Component property whose name is derived from the reference name plus the suffix .target. If no target property exists this method returns null.


getBindMethodName

java.lang.String getBindMethodName()
Returns the name of the method called if a service is being bound to the Component or null if no such method is configued. This method provides access to the bind attribute of the reference element.


getUnbindMethodName

java.lang.String getUnbindMethodName()
Returns the name of the method called if a service is being unbound from the Component or null if no such method is configued. This method provides access to the unbind attribute of the reference element.


getUpdatedMethodName

java.lang.String getUpdatedMethodName()
Returns the name of the method called if a bound service updates its service registration properties or null if no such method is configued. This method provides access to the updated attribute of the reference element.

For a component declared in a Declarative Services 1.0 and 1.1 descriptor, this method always returns null.

Since:
1.4

Knopflerfish OSGi 5.2.0