org.mule.runtime.metadata.api.cache

Interface MetadataCacheIdGenerator<T>

All Known Subinterfaces:

ComponentParameterizationMetadataCacheIdGenerator

All Known Implementing Classes:

ComponentAstBasedMetadataCacheIdGenerator, ComponentParameterizationBasedMetadataCacheIdGenerator, DslElementBasedMetadataCacheIdGenerator

public interface MetadataCacheIdGenerator<T>

Provides a way to generate the MetadataCacheId of a given representation of a Component. The generated ID will take into account different elements of the Component configuration, depending on what's the associated element being cached with this ID.

In particular, different rules apply for the MetadataTypes resolution than those used for the MetadataKeys resolution.

Since:

4.1.4, 4.2.0

Method Summary

Modifier and Type	Method and Description
Optional<MetadataCacheId>	getIdForComponentAttributesMetadata(T component) Calculates the MetadataCacheId required to identify the MetadataType associated to the attributes of the given component.
Optional<MetadataCacheId>	getIdForComponentInputMetadata(T component, String parameterName) Calculates the MetadataCacheId required to identify the MetadataType associated to the parameter named parameterName of the given component.
Optional<MetadataCacheId>	getIdForComponentMetadata(T component) Calculates the MetadataCacheId required to identify the MetadataTypes associated to the given component.
Optional<MetadataCacheId>	getIdForComponentOutputMetadata(T component) Calculates the MetadataCacheId required to identify the MetadataType associated to the output of the given component.
Optional<MetadataCacheId>	getIdForGlobalMetadata(T component) Calculates the MetadataCacheId required to identify all the Metadata associated to the given component, and its siblings, based on the referenced global element configuration.
Optional<MetadataCacheId>	getIdForMetadataKeys(T component) Calculates the MetadataCacheId required to identify the MetadataKeys associated to the given component.

Method Detail

getIdForComponentOutputMetadata

Optional<MetadataCacheId> getIdForComponentOutputMetadata(T component)

Calculates the MetadataCacheId required to identify the MetadataType associated to the output of the given component. This method will take into account the values of the configured MetadataKey to provide an unique identifier of the component output type definition.

Parameters:

component - the configured component

Returns:

a MetadataCacheId that identifies the component output type with all its current configuration or Optional.empty() if no valid identifier can be created.

getIdForComponentAttributesMetadata

Optional<MetadataCacheId> getIdForComponentAttributesMetadata(T component)

Calculates the MetadataCacheId required to identify the MetadataType associated to the attributes of the given component. This method will take into account the values of the configured MetadataKey to provide an unique identifier of the component attributes type definition.

Parameters:

component - the configured component

Returns:

a MetadataCacheId that identifies the component attributes type with all its current configuration or Optional.empty() if no valid identifier can be created.

getIdForComponentInputMetadata

Optional<MetadataCacheId> getIdForComponentInputMetadata(T component,
                                                         String parameterName)

Calculates the MetadataCacheId required to identify the MetadataType associated to the parameter named parameterName of the given component. This method will take into account the values of the configured MetadataKey to provide an unique identifier of the component attributes type definition.

Parameters:

component - the configured component

parameterName - the name of the parameter

Returns:

a MetadataCacheId that identifies the component's parameter type with all its current configuration or Optional.empty() if no valid identifier can be created.

getIdForComponentMetadata

Optional<MetadataCacheId> getIdForComponentMetadata(T component)

Calculates the MetadataCacheId required to identify the MetadataTypes associated to the given component. This method will take into account the values of the configured MetadataKey to provide an unique identifier of the component's type definitions.

Parameters:

component - the configured component

Returns:

a MetadataCacheId that identifies the component Types with all its current configuration or Optional.empty() if no valid identifier can be created for the component.

getIdForMetadataKeys

Optional<MetadataCacheId> getIdForMetadataKeys(T component)

Calculates the MetadataCacheId required to identify the MetadataKeys associated to the given component. This method will ignore the values of the configured MetadataKeys as long as they don't affect the resolution of nested keys.

Parameters:

component - the configured component

Returns:

a MetadataCacheId that identifies the MetadataKeys associated to the component with its current configuration, or Optional.empty() if no valid identifier can be created for the component.

getIdForGlobalMetadata

Optional<MetadataCacheId> getIdForGlobalMetadata(T component)

Calculates the MetadataCacheId required to identify all the Metadata associated to the given component, and its siblings, based on the referenced global element configuration. This method will ignore the values of the configured MetadataKeys as long as they don't affect the resolution of nested keys.

Parameters:

component - the configured component

Returns:

a MetadataCacheId that identifies the global Metadata associated to the component with its current configuration, or Optional.empty() if no valid identifier can be created for the component.