org.mule.api.annotations

Annotation Type Connector

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

This annotation defines a class that will export its functionality as a Mule Connector. Creating a Connector Class assumes that you enhance this class to enable your code to access a target resource.

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

1. It cannot be an interface or abstract
2. It must be public
3. It cannot have a typed parameter (no generics)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	friendlyName Provides a friendly name for the module.
String	name The name of the connector.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	configElementName Deprecated.
ConnectivityTesting	connectivityTesting Deprecated.
String	description Short description about the annotated module.
String	keywords A comma separated list of keywords to make the search on the Studio palette easier.
MetaDataSwitch	metaData Deprecated.
String	minMuleVersion Minimum Mule version required
String	namespace Namespace of the connector
String	schemaLocation Location URI for the schema
String	schemaVersion The schema version of the connector.

Element Detail

name

public abstract String name

The name of the connector.

friendlyName

public abstract String friendlyName

Provides a friendly name for the module.

schemaVersion

public abstract String schemaVersion

The schema version of the connector. Defaults to 1.0.

Default:

"1.0"

namespace

public abstract String namespace

Namespace of the connector

Default:

""

schemaLocation

public abstract String schemaLocation

Location URI for the schema

Default:

""

minMuleVersion

public abstract String minMuleVersion

Minimum Mule version required

Default:

"3.5.0"

configElementName

@Deprecated
public abstract String configElementName

Deprecated.

Name of the configuration element

Default:

"config"

description

public abstract String description

Short description about the annotated module.

Default:

""

connectivityTesting

@Deprecated
public abstract ConnectivityTesting connectivityTesting

Deprecated.

This attribute is deprecated, use TestConnectivity annotation instead

Default:

org.mule.api.annotations.ConnectivityTesting._DEPRECATED

metaData

@Deprecated
public abstract MetaDataSwitch metaData

Deprecated.

This attribute is deprecated, connectors will have static or dynamic metadata from now on

Default:

org.mule.api.annotations.MetaDataSwitch._DEPRECATED

keywords

public abstract String keywords

A comma separated list of keywords to make the search on the Studio palette easier.

Default:

""