Index (Mule DevKit Annotations 3.6.0 API)

A B C D E F G H I L M N O P Q R S T V

A

AnnotationsConstants - Interface in org.mule.api.annotations: Helper class to point to the current mule version.

B

BasicAuthPassword - Annotation Type in org.mule.api.annotations.rest: Represents the password that is going to be used to send an authentication header along with BasicAuthUsername
BasicAuthUsername - Annotation Type in org.mule.api.annotations.rest: Represents the username that is going to be used to send an authentication header along with BasicAuthPassword
BinaryParam - Annotation Type in org.mule.api.annotations.rest: Specifies if the payload is a binary type.

C

Category - Annotation Type in org.mule.api.annotations: This annotation is meant to be applied to methods marked with Processor/Source and it is used by the Studio generation and the Doclet to organize the message processors.
CONFIG_ELEMENT_NAME - Static variable in interface org.mule.api.annotations.AnnotationsConstants: Name of the configuration element
Configurable - Annotation Type in org.mule.api.annotations: Marks a field inside a Connector as being configurable.
Configuration - Annotation Type in org.mule.api.annotations.components: This annotation is used to define a connectionless strategy.
Connect - Annotation Type in org.mule.api.annotations: This annotation marks a method inside an @Connector scope as the responsible for creating a connection.
ConnectionIdentifier - Annotation Type in org.mule.api.annotations: This annotation marks a method inside a Connector as the responsible for identifying a connection.
ConnectionKey - Annotation Type in org.mule.api.annotations.param: Marks a parameter inside Connect as part of the key for the connector lookup.
ConnectionManagement - Annotation Type in org.mule.api.annotations.components: This annotation is used to define a basic auth connection strategy.
ConnectionStrategy - Annotation Type in org.mule.api.annotations: Defines the field to be injected as connection strategy into a Connector.
ConnectivityTesting - Enum in org.mule.api.annotations: Deprecated.
Connector - Annotation Type in org.mule.api.annotations: This annotation defines a class that will export its functionality as a Mule Connector.
ConnectStrategy - Enum in org.mule.api.annotations: Out of the box enumeration of available connection strategies
CorrelationGroupSize - Annotation Type in org.mule.api.annotations.param
CorrelationId - Annotation Type in org.mule.api.annotations.param
CorrelationSequence - Annotation Type in org.mule.api.annotations.param

D

Default - Annotation Type in org.mule.api.annotations.param: Specifies a default value to a Configurable field or a Processor/Source parameter.
DEFAULT_FETCH_SIZE - Static variable in annotation type org.mule.api.annotations.Paged
DEFAULT_ORDER - Static variable in annotation type org.mule.api.annotations.display.Placement
DEFAULT_SCHEMA_VERSION - Static variable in interface org.mule.api.annotations.AnnotationsConstants: The schema version of the @org.mule.api.annotations.Connector or @org.mule.api.annotations.Module.
Disconnect - Annotation Type in org.mule.api.annotations: This annotation marks a method inside a Connector as the responsible for disposing a connection.

E

Email - Annotation Type in org.mule.api.annotations.param: Specifies a default email pattern.
ExceptionPayload - Annotation Type in org.mule.api.annotations.param
ExpressionEnricher - Annotation Type in org.mule.api.annotations: This annotation marks a method inside a ExpressionLanguage as the responsible for enriching mule messages based on an expression.
ExpressionEvaluator - Annotation Type in org.mule.api.annotations: This annotation marks a method inside a ExpressionLanguage as the responsible for evaluating expressions.
ExpressionLanguage - Annotation Type in org.mule.api.annotations: This annotation defines a class that will export its functionality as a Mule Expression Language.

F

Filter - Annotation Type in org.mule.api.annotations: This annotation marks a method inside a Connector as a callable from within a Mule flow to filter a message.
FriendlyName - Annotation Type in org.mule.api.annotations.display: Allows to specify a better label to the element and/or field to be used in Studio editor.

G

GENERIC_CLOUD_CONNECTOR_LARGE - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
GENERIC_CLOUD_CONNECTOR_SMALL - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
GENERIC_ENDPOINT_LARGE - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
GENERIC_ENDPOINT_SMALL - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
GENERIC_TRANSFORMER_LARGE - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
GENERIC_TRANSFORMER_SMALL - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.

