org.adroitlogic.x.annotation.config

Annotation Type EgressConnector

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
public @interface EgressConnector

This annotation is used to indicate a class as a Egress Connector. Any class that is annotated using this should adhere to the following guidelines. 1. This annotation can only be used on classes. 2. The class must be public. 3. The class should not be an abstract class. 4. The class must be a subclass of XEgressConnectorElement class. 5. The display name should be unique. A class annotated with this element can be used in the flow design pallet to send out a message from the integration flow

Since:

17.01

Author:

Ruwan Linton

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description Description for the connector to be used for rendering purposes
String	displayName The display name of the egress connector shown in the pallet

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	iconFileName The name of the icon file to be used when rendering the egress connector
boolean	requireConfiguration If true, when processing element is added, the property pane will be visible automatically and if false, property pane will not be visible when element is added.
ScopeType	scope Scope of the connector indicating where an element annotated with this annotation can be dropped in the pallet

Element Detail

displayName

public abstract String displayName

The display name of the egress connector shown in the pallet

Returns:

the egress connector display name

description

public abstract String description

Description for the connector to be used for rendering purposes

Returns:

the description of the connector

iconFileName

public abstract String iconFileName

The name of the icon file to be used when rendering the egress connector

Returns:

the icon file name

Default:

"default"

scope

public abstract ScopeType scope

Scope of the connector indicating where an element annotated with this annotation can be dropped in the pallet

Returns:

the connector scope

Default:

org.adroitlogic.x.api.config.ScopeType.ALL

requireConfiguration

public abstract boolean requireConfiguration

If true, when processing element is added, the property pane will be visible automatically and if false, property pane will not be visible when element is added.

Returns:

whether the configuration window should be visible or not

Default:

false