org.mule.runtime.metadata.internal.cache

Class DslElementBasedMetadataCacheIdGenerator

java.lang.Object

org.mule.runtime.metadata.internal.cache.DslElementBasedMetadataCacheIdGenerator

All Implemented Interfaces:

MetadataCacheIdGenerator<DslElementModel<?>>

public class DslElementBasedMetadataCacheIdGenerator
extends Object
implements MetadataCacheIdGenerator<DslElementModel<?>>

A DslElementModel based implementation of a MetadataCacheIdGenerator

Since:

4.1.4, 4.2.0

Constructor Summary

Constructors

Constructor and Description
DslElementBasedMetadataCacheIdGenerator(ComponentLocator<DslElementModel<?>> locator)

Method Summary

Modifier and Type	Method and Description
Optional<MetadataCacheId>	getIdForComponentAttributesMetadata(DslElementModel<?> component) Calculates the MetadataCacheId required to identify the MetadataType associated to the attributes of the given component.
Optional<MetadataCacheId>	getIdForComponentInputMetadata(DslElementModel<?> component, String parameterName) Calculates the MetadataCacheId required to identify the MetadataType associated to the parameter named parameterName of the given component.
Optional<MetadataCacheId>	getIdForComponentMetadata(DslElementModel<?> elementModel) Calculates the MetadataCacheId required to identify the MetadataTypes associated to the given component.
Optional<MetadataCacheId>	getIdForComponentOutputMetadata(DslElementModel<?> component) Calculates the MetadataCacheId required to identify the MetadataType associated to the output of the given component.
Optional<MetadataCacheId>	getIdForGlobalMetadata(DslElementModel<?> elementModel) 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(DslElementModel<?> elementModel) Calculates the MetadataCacheId required to identify the MetadataKeys associated to the given component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DslElementBasedMetadataCacheIdGenerator

public DslElementBasedMetadataCacheIdGenerator(ComponentLocator<DslElementModel<?>> locator)

Method Detail

getIdForComponentOutputMetadata

public Optional<MetadataCacheId> getIdForComponentOutputMetadata(DslElementModel<?> 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.

Specified by:

getIdForComponentOutputMetadata in interface MetadataCacheIdGenerator<DslElementModel<?>>

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

public Optional<MetadataCacheId> getIdForComponentAttributesMetadata(DslElementModel<?> 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.

Specified by:

getIdForComponentAttributesMetadata in interface MetadataCacheIdGenerator<DslElementModel<?>>

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

public Optional<MetadataCacheId> getIdForComponentInputMetadata(DslElementModel<?> 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.

Specified by:

getIdForComponentInputMetadata in interface MetadataCacheIdGenerator<DslElementModel<?>>

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

public Optional<MetadataCacheId> getIdForComponentMetadata(DslElementModel<?> elementModel)

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.

Specified by:

getIdForComponentMetadata in interface MetadataCacheIdGenerator<DslElementModel<?>>

Parameters:

elementModel - 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

public Optional<MetadataCacheId> getIdForMetadataKeys(DslElementModel<?> elementModel)

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.

Specified by:

getIdForMetadataKeys in interface MetadataCacheIdGenerator<DslElementModel<?>>

Parameters:

elementModel - 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

public Optional<MetadataCacheId> getIdForGlobalMetadata(DslElementModel<?> elementModel)

Description copied from interface: MetadataCacheIdGenerator

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.

Specified by:

getIdForGlobalMetadata in interface MetadataCacheIdGenerator<DslElementModel<?>>

Parameters:

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