org.eclipse.cosmos.dc.mgmt.annotations
Annotation Type ManagedEvent

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface ManagedEvent

Annotation used to indicate an event raised by an operation.

Required Element Summary

java.lang.String

topic The topic name for the event.

Optional Element Summary

java.lang.String	description A text description of the capability.
java.lang.String	format The format of the event.
java.lang.String	namespace The namespace to be used for the event.
java.lang.String	payloadMethod

Element Detail

topic

public abstract java.lang.String topic

The topic name for the event.

namespace

public abstract java.lang.String namespace

The namespace to be used for the event. If no namespace is provided, and the event is declared as a member of a ManagedResource, then the ManagedResource annotation's namespacewill be used. If no namespace is provided, and the event is operation is declared as a member of a ManagedResourceCapability, then the ManagedResourceCapability's namespace will be used.

Default:

""

description

public abstract java.lang.String description

A text description of the capability. This attribute is intended for tooling support.

Default:

""

payloadMethod

public abstract java.lang.String payloadMethod

Default:

""

format

public abstract java.lang.String format

The format of the event. If no format is specified, the event message content will contain return value of the event-raising method. The only currently supported event format is "wef".

Default:

""