H

Handle - Annotation Type in org.mule.api.annotations: This annotation indicates which method in the @Handler class should be called when the component is invoked
Handler - Annotation Type in org.mule.api.annotations.components: Marks the class annotated as an @OnException handler component
HttpBasicAuth - Annotation Type in org.mule.api.annotations.components: This annotation is used to define HTTP Authentication RFC2617 strategy (see http://tools.ietf.org/html/rfc2617), where it assumes that the custom component contains fields annotated with BasicAuthUsername and BasicAuthPassword.
HttpMethod - Enum in org.mule.api.annotations.rest

I

Icons - Annotation Type in org.mule.api.annotations.display: Deprecated.
Ignore - Annotation Type in org.mule.api.annotations: Ignores a field inside a complex type.
InvalidateConnectionOn - Annotation Type in org.mule.api.annotations: Deprecated.
Use ReconnectOn instead
InvocationHeaders - Annotation Type in org.mule.api.annotations.param: Used on Processor methods, this annotation marks the method parameter that will be used to pass in one or more of the headers received.

L

Literal - Annotation Type in org.mule.api.annotations.param: Specifies that Processor/Source/Filter String or List parameter will not be evaluated, enabling each of them to receive a plain MEL into any operation.

M

MessageRootId - Annotation Type in org.mule.api.annotations.param
MessageUniqueId - Annotation Type in org.mule.api.annotations.param
MetaDataCategory - Annotation Type in org.mule.api.annotations.components: Describes a grouping DataSense concrete class, which will be responsible for returning types and the descriptions of any of those types
MetaDataCategory - Annotation Type in org.mule.api.annotations: Deprecated.
MetaDataKeyParam - Annotation Type in org.mule.api.annotations.param: Marks a parameter inside @Processor as the key for the metadata lookup.
MetaDataKeyParamAffectsType - Enum in org.mule.api.annotations.param: It defines the target of a dynamic parameter when annotated with MetaDataKeyParam
MetaDataKeyRetriever - Annotation Type in org.mule.api.annotations
MetaDataOutputRetriever - Annotation Type in org.mule.api.annotations: This annotation marks a method as a describer for org.mule.common.metadata.MetaData for output scenarios, for a given org.mule.common.metadata.MetaDataKey
MetaDataRetriever - Annotation Type in org.mule.api.annotations: The method annotated with MetaDataRetriever describes the metadata for the received metadata key parameter.
MetaDataScope - Annotation Type in org.mule.api.annotations: Used to differentiate grouping data sense types at operation or class level.
MetaDataStaticKey - Annotation Type in org.mule.api.annotations.param: It defines the specific MetaData type of the annotated value.
MetaDataSwitch - Enum in org.mule.api.annotations: Deprecated.
Mime - Annotation Type in org.mule.api.annotations
MIN_MULE_VERSION - Static variable in interface org.mule.api.annotations.AnnotationsConstants: The AnnotationsConstants.MIN_MULE_VERSION variable should target the current mule version DevKit is working on.
Module - Annotation Type in org.mule.api.annotations: This annotation defines a class that will export its functionality as a Mule module.

N

NoMetaData - Annotation Type in org.mule.api.annotations: This annotation marks a @Processor to avoid discovering metadata with @MetaDataRetriever and @MetaDataKeyRetriever mechanism.

O

OAuth - Annotation Type in org.mule.api.annotations.oauth: A class annotated with @OAuth is applied to a Connector that uses the OAuth 1.0a protocol for authentication.
OAuth2 - Annotation Type in org.mule.api.annotations.oauth: The class annotated with OAuth2 is applied to an Connector that uses the OAuth 2.0 a protocol for authentication.
OAuthAccessToken - Annotation Type in org.mule.api.annotations.oauth: A class annotated with OAuth or OAuth2 needs to have exactly one field annotated with @OAuthAccessToken.
OAuthAccessTokenIdentifier - Annotation Type in org.mule.api.annotations.oauth: Deprecated.
OAuthAccessTokenSecret - Annotation Type in org.mule.api.annotations.oauth: A class annotated with OAuth or OAuth2 needs to have exactly one field annotated with @OAuthAccessTokenSecret.
OAuthAuthorizationParameter - Annotation Type in org.mule.api.annotations.oauth: Authorization parameter that needs to be appended to the authorize URL.
OAuthCallbackParameter - Annotation Type in org.mule.api.annotations.oauth: Certain services send parameters back in a callback URL.
OAuthConsumerKey - Annotation Type in org.mule.api.annotations.oauth: A class annotated with OAuth or OAuth2 needs to have exactly one field annotated with @OAuthConsumerKey and this field must be of type String.
OAuthConsumerSecret - Annotation Type in org.mule.api.annotations.oauth: A class annotated with OAuth or OAuth2 needs to have exactly one field annotated with @OAuthConsumerKeySecret and this field must be of type String.
OAuthInvalidateAccessTokenOn - Annotation Type in org.mule.api.annotations.oauth: Deprecated.
Use ReconnectOn instead
OAuthMessageSigner - Enum in org.mule.api.annotations.oauth: The signature method to be used in the OAuth 1.0a flow.
OAuthPostAuthorization - Annotation Type in org.mule.api.annotations.oauth: This annotation marks a method inside a OAuth as the responsible for setting up the connector AFTER the OAuth dance has been completed.
OAuthProtected - Annotation Type in org.mule.api.annotations.oauth: This annotation marks a method inside a Connector as requiring an OAuth access token.
OAuthScope - Annotation Type in org.mule.api.annotations.oauth: In case the access to the Protected Resources needs to be restricted in scope a field annotated with @OAuthScope must be present and contain a String indicating the desired scope.
OAuthSigningStrategy - Enum in org.mule.api.annotations.oauth: The enum defines where to include the OAuth 1.0a parameters.
OnException - Annotation Type in org.mule.api.annotations.lifecycle: This is a lifecycle annotation, since the handler will be injected in the common cycle when an exception occurs.
Optional - Annotation Type in org.mule.api.annotations.param: Marks a Configurable field or a Processor/Source parameters as optional.
org.mule.api.annotations - package org.mule.api.annotations
org.mule.api.annotations.components - package org.mule.api.annotations.components
org.mule.api.annotations.display - package org.mule.api.annotations.display
org.mule.api.annotations.licensing - package org.mule.api.annotations.licensing
org.mule.api.annotations.lifecycle - package org.mule.api.annotations.lifecycle
org.mule.api.annotations.oauth - package org.mule.api.annotations.oauth
org.mule.api.annotations.param - package org.mule.api.annotations.param
org.mule.api.annotations.rest - package org.mule.api.annotations.rest
OverrideAtProcessors - Annotation Type in org.mule.api.annotations: Deprecated.

P

Paged - Annotation Type in org.mule.api.annotations: This annotation marks a method inside a Connector as an operation that will return a paged result set.
Password - Annotation Type in org.mule.api.annotations.display: Identifies a field or method parameter as being a password or more generally as a variable which contains data that should not be displayed as plain text.
Path - Annotation Type in org.mule.api.annotations.display: Identifies a field or method parameter as being a path to a file.
Placement - Annotation Type in org.mule.api.annotations.display: Adds placement information to a field or parameter.
Processor - Annotation Type in org.mule.api.annotations: This annotation marks a method inside a Connector as a callable from within a Mule flow.

Q

Query - Annotation Type in org.mule.api.annotations: This annotation is meant to be applied to support easy query building by using DataSense Query Language, DSQL.
QueryCustomMetadata - Annotation Type in org.mule.api.annotations: When using @Query and @QueryTranslator the query metadata is generated automatically based on the types and fields selected.
QueryOperator - Enum in org.mule.api.annotations
QueryPart - Annotation Type in org.mule.api.annotations: This annotation is meant to be used in advanced Query scenarios.
QueryTranslator - Annotation Type in org.mule.api.annotations: This annotation is meant to translate an DSQL query into a native one.

R

ReconnectOn - Annotation Type in org.mule.api.annotations: This annotation can be attached to any method annotated with Processor.
RefOnly - Annotation Type in org.mule.api.annotations.param: Marks a Configurable field or a Processor/Source parameters as being passed by reference only.
Required - Annotation Type in org.mule.api.annotations: Annotation to mark a field as required.
RequiresEnterpriseLicense - Annotation Type in org.mule.api.annotations.licensing: Checks if the Module/Processor requires an Enterprise license.
RequiresEntitlement - Annotation Type in org.mule.api.annotations.licensing: Checks if the Module/Processor requires an Enterprise license with a particular entitlement.
RestCall - Annotation Type in org.mule.api.annotations.rest
RestExceptionOn - Annotation Type in org.mule.api.annotations.rest
RestHeaderParam - Annotation Type in org.mule.api.annotations.rest
RestHttpClient - Annotation Type in org.mule.api.annotations.rest
RestPostParam - Annotation Type in org.mule.api.annotations.rest
RestQueryParam - Annotation Type in org.mule.api.annotations.rest
RestTimeout - Annotation Type in org.mule.api.annotations.rest: This annotation can be attached to a RestCall to optionally specify a timeout in milliseconds for the rest call.
RestUriParam - Annotation Type in org.mule.api.annotations.rest

S

SessionHeaders - Annotation Type in org.mule.api.annotations.param: Used on component methods, this annotation marks the method parameter that will be used to pass in one or more of the headers received.
Source - Annotation Type in org.mule.api.annotations: This annotation marks a method inside a Connector as a callable from within a Mule flow and capable of generating Mule events.
SourceStrategy - Enum in org.mule.api.annotations
SourceThreadingModel - Enum in org.mule.api.annotations
Start - Annotation Type in org.mule.api.annotations.lifecycle: This is a lifecycle annotation.
Stop - Annotation Type in org.mule.api.annotations.lifecycle: This is a lifecycle annotation.
SUFIX_CONNECTOR_24X16_PNG - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
SUFIX_CONNECTOR_48X32_PNG - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
SUFIX_ENDPOINT_24X16_PNG - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
SUFIX_ENDPOINT_48X32_PNG - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
SUFIX_TRANSFORMER_24X16_PNG - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
SUFIX_TRANSFORMER_48X32_PNG - Static variable in annotation type org.mule.api.annotations.display.Icons: Deprecated.
Summary - Annotation Type in org.mule.api.annotations.display: Adds displaying information to a field or parameter.

T

TEST_CONNECTION - Static variable in annotation type org.mule.api.annotations.TestConnectivity
TestConnectivity - Annotation Type in org.mule.api.annotations: Method to test if a specific strategy is able to hit the endpoint
Text - Annotation Type in org.mule.api.annotations.display: Identifies a parameter a being large text input.
TransformerResolver - Annotation Type in org.mule.api.annotations: A TransformResolver is used to find transformers that match a certain criteria in the registry.

V

ValidateConnection - Annotation Type in org.mule.api.annotations: This annotation marks a method inside a Connector as the responsible for validating if the connector is actually connected or not.
valueOf(String) - Static method in enum org.mule.api.annotations.ConnectivityTesting: Deprecated.

Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.api.annotations.ConnectStrategy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.api.annotations.MetaDataSwitch: Deprecated.

Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.api.annotations.oauth.OAuthMessageSigner: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.api.annotations.oauth.OAuthSigningStrategy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.api.annotations.param.MetaDataKeyParamAffectsType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.api.annotations.QueryOperator: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.api.annotations.rest.HttpMethod: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.api.annotations.SourceStrategy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.api.annotations.SourceThreadingModel: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.mule.api.annotations.ConnectivityTesting: Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.api.annotations.ConnectStrategy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.api.annotations.MetaDataSwitch: Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.api.annotations.oauth.OAuthMessageSigner: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.api.annotations.oauth.OAuthSigningStrategy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.api.annotations.param.MetaDataKeyParamAffectsType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.api.annotations.QueryOperator: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.api.annotations.rest.HttpMethod: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.api.annotations.SourceStrategy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.api.annotations.SourceThreadingModel: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M N O P Q R S T V