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 Cloud Connector.

There are a few restrictions as to which types as valid for this annotation: - It cannot be an interface - It must be public - It cannot have a typed parameter (no generic)


Required Element Summary
 String name
          The name of the connector.
 
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.
 String friendlyName
          Provides a friendly name for the module.
 MetaDataSwitch metaData
          Whether metadata is enable or not in this connector
 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.

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.2"

friendlyName

public abstract String friendlyName
Provides a friendly name for the module.

Default:
""

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.ON

metaData

public abstract MetaDataSwitch metaData
Whether metadata is enable or not in this connector

Default:
org.mule.api.annotations.MetaDataSwitch.ON


Copyright © 2010–2013 MuleSoft, Inc.. All rights reserved.