|
OSGi™ Service Platform Release 3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines standard names for Wire properties, wire filter attributes, Consumer and Producer service properties.
Field Summary | |
static java.lang.String |
WIREADMIN_CONSUMER_COMPOSITE
A service registration property for a Consumer service that is composite. |
static java.lang.String |
WIREADMIN_CONSUMER_FLAVORS
Service Registration property (named wireadmin.consumer.flavors) specifying the list of data types understood by this Consumer service. |
static java.lang.String |
WIREADMIN_CONSUMER_PID
Wire property key (named wireadmin.consumer.pid) specifying the service.pid of the associated Consumer service. |
static java.lang.String |
WIREADMIN_CONSUMER_SCOPE
Service registration property key (named wireadmin.consumer.scope) specifying a list of names that may be used to define the scope of this Wire object. |
static java.lang.String |
WIREADMIN_EVENTS
Service Registration property (named wireadmin.events) specifying the WireAdminEvent type of interest to a Wire Admin Listener service. |
static java.lang.String |
WIREADMIN_FILTER
Wire property key (named wireadmin.filter) specifying a filter used to control the delivery rate of data between the Producer and the Consumer service. |
static java.lang.String |
WIREADMIN_PID
Wire property key (named wireadmin.pid) specifying the persistent identity (PID) of this Wire object. |
static java.lang.String |
WIREADMIN_PRODUCER_COMPOSITE
A service registration property for a Producer service that is composite. |
static java.lang.String |
WIREADMIN_PRODUCER_FILTERS
Service Registration property (named wireadmin.producer.filters). |
static java.lang.String |
WIREADMIN_PRODUCER_FLAVORS
Service Registration property (named wireadmin.producer.flavors) specifying the list of data types available from this Producer service. |
static java.lang.String |
WIREADMIN_PRODUCER_PID
Wire property key (named wireadmin.producer.pid) specifying the service.pid of the associated Producer service. |
static java.lang.String |
WIREADMIN_PRODUCER_SCOPE
Service registration property key (named wireadmin.producer.scope) specifying a list of names that may be used to define the scope of this Wire object. |
static java.lang.String[] |
WIREADMIN_SCOPE_ALL
Matches all scope names. |
static java.lang.String |
WIREVALUE_CURRENT
Wire object's filter attribute (named wirevalue.current) representing the current value. |
static java.lang.String |
WIREVALUE_DELTA_ABSOLUTE
Wire object's filter attribute (named wirevalue.delta.absolute) representing the absolute delta. |
static java.lang.String |
WIREVALUE_DELTA_RELATIVE
Wire object's filter attribute (named wirevalue.delta.relative) representing the relative delta. |
static java.lang.String |
WIREVALUE_ELAPSED
Wire object's filter attribute (named wirevalue.elapsed) representing the elapsed time, in ms, between this filter evaluation and the last update of the Consumer service. |
static java.lang.String |
WIREVALUE_PREVIOUS
Wire object's filter attribute (named wirevalue.previous) representing the previous value. |
Field Detail |
public static final java.lang.String WIREADMIN_PID
Each Wire object has a PID to allow unique and persistent
identification of a specific Wire object. The PID must be generated
by the WireAdmin
service when the Wire object is created.
This wire property is automatically set by the Wire Admin service. The value of the property must be of type String.
public static final java.lang.String WIREADMIN_PRODUCER_COMPOSITE
public static final java.lang.String WIREADMIN_CONSUMER_COMPOSITE
public static final java.lang.String WIREADMIN_PRODUCER_SCOPE
Wire.getScope()
,
WIREADMIN_CONSUMER_SCOPE
,
Constant Field Valuespublic static final java.lang.String WIREADMIN_CONSUMER_SCOPE
Wire.getScope()
,
WIREADMIN_PRODUCER_SCOPE
,
Constant Field Valuespublic static final java.lang.String[] WIREADMIN_SCOPE_ALL
public static final java.lang.String WIREADMIN_PRODUCER_PID
This wire property is automatically set by the WireAdmin service. The value of the property must be of type String.
public static final java.lang.String WIREADMIN_CONSUMER_PID
This wire property is automatically set by the Wire Admin service. The value of the property must be of type String.
public static final java.lang.String WIREADMIN_FILTER
This property should contain a filter as described in the Filter class. The filter can be used to specify when an updated value from the Producer service should be delivered to the Consumer service. In many cases the Consumer service does not need to receive the data with the same rate that the Producer service can generate data. This property can be used to control the delivery rate.
The filter can use a number of pre-defined attributes that can be used to control the delivery of new data values. If the filter produces a match upon the wire filter attributes, the Consumer service should be notifed of the updated data value.
If the Producer service was registered with the WIREADMIN_PRODUCER_FILTERS
service property indicating that the Producer service will perform the data filtering
then the Wire object will not perform data filtering.
Otherwise, the Wire object must perform
basic filtering. Basic filtering includes supporting the following
standard wire filter attributes:
WIREVALUE_CURRENT
- Current value
WIREVALUE_PREVIOUS
- Previous value
WIREVALUE_DELTA_ABSOLUTE
- Absolute delta
WIREVALUE_DELTA_RELATIVE
- Relative delta
WIREVALUE_ELAPSED
- Elapsed time
Filter
,
Constant Field Valuespublic static final java.lang.String WIREVALUE_CURRENT
public static final java.lang.String WIREVALUE_PREVIOUS
public static final java.lang.String WIREVALUE_DELTA_ABSOLUTE
public static final java.lang.String WIREVALUE_DELTA_RELATIVE
public static final java.lang.String WIREVALUE_ELAPSED
public static final java.lang.String WIREADMIN_PRODUCER_FILTERS
WIREADMIN_FILTER
property. If the Producer service
is not registered with this property,
the Wire object must perform the basic filtering
as described in WIREADMIN_FILTER
.
The type of the property value is not relevant. Only its presence is relevant.
public static final java.lang.String WIREADMIN_CONSUMER_FLAVORS
The Consumer service object must be registered with this service property. The list must be in the order of preference with the first type being the most preferred. The value of the property must be of type Class[].
public static final java.lang.String WIREADMIN_PRODUCER_FLAVORS
The Producer service object should be registered with this service property.
The value of the property must be of type Class[].
public static final java.lang.String WIREADMIN_EVENTS
WireAdminEvent
,
Constant Field Values
|
OSGi™ Service Platform Release 3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |