org.adroitlogic.x.annotation.config

Annotation Type IngressConnector

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

This annotation is used to indicate a class as a Ingress 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 XIngressConnectorElement class. 5. The display name should be unique. An element annotated with this annotation can be used to receive messages from external sources into 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 used for rendering purposes
String	displayName The name of the annotated connector element to be used in the user interface.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	documentationURL The location of the documentation page for the particular Ingress Connector
ExchangePattern	exchangePattern Specify if the current ingress connector expects a response one of ExchangePattern.IN_OUT or ExchangePattern.IN_ONLY is expected
String	iconFileName The name of the icon file to be used for rendering purposes in the design pallet
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 placed in the pallet\

Element Detail

displayName

public abstract String displayName

The name of the annotated connector element to be used in the user interface.

Returns:

the display name of the connector

description

public abstract String description

Description for the connector used for rendering purposes

Returns:

the description of the connector

iconFileName

public abstract String iconFileName

The name of the icon file to be used for rendering purposes in the design pallet

Returns:

the icon file name of the connector

Default:

"default"

scope

public abstract ScopeType scope

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

Returns:

the scope of the connector

Default:

org.adroitlogic.x.api.config.ScopeType.INTEGRATION_FLOW

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:

true

exchangePattern

public abstract ExchangePattern exchangePattern

Specify if the current ingress connector expects a response one of ExchangePattern.IN_OUT or ExchangePattern.IN_ONLY is expected

Returns:

the exchange pattern of the connector

Default:

org.adroitlogic.x.api.ExchangePattern.IN_OUT

documentationURL

public abstract String documentationURL

The location of the documentation page for the particular Ingress Connector

Returns:

the URL of the documentation page

Default:

"https://developer.adroitlogic.com/connectors/"