org.mule.api.annotations
Annotation Type Module

@Target(value=TYPE)
@Retention(value=SOURCE)
@Documented
public @interface Module

This annotation defines a class that will export its functionality as a Mule module.

There are a few restrictions as to which types as valid for this annotation:

1. It cannot be an interface


2. It must be public


3. It cannot have a typed parameter (no generics)

Required Element Summary

String	friendlyName Provides a friendly name for the module.
String	name The name of the module.

Optional Element Summary

String	configElementName Name of the configuration element
ConnectivityTesting	connectivityTesting Whether connectivity testing is enabled or not in this connector
String	description Short description about the annotated module.
MetaDataSwitch	metaData Whether metadata is enable or not in this connector
String	minMuleVersion Minimum Mule version required
String	namespace Namespace of the module
boolean	poolable Defined the module itself as being poolable
String	schemaLocation Location URI for the schema
String	schemaVersion The version of the module.

Element Detail

name

public abstract String name

The name of the module.

friendlyName

public abstract String friendlyName

Provides a friendly name for the module.

schemaVersion

public abstract String schemaVersion

The version of the module. Defaults to 1.0.

Default:

"1.0"

namespace

public abstract String namespace

Namespace of the module

Default:

""

schemaLocation

public abstract String schemaLocation

Location URI for the schema

Default:

""

poolable

public abstract boolean poolable

Defined the module itself as being poolable

Default:

false

minMuleVersion

public abstract String minMuleVersion

Minimum Mule version required

Default:

"3.5.0"

configElementName

public abstract String configElementName

Name of the configuration element

Default:

"config"

description

public abstract String description

Short description about the annotated module.

Default:

""

connectivityTesting

public abstract ConnectivityTesting connectivityTesting

Whether connectivity testing is enabled or not in this connector

Default:

org.mule.api.annotations.ConnectivityTesting.OFF

metaData

public abstract MetaDataSwitch metaData

Whether metadata is enable or not in this connector

Default:

org.mule.api.annotations.MetaDataSwitch.OFF