org.mule.api.annotations

Annotation Type TestConnectivity

@Target(value=METHOD)
@Retention(value=SOURCE)
@Documented
public @interface TestConnectivity

Method to test if a specific ConnectionManagement strategy is able to hit the endpoint. The "Test Connectivity" button of the configuration window will trigger this method. The TestConnectivity method can be the same as Connect method, or a separate one. Constrains for the Decoupled Test Connectivity method:

1. Only one method can be annotated with @TestConnectivity.
2. The method annotated with @TestConnectivity must have the exact same parameters the @Connect methods, in the same order.
3. Method should declare throws ConnectionException.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	active
String	label

Element Detail

active

public abstract boolean active

Returns:

true if the concrete strategy can hit the API to determine if the parameters of it are properly populated

Default:

true

label

public abstract String label

Returns:

the label that Studio must use when rendering the button

Default:

"Test Connection..."