org.osgi.service.event
Interface EventConstants

public interface EventConstants

Defines standard names for EventHandler properties.

Field Summary

static java.lang.String	BUNDLE The Bundle object of the bundle relevant to the event.
static java.lang.String	BUNDLE_ID The Bundle id of the bundle relevant to the event.
static java.lang.String	BUNDLE_SIGNER The Distinguished Name of the bundle relevant to the event.
static java.lang.String	BUNDLE_SYMBOLICNAME The Bundle Symbolic Name of the bundle relevant to the event.
static java.lang.String	EVENT The actual event object.
static java.lang.String	EVENT_FILTER Service Registration property (named event.filter) specifying a filter to further select Event s of interest to a Event Handler service.
static java.lang.String	EVENT_TOPIC Service registration property (named event.topic) specifying the Event topics of interest to a Event Handler service.
static java.lang.String	EXCEPTION An exception or error.
static java.lang.String	EXCEPTION_CLASS Must be equal to the name of the Exception class.
static java.lang.String	EXCEPTION_MESSAGE Must be equal to exception.getMessage()
static java.lang.String	EXECPTION_CLASS Deprecated. As of 1.1, replaced by EXCEPTION_CLASS
static java.lang.String	MESSAGE A human-readable message that is usually not localized.
static java.lang.String	SERVICE A service
static java.lang.String	SERVICE_ID A service's id.
static java.lang.String	SERVICE_OBJECTCLASS A service's objectClass
static java.lang.String	SERVICE_PID A service's persistent identity.
static java.lang.String	TIMESTAMP The time when the event occurred, as reported by System.currentTimeMillis()

Field Detail

EVENT_TOPIC

public static final java.lang.String EVENT_TOPIC

Service registration property (named event.topic) specifying the Event topics of interest to a Event Handler service.

Event handlers SHOULD be registered with this property. The value of the property is an array of strings 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 entry in the array must conform to the following grammar:

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

See Also:

Event, Constant Field Values

EVENT_FILTER

public static final java.lang.String EVENT_FILTER

Service Registration property (named event.filter) specifying a filter to further select Event s of interest to a 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.

See Also:

Event, Filter, Constant Field Values

BUNDLE_SIGNER

public static final java.lang.String BUNDLE_SIGNER

The Distinguished Name of the bundle relevant to the event.

See Also:

Constant Field Values

BUNDLE_SYMBOLICNAME

public static final java.lang.String BUNDLE_SYMBOLICNAME

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

See Also:

Constant Field Values

BUNDLE_ID

public static final java.lang.String BUNDLE_ID

The Bundle id of the bundle relevant to the event.

Since:

1.1

See Also:

Constant Field Values

BUNDLE

public static final java.lang.String BUNDLE

The Bundle object of the bundle relevant to the event.

Since:

1.1

See Also:

Constant Field Values

EVENT

public static final java.lang.String EVENT

The actual event object. Used when rebroadcasting an event that was sent via some other event mechanism.

See Also:

Constant Field Values

EXCEPTION

public static final java.lang.String EXCEPTION

An exception or error.

See Also:

Constant Field Values

EXCEPTION_CLASS

public static final java.lang.String EXCEPTION_CLASS

Must be equal to the name of the Exception class.

Since:

1.1

See Also:

Constant Field Values

EXCEPTION_MESSAGE

public static final java.lang.String EXCEPTION_MESSAGE

Must be equal to exception.getMessage()

See Also:

Constant Field Values

MESSAGE

public static final java.lang.String MESSAGE

A human-readable message that is usually not localized.

See Also:

Constant Field Values

SERVICE

public static final java.lang.String SERVICE

A service

See Also:

Constant Field Values

SERVICE_ID

public static final java.lang.String SERVICE_ID

A service's id.

See Also:

Constant Field Values

SERVICE_OBJECTCLASS

public static final java.lang.String SERVICE_OBJECTCLASS

A service's objectClass

See Also:

Constant Field Values

SERVICE_PID

public static final java.lang.String SERVICE_PID

A service's persistent identity.

See Also:

Constant Field Values

TIMESTAMP

public static final java.lang.String TIMESTAMP

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

See Also:

Constant Field Values

EXECPTION_CLASS

public static final java.lang.String EXECPTION_CLASS

Deprecated. As of 1.1, replaced by EXCEPTION_CLASS

This constant was released with an incorrect spelling. It has been replaced by EXCEPTION_CLASS

See Also:

Constant Field Values