Top Description Fields
org.osgi.service.event

public Interface EventConstants

Annotations
@ProviderType
Imports
org.osgi.annotation.versioning.ProviderType, org.osgi.framework.Bundle, .Constants, .Filter, .ServiceReference, .Version

Defines standard names for EventHandler properties.
Author
$Id: 37a3a2f82d11ec1768a045fce4be4ace038f1edc $

Field Summary

Modifier and TypeField and Description
public static final String
BUNDLE

The Bundle object of the bundle relevant to the event.

public static final String
BUNDLE_ID

The Bundle id of the bundle relevant to the event.

public static final String
BUNDLE_SIGNER

The Distinguished Names of the signers of the bundle relevant to the event.

public static final String
BUNDLE_SYMBOLICNAME

The Bundle Symbolic Name of the bundle relevant to the event.

public static final String
BUNDLE_VERSION

The version of the bundle relevant to the event.

public static final String
DELIVERY_ASYNC_ORDERED

Event Handler delivery quality value specifying the Event Handler requires asynchronously delivered events be delivered in order.

public static final String
DELIVERY_ASYNC_UNORDERED

Event Handler delivery quality value specifying the Event Handler does not require asynchronously delivered events be delivered in order.

public static final String
EVENT

The forwarded event object.

public static final String
EVENT_ADMIN_IMPLEMENTATION

The name of the implementation capability for the Event Admin specification

public static final String
EVENT_ADMIN_SPECIFICATION_VERSION

The version of the implementation capability for the Event Admin specification

public static final String
EVENT_DELIVERY

Service Registration property specifying the delivery qualities requested by an Event Handler service.

public static final String
EVENT_FILTER

Service Registration property specifying a filter to further select Event s of interest to an Event Handler service.

public static final String
EVENT_TOPIC

Service registration property specifying the Event topics of interest to an Event Handler service.

public static final String
EXCEPTION

An exception or error.

public static final String
EXCEPTION_CLASS

The name of the exception type.

public static final String
EXCEPTION_MESSAGE

The exception message.

public static final String
EXECPTION_CLASS

Deprecated As of 1.1. Replaced by EXCEPTION_CLASS.
This constant was released with an incorrectly spelled name.
public static final String
MESSAGE

A human-readable message that is usually not localized.

public static final String
SERVICE

A service reference.

public static final String
SERVICE_ID

A service's id. The type of the value for this event property is Long.

public static final String
SERVICE_OBJECTCLASS

A service's objectClass.

public static final String
SERVICE_PID

A service's persistent identity.

public static final String
TIMESTAMP

The time when the event occurred, as reported by System.currentTimeMillis().

Field Detail

BUNDLEback to summary
public static final String BUNDLE

The Bundle object of the bundle relevant to the event. The type of the value for this event property is Bundle.

Since
1.1
BUNDLE_IDback to summary
public static final String BUNDLE_ID

The Bundle id of the bundle relevant to the event. The type of the value for this event property is Long.

Since
1.1
BUNDLE_SIGNERback to summary
public static final String BUNDLE_SIGNER

The Distinguished Names of the signers of the bundle relevant to the event. The type of the value for this event property is String or Collection of String.

BUNDLE_SYMBOLICNAMEback to summary
public static final String BUNDLE_SYMBOLICNAME

The Bundle Symbolic Name of the bundle relevant to the event. The type of the value for this event property is String.

BUNDLE_VERSIONback to summary
public static final String BUNDLE_VERSION

The version of the bundle relevant to the event. The type of the value for this event property is Version.

Since
1.2
DELIVERY_ASYNC_ORDEREDback to summary
public static final String DELIVERY_ASYNC_ORDERED

Event Handler delivery quality value specifying the Event Handler requires asynchronously delivered events be delivered in order. Ordered delivery is the default for asynchronously delivered events.

This delivery quality value is mutually exclusive with DELIVERY_ASYNC_UNORDERED. However, if both this value and DELIVERY_ASYNC_UNORDERED are specified for an event handler, this value takes precedence.

Since
1.3
See Also
EVENT_DELIVERY
DELIVERY_ASYNC_UNORDEREDback to summary
public static final String DELIVERY_ASYNC_UNORDERED

