org.adroitlogic.ultraesb.api.template

Annotation Type MediationTemplate

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

Main annotation to mark a class as an UltraESB template. This is an class level annotation specifying the main user interface properties as well as the template key used withing the ESB.

Since:

2.0.0

Author:

Ruwan

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	key Defines the key that is associated with the annotated template, this parameter MUST be specified for the annotation to be valid.
String	label Label of the template, mainly used in user interface rendering

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	comment Template comment, describes the template actions briefly, mainly used in user interface rendering
String	description Template description, describes the template actions briefly [optionally with using dynamically fed parameter values with $variable format], mainly used in user interface rendering
MediationTemplate.Flow	flow Template flow, specifies the valid flow/s to this mediation template
String	icon Template icon path relative to the base URL for the template, mainly used in user interface rendering
TemplateType	type The type of the template, used to categorize the templates.

Element Detail

key

public abstract String key

Defines the key that is associated with the annotated template, this parameter MUST be specified for the annotation to be valid. This has to be unique among the templates globally as it is used as the template identifier in the ESB

Returns:

the template key

label

public abstract String label

Label of the template, mainly used in user interface rendering

Returns:

the template label

type

public abstract TemplateType type

The type of the template, used to categorize the templates. Mainly used in the user interface designing

Returns:

the template type

Default:

org.adroitlogic.ultraesb.api.template.TemplateType.GENERIC

icon

public abstract String icon

Template icon path relative to the base URL for the template, mainly used in user interface rendering

Returns:

the icon path of the template

Default:

""

description

public abstract String description

Template description, describes the template actions briefly [optionally with using dynamically fed parameter values with $variable format], mainly used in user interface rendering

Returns:

the template description

Default:

""

comment

public abstract String comment

Template comment, describes the template actions briefly, mainly used in user interface rendering

Returns:

the template comment

Default:

""

flow

public abstract MediationTemplate.Flow flow

Template flow, specifies the valid flow/s to this mediation template

Returns:

Default:

org.adroitlogic.ultraesb.api.template.MediationTemplate.Flow.BOTH