All Classes and Interfaces
Class
Description
Exception to be thrown by operations which are trying to use an expired access token.
Indicates that the annotated parameter represent an account id
Defines an alias for a Java type.
Applied to router components, specifies to the DataSense engine that the payload and attributes types that will exit the owning
router component is the combination of the ones from every route in the router.
Declares an array of
classes of an StereotypeDefinition, to communicate and declare which
StereotypeDefinition the annotated component allows to be injected with.Indicates that the annotated parameter represent an API Key
Describes a Connection with is secured through an API Key
StereotypeDefinition for any generic config global element.Provides context information about the disposal of the Artifact enclosing the Extension.
Extensions are typically contained in Apps or Domains, which going forward we will refer to as the enclosing artifact.
Declares the annotated
ComponentModel's attributes MetadataType to the type represented by the JSON Schema.StaticResolver implementation for the attributes OutputModel.Handles the dynamic
MetadataType resolving for the output attributes of an associated component.Declares the annotated
ComponentModel's attributes MetadataType to the type represented by the provided element
in the XSD Schema.Provides information about the request that is sent to the authorization url during an OAuth2 dance using the
Authorization-Code grant type.
Authentication represents an authentication request and contains authentication information if the request was
successful.This handler allows to configure the current context's authentication, used for encryption and inbound authentication, based on
a given
Authentication request.To be used on implementations of
ConnectionProvider, indicates that the provided connections will be authenticated
using Authorization-Code grant type of the OAuth2 specification.ConnectionProvider implementations which are also annotated with AuthorizationCode MUST have a field of
this type.Allows the customization of a
Source available and default BackPressureMode.Indicates which type of back pressure has the runtime applied on a give message.
Provides information about how the runtime applied back pressure on a certain
eventDescribes the available back pressure strategies
Describes a Connection with is secured through Basic Authentication
Marks a binding between a parameter in a
ValueProvider or a
SampleDataProvider to an extraction expression.A
ConnectionProvider specialization which lazily creates and caches connections.Enum that stores a list of valid categories that a plugin can be assigned to.
A
Chain allows a given Operation to receive a chain of message processors to be executed as part
of the operation's execution.Describes how many times the inner chain in a scope or route is expected to be called each time the owning component is
executed.
MetadataContext specialization adding information relevant to ChainInputTypeResolver instances.Applied to
Chain or Route parameters, allows specifying a ChainInputTypeResolver to provide DataSense
information about the payload and attributes that will enter said chain/route.A type resolver to specify the payload and attributes types that enter the inner chain within a scope or route.
StereotypeDefinition for the chain of components defined through a DSL.Marks a field or parameter annotated with
Parameter as actually representing a class.To be used on implementations of
ConnectionProvider, indicates that the provided connections will be authenticated
using Client Credentials grant type of the OAuth2 specification.ConnectionProvider implementations which are also annotated with ClientCredentials MUST have a field of
this type.Indicates that the annotated parameter represent a Client ID
Indicates that the annotated parameter represent a Client Secret
Indicates the
SourceClusterSupport that a Source should have when running in cluster mode.This callback is how non blocking operations notify their outcome.
Marks a Component's
ParameterModel as the Component ID.Indicates that the annotated member should be injected with the currently active configuration instance.
Binds the annotated member with the
ParameterModel of the same name and
type that exists in the config associated to the
container of the annotated member.Annotation to be used in a
String type Parameter field or parameter which value is a reference to a global
configuration element.Container for the
Repeatable ConfigReference annotationUsed to express that a class should be used to describe a
org.mule.runtime.extension.api.introspection.Configuration
model.StereotypeDefinition for elements within the configuration global element.Allows to reference a list of classes from which a
org.mule.runtime.extension.api.introspection.Configuration model is
to be inferred.Indicates that the annotated class models the configuration of a NTLM Proxy
Indicates that the annotated class models the configuration of a generic Proxy
Indicates that the annotated member should be injected with a currently active connection.
Indicates that the annotated parameter represent a Connection ID
Handles connections of the generic
Connection type, which are created from a configuration object of the generic type
Config.Annotation to be used on a
Class also annotated with Extension, to list the ConnectionProviders that
the extension exposes.StereotypeDefinition for any generic connection.Represents the result of a Connection Validation.
Provides message correlation information.
Credentials holds credentials information for a user.Builder for a
Credentials implementation.Describes the possible placements credentials can have inside a HTTP request
This annotation is meant to be applied on fields of classes or on operation's arguments.
Default immutable implementation for the
MetadataKey.Indicated that the current annotated member is deprecated from the extension.
Describes a Connection with is secured through Digest Authentication
Allows to specify a custom label for the element and/or field to be used in the UI.
This is a manager for handling distributed tracing for sources/operations.
Indicates that the annotated parameter represent a network domain.
This annotation signals that the minimum mule version (either obtained from the
MinMuleVersion annotation or the one
calculated automatically) for the annotated component should not bump the min mule version of other components that interact
with it.Indicates that the annotated
Source supports emitting responses back to the client once a generated message is
processed (either correctly or incorrectly).Indicates that the annotated parameter represents an Endpoint
StereotypeDefinition for error-handler core componentsIdentifies a Mule Error Type to be declared by extensions and must be implemented by an
Enum.A component responsible for providing an idempotent
Set of ErrorTypeDefinition representing the list of errors
that a component can throw.Annotation for
Extension level to communicate and declare the ErrorTypeDefinitions that the whole extension
managesAllows to specify an example for a
EnrichableModel to be used in the UI.Allows the developer to provide generic logic to enrich exceptions, either via logging, sending notifications, etc.
Signals that the annotated component should not be considered while generating a Connectivity Schema.
Allows to specify the
ExecutionType of the annotated component.In order for Mule to determine the best way to execute different components, it needs to know the type of work the components
will be performing.
Specifies classes and resources that an extension should expose beyond the default
ClassLoader isolation.Allows customizing how a
ParameterModel supports expressions.Allows to reference a list of classes from which an Extension's functions for usage in the expression language are to be
inferred.
Enumerates the different types of support that a given component can provide regarding expressions
Denotes that a given type can be extended by others.
This annotation defines a class that will export its functionality as a Mule module.
The
ExtensionsClient is a simple interface for executing extension operations programmatically.Specifies that the annotated element depends on a library which is not packaged with the extension.
Enumerates the different types of external libraries an extension may require
Container for the
Repeatable ExternalLib annotationContainer for the
Repeatable FieldValues annotationMarks a parameter as having a field or set of fields that have the capability of having its
values resolved.Marks a field or parameter annotated with
Parameter as a path to a file or directory.Declares an array of
classes of an NotificationActionProvider, to communicate and declare which
NotificationActionDefinitions a component could fire.Allows to execute custom logic when the flow on which an operation is being executed finishes.
Annotation to be used in a
String type parameter field or parameter that is a reference to a flow in a mule app.StereotypeDefinition for flow core componentsIndicates that the annotated parameter represents a network host
Describes the possible placements a parameter can have inside a HTTP request
Ignores a field or method inside a complex type.
An
InputStream implementation that allows obtaining a repeatable stream from the contents of an immutable file that
already exists in the local file system.A special kind of stereotype definition, to be automatically added to top level pojos and interfaces form an extension that do
not already have an associated stereotype.
Container for the
Repeatable Import annotationDeclares the annotated
ParameterModel's MetadataType to the type represented by the provided JSON Schema.StaticResolver implementation for the ParameterModels.Handles the dynamic
MetadataType resolving for the Content parameter of an associated component.Declares the annotated
ParameterModel's MetadataType to the type represented by the provided element in the XSD
Schema.Describes the Java versions supported by Mule
Used in the same class as
@Extension, this annotation indicates the versions of Java supported by the extension.Describes a Connection with is secured through Kerberos.
A parameter type which allows to get values as they were provided in the DSL, preventing the runtime from resolving expressions
or applying any transformations.
Use this annotation on operation methods and
Source classes which return either String or InputStream.This component provides the capability to store data so future requests for that data can be served faster and accessed from
every
InputTypeResolver, TypeKeysResolver and OutputTypeResolverEnumerates all the components that can be retrieved in a
MetadataResult.Metadata resolving context, provides access to the Config and Connection used during metadata fetch invocation.
A key, that with the given ID, represents a
MetadataType.An implementation of the builder design pattern to create a new
MetadataKey instance.Marks one of the parameters of an Operation or Source as the key for the metadata lookup.
Marks a field inside a POJO that represents a composed
MetadataKey as one of the parts of that composed
MetadataKey.Associates the annotated Component to a
TypeKeysResolver, and an OutputTypeResolver that will be used to
resolve the Component's MetadataType dynamically
This annotation can be used at Operation or Extension level.This annotation signals that the annotated component relies on a Mule Runtime feature that is only available starting with a
specific version.
StereotypeDefinition for any generic config global element.RuntimeException implementation to throw Exceptions that indicates explicitly the ErrorTypeDefinition
that is wanted to throw.ErrorTypeDefinition Enum which publish the available errors that the Mule Runtime provides to be extended from
an extension.Marker interface that identifies a given
StereotypeDefinition as a Mule stereotype.A base interface for resolvers in which they specify it's category name.
Marker, interface to indicate that the implementing component does not support connectivity testing.
Used to express that the annotated element should not support being used implicitly.
Identifies a notification action to be declared by extensions and must be implemented by an
Enum.A component responsible for providing an immutable
Set of NotificationActionDefinitions.Annotation for Extension level to communicate and declare the
NotificationActionDefinitions that the whole extension
emits.This component allows firing
ExtensionNotifications with both custom data and default one.Indicates that the annotated parameter represent a NTLM domain.
Null
MetadataKey implementation that represents the absence of a keyNull implementation of
InputTypeResolver, AttributesTypeResolver and TypeKeysResolver, used to
represent the absence of any of them when required.Indicates that the annotated parameter should never be assigned a
null value, even though such value is a valid
assignment on the mule DSL.This annotation is used to annotate fields on a
ConnectionProvider which supports OAuth.Similar to
Parameter, but intended to be used exclusively on fields of a ConnectionProvider which supports
OAuth.An object which holds information about an OAuth authorization
StereotypeDefinition for a generic Object definitionA generic object key value store
Creates and manages
ObjectStore instances.Annotation to be used in a field or parameter which value is a reference to a global object store element
Immutable object which contains settings parameters regarding how should a particular
ObjectStore instance behave.A Builder for creating
ObjectStoreSettingsStereotypeDefinition for a generic ObjectStore definitionMarks a parameter or parameter group as a value that has the capability of resolve
values for this one.Specifies an
ArtifactLifecycleListener for reacting to the enclosing artifact's lifecycle events.Used to indicate that an annotated method in a
Source should be executed when the runtime applies back pressure on a
message generated by the owning source.Applied to router components, specifies to the DataSense engine that the payload/attributes types that will exit the owning
router component is the union of the payload/attributes of each route in the router.
Used to indicate that an annotated method should be executed when a generated event was processed by the owning flow but an
error was thrown.
StereotypeDefinition for on-error core componentsThis annotation can be used at Operation level or at
Extension level as a common handler for all the Operations, When
an exception occurs in an operation the Enricher Class declared in this annotation will be called immediately, passing to the
enrichException method the exception thrown by the operation. an Operation level enricher will override the OnException
level one.Used to indicate that an Source's method should be executed when a generated event is successfully processed by the owning
flow.
Used to indicate that an annotated method should be executed when a generated event was processed by the owning flow, doesn't
taking in account if the processing finished successfully or not.
Parameterizes an operation execution performed through the
ExtensionsClientAllows to reference a list of classes from which an Extension's operations are to be inferred.
The type of joining actions that operations can take regarding transactions.
Marks a
Parameter field a optional.Lists the possible strategies to determine the correlation id that should be sent on an outbound operation which supports
correlation.
Declares the annotated
ComponentModel's output MetadataType to the type represented by the JSON Schema.Associates the annotated Component to an
OutputTypeResolver that will be used to resolve the Component's return
type dynamicallyStaticResolver implementation for the OutputModels.Handles the dynamic
MetadataType resolving for the output of an associated component.Declares the annotated
ComponentModel's output MetadataType to the type represented by the provided element in
the XSD Schema.This interface provides functionality for consuming a data feed in pages.
Marks a field inside a mule extension as being a parameter that the user can set.
Allows setting directives regarding syntax and semantics of the generated XML DSL.
Allows to define a group of parameters which share some kind of special relationship and thus makes sense for them to belong to
the same group.
A parameter type that gives the capability of:
Get the configured expression: With
ParameterResolver.getExpression() returns the possible expression used to resolve the
parameter value
Differ the resolution: Using ParameterResolver.resolve() resolves the parameter value of type ParameterResolver
A
TypeKeysResolver that can handle the resolution of multi-level MetadataKey in a lazy way.Applied to scope components, specifies to the DataSense engine that the payload and attributes types that will exit the owning
scope component is the same one that originally exited the scope chain.
Indicates that the annotated parameter represents a password.
Defines the particular place of a
Parameter field in the extension configuration window.Contains context associated to each polling execution, and allows to dispatch items for execution through the
PollContext.accept(Consumer) method.An item obtained through a poll
The possible outcomes of submiting an item for processing through the
PollContext.accept(Consumer) methodA Special kind of
Source which automatically handles polling, idempotency and watermarking.A
ConnectionProvider specialization which pools connections.Indicates that the annotated parameter represent a network port.
Specifies packages that an extension should expose beyond the default
ClassLoader isolation.StereotypeDefinition for any generic processor that can be executed by mule runtime.A component which has its own way of reconnecting.
Callback used to notify the runtime about the outcome of a reconnection attempt.
This annotation is meant to be applied on fields of classes which are serving as top level elements which can be referenced by
name, such as configs or global objects.
Marker annotation which indicates that the annotated parameter is required for Metadata, this indicates that any other not
annotated parameter won't be considered as part of the metadata resolution, so if the value changes the metadata resolution
won't be triggered for those connectors
Defines if the extension requires an enterprise license to run.
Defines if the extension license requires a custom entitlement.
Represents the result of a component's execution.
Builds instances of
ResultA
Route allows a given Operation to receive a chain of message processors along with a set of
parameters, to be executed as part of the operation's execution.Deprecated.
since 0.9.0.
Contains DataSense propagation information for routers, by using a
MessageMetadataType to describe the typed message
that enters each Route (input) and the message that exits them (output)This annotation is meant to be applied on fields of classes.
Associates a
Source class or operation method with a SampleDataProvider.Exception to indicate than an error occurred fetching sample data through a SampleDataProvider.Implement this interface to enhance operations and
message sources with sample data that is representative of
the one that the component will produce in real production scenarios.Contains DataSense propagation information by using a
MessageMetadataType to describe the typed message that enters a
Chain (input) and the message that exits it (output)Indicates that the annotated parameter holds a value which should be encrypted.
Indicates that the annotated parameter holds a secret token
Indicates that the annotated parameter holds a security token
Specifies a list of custom semantic terms to be added on the annotated component.
StereotypeDefinition for serializer componentsIndicates that the annotated parameter holds a session ID
Base class to write message sources compliant with a given
SourceModel.A callback to allow
Source implementations to communicate generated messages back to the runtime so that they can be
processed.A context interface to correlate a message generated by a
Source to a particular stateDescribes the operation modes that a
Source can have when running in cluster mode.Callback used by
sources in order tell the runtime that they will process the flow's response in an asynchronous
manner (from now on, async sources).A class that represents the result of processing a message from a
Source through a flow, this reports whether the
result of the processing was successful or terminated with errors.StereotypeDefinition for any generic source that can be executed by mule runtime.The type of beginning actions that sources can take regarding transactions.
Handles the construction of a custom
MetadataType in any format to be set in a Typed component statically when
building the extension avoiding dynamically metadata resolution when we know exactly the non necessarily java type structure at
compile time.Annotation for sources, operations, configurations and Connection Providers l to communicate and declare the
StereotypeDefinitions that characterize the annotated componentsA widely held but fixed and oversimplified image or idea of the owning model.
Intended to be used on operation methods and implementations of
Source, this annotation indicates that such component
supports streaming.This class provides helper methods to deal with repeatable streaming resources which are contained into structures of arbitrary
complexity.
StereotypeDefinition for sub-flow core componentsContainer for the
Repeatable SubTypeMapping annotationAllows to specify a summary for a
EnrichableModel to be used in the UI.Indicates that the annotated parameter holds a value which identifies a tenant
Marks a
Parameter field as one that supports a multi line string input both in the editor (when it is populated from
the UI) and in the DSL.Declares an array of
classes of an ErrorTypeProvider, to communicate and declare which
ErrorTypeDefinition the operation could throw.Indicates that the annotated parameter holds a token ID
Base contract for a component which can participate in a transaction
Connections which support transaction must implement this interface in order to start or join a current transaction.
Allows to manipulate the transaction that was started and bound to an specific
SourceCallbackContextAllows setting directives regarding syntax and semantics of the generated XML DSL.
Handles the dynamic resolution of the available
MetadataKey that can be used to populate the MetadataKeyId of an
associated ComponentAssociates the annotated Parameter to an
InputTypeResolver that will be used to resolve the Parameter's
MetadataType dynamicallyDescribes a Connection which is not secured through any authentication type.
Indicates that the annotated parameter represent an URL
Indicates that the annotated parameter represent a path relative to a base URL
Indicates that the annotated parameter holds an username
Stereotype annotation to mark that one or more operations are validators.
StereotypeDefinition for any validator component.Represents a possible and valid value for a parameter.
An implementation of the builder design pattern to create a new
ValueBuilder instance.Marks a field inside a POJO that represents a composed
Value as one of the parts of that composed Value.Provider of
values.This callback is how Routers notify the end of its execution when no result is produced.
Specialization of
TransactionalConnection for connections which can participate of XA transactionsAllows the customization of the schema attributes.