Event Handler delivery quality value specifying the Event Handler does not require asynchronously delivered events be delivered in order. This may allow an Event Admin implementation to optimize asynchronous event delivery by relaxing ordering requirements.

This delivery quality value is mutually exclusive with DELIVERY_ASYNC_ORDERED. However, if both this value and DELIVERY_ASYNC_ORDERED are specified for an event handler, DELIVERY_ASYNC_ORDERED takes precedence.

Since
1.3
See Also
EVENT_DELIVERY
EVENTback to summary
public static final String EVENT

The forwarded event object. Used when rebroadcasting an event that was sent via some other event mechanism. The type of the value for this event property is Object.

EVENT_ADMIN_IMPLEMENTATIONback to summary
public static final String EVENT_ADMIN_IMPLEMENTATION

The name of the implementation capability for the Event Admin specification

Since
1.4
EVENT_ADMIN_SPECIFICATION_VERSIONback to summary
public static final String EVENT_ADMIN_SPECIFICATION_VERSION

The version of the implementation capability for the Event Admin specification

Since
1.4
EVENT_DELIVERYback to summary
public static final String EVENT_DELIVERY

Service Registration property specifying the delivery qualities requested by an Event Handler service.

Event handlers MAY be registered with this property. Each value of this property is a string specifying a delivery quality for the Event handler.

The value of this property must be of type String, String[], or Collection<String>.

Since
1.3
See Also
DELIVERY_ASYNC_ORDERED, DELIVERY_ASYNC_UNORDERED
EVENT_FILTERback to summary
public static final String EVENT_FILTER

Service Registration property specifying a filter to further select Event s of interest to an Event Handler service.

Event handlers MAY be registered with this property. The value of this property is a string containing an LDAP-style filter specification. Any of the event's properties may be used in the filter expression. Each event handler is notified for any event which belongs to the topics in which the handler has expressed an interest. If the event handler is also registered with this service property, then the properties of the event must also match the filter for the event to be delivered to the event handler.

If the filter syntax is invalid, then the Event Handler must be ignored and a warning should be logged.

The value of this property must be of type String.

See Also
Event, Filter
EVENT_TOPICback to summary
public static final String EVENT_TOPIC

Service registration property specifying the Event topics of interest to an Event Handler service.

Event handlers SHOULD be registered with this property. Each value of this property is a string that describe the topics in which the handler is interested. An asterisk ('*') may be used as a trailing wildcard. Event Handlers which do not have a value for this property must not receive events. More precisely, the value of each string must conform to the following grammar:

 topic-description := '*' | topic ( '/*' )?
 topic := token ( '/' token )*

The value of this property must be of type String, String[], or Collection<String>.

See Also
Event
EXCEPTIONback to summary
public static final String EXCEPTION

An exception or error. The type of the value for this event property is Throwable.

EXCEPTION_CLASSback to summary
public static final String EXCEPTION_CLASS

The name of the exception type. Must be equal to the name of the class of the exception in the event property EXCEPTION. The type of the value for this event property is String.

Since
1.1
EXCEPTION_MESSAGEback to summary
public static final String EXCEPTION_MESSAGE

The exception message. Must be equal to the result of calling getMessage() on the exception in the event property EXCEPTION. The type of the value for this event property is String.

EXECPTION_CLASSback to summary
public static final String EXECPTION_CLASS

Deprecated

As of 1.1. Replaced by EXCEPTION_CLASS.

This constant was released with an incorrectly spelled name. It has been replaced by EXCEPTION_CLASS

MESSAGEback to summary
public static final String MESSAGE

A human-readable message that is usually not localized. The type of the value for this event property is String.

SERVICEback to summary
public static final String SERVICE

A service reference. The type of the value for this event property is ServiceReference.

SERVICE_IDback to summary
public static final String SERVICE_ID

A service's id. The type of the value for this event property is Long.

SERVICE_OBJECTCLASSback to summary
public static final String SERVICE_OBJECTCLASS

A service's objectClass. The type of the value for this event property is String[].

SERVICE_PIDback to summary
public static final String SERVICE_PID

A service's persistent identity. The type of the value for this event property is String or Collection of String.

TIMESTAMPback to summary
public static final String TIMESTAMP

The time when the event occurred, as reported by System.currentTimeMillis(). The type of the value for this event property is Long.