Module org.mule.sdk.api

Package org.mule.sdk.api.annotation.source

Annotation Interface BackPressure

@Target(TYPE)
@Retention(RUNTIME)
@Documented
@MinMuleVersion("4.5.0")
public @interface BackPressure

Allows the customization of a Source available and default BackPressureMode.

Since:

1.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
BackPressureMode	defaultMode	Returns the default mode.
BackPressureMode[]	supportedModes	The modes supported by the annotated modes.

Element Details

defaultMode

BackPressureMode defaultMode

Returns the default mode. This value MUST be contained in supportedModes()

Returns:

the default BackPressureMode

Default:

WAIT

supportedModes

BackPressureMode[] supportedModes

The modes supported by the annotated modes. Use this option when certain modes do not apply for a given source (e.g.: There's no sense in supporting the BackPressureMode.WAIT mode in http:listener.

If not provided, only the BackPressureMode.WAIT mode is supported. The defaultMode() MUST be contained in this array.

Returns:

the supported modes

Default:

{WAIT}