org.mule.runtime.api.component

Interface Component

All Known Subinterfaces:

ConfigurableObjectProvider, ExecutableComponent, ObjectProvider

All Known Implementing Classes:

AbstractComponent, PoolingProfile

public interface Component

This interface is the most abstracted representation of a configuration element in a mule artifact. It contains the minimal required contract for components.

Annotations are handled by the runtime and must not be tampered by custom implementations. The runtime will put values and remove values from the annotations and that behaviour should not be changed by any custom implementation.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Component.Annotations Constants related to annotations placed over components in the configuration files.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATIONS_PROPERTY_NAME Property name required by implementations of this class for holding annotations.
static String	NS_MULE_DOCUMENTATION
static String	NS_MULE_PARSER_METADATA

Method Summary

Modifier and Type	Method and Description
Object	getAnnotation(QName name) Gets the value of specified annotation.
Map<QName,Object>	getAnnotations() Gets all annotations.
default String	getDslSource()
default ComponentIdentifier	getIdentifier()
ComponentLocation	getLocation()
default String	getRepresentation()
Location	getRootContainerLocation() The actual root container component location.
void	setAnnotations(Map<QName,Object> annotations) Sets annotations to the object.

Field Detail

NS_MULE_DOCUMENTATION

static final String NS_MULE_DOCUMENTATION

See Also:

Constant Field Values

NS_MULE_PARSER_METADATA

static final String NS_MULE_PARSER_METADATA

See Also:

Constant Field Values

ANNOTATIONS_PROPERTY_NAME

static final String ANNOTATIONS_PROPERTY_NAME

Property name required by implementations of this class for holding annotations.

See Also:

Constant Field Values

Method Detail

getAnnotation

Object getAnnotation(QName name)

Gets the value of specified annotation.

Returns:

the value of specified annotation

getAnnotations

Map<QName,Object> getAnnotations()

Gets all annotations.

Returns:

all annotation

setAnnotations

void setAnnotations(Map<QName,Object> annotations)

Sets annotations to the object.

getLocation

ComponentLocation getLocation()

Returns:

the location properties of this component in the mule app configuration, or null if this object was generated programmatically and not from a configuration element.

getRootContainerLocation

Location getRootContainerLocation()

The actual root container component location. Some components may belong to a template component in the configuration such as a subflow or a module operation. Since those are template that end up being part of another root container component, like a flow, then the root container may differ from the one on ComponentLocation#getRootContainerLocation().

Returns:

the root container component location.

getIdentifier

default ComponentIdentifier getIdentifier()

Returns:

the type identifier for this component.

getRepresentation

default String getRepresentation()

Returns:

a representation of a flow element to be logged in a standard way.

getDslSource

default String getDslSource()

Returns:

the source code of this element in the DSL.