org.mule.runtime.module.tooling.api.artifact

Interface DeclarationSession

All Known Implementing Classes:

DefaultDeclarationSession, InternalDeclarationSession

@NoImplement
public interface DeclarationSession

It is in charge of resolving connector's operations and retrieving metadata and sample data for all components related to the same session configuration. The session configuration should be defined by multiple global elements, including Configurations, Connections, etc.

This session provides the possibility to avoid having a full artifact configuration before being able to gather metadata from the connector.

Since:

4.4.0

Method Summary

Modifier and Type	Method and Description
void	dispose() Stops and disposes all resources used by this DeclarationSession.
void	disposeMetadataCache(org.mule.runtime.app.declaration.api.ComponentElementDeclaration component) Disposes the MetadataCache associated to the component metadata resolution which is provided in order to store resources cross resolution by resolvers.
org.mule.runtime.api.value.ValueResult	getFieldValues(org.mule.runtime.app.declaration.api.ParameterizedElementDeclaration parameterizedElementDeclaration, String providerName, String targetSelector) Retrieve all Value that can be configured for the field in the given parameter.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer>	getMetadataKeys(org.mule.runtime.app.declaration.api.ComponentElementDeclaration component) Returns the list of keys that can be resolved associated to the specified component.
org.mule.runtime.api.sampledata.SampleDataResult	getSampleData(org.mule.runtime.app.declaration.api.ComponentElementDeclaration component) Retrieves any sample data available for the component.
org.mule.runtime.api.value.ValueResult	getValues(org.mule.runtime.app.declaration.api.ParameterizedElementDeclaration parameterizedElementDeclaration, String providerName) Retrieve all Value that can be configured for the given parameter.
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataTypesDescriptor>	resolveComponentMetadata(org.mule.runtime.app.declaration.api.ComponentElementDeclaration component) Retrieve all the dynamic metadata for the given component.
org.mule.runtime.api.connection.ConnectionValidationResult	testConnection(String configName) Test connectivity for the connection associated to the configuration with the provided name.

Method Detail

testConnection

org.mule.runtime.api.connection.ConnectionValidationResult testConnection(String configName)

Test connectivity for the connection associated to the configuration with the provided name.

Parameters:

configName - The name of the config for which to test connection.

Returns:

a ConnectionValidationResult with the result of the connectivity testing

Throws:

BundleNotFoundException - if any of the dependencies defined for the session could not be resolved

getValues

org.mule.runtime.api.value.ValueResult getValues(org.mule.runtime.app.declaration.api.ParameterizedElementDeclaration parameterizedElementDeclaration,
                                                 String providerName)

Retrieve all Value that can be configured for the given parameter.

Parameters:

parameterizedElementDeclaration - a ParameterizedElementDeclaration for the component from which the available values can be used on the parameter . In case the value provider requires any acting parameters to be able to resolve this values, those parameters should be populated in this declaration. Also, if the Component requires values from a Configuration, then its reference name should be specified in the declaration.

providerName - the name of the value provider for which to resolve the Values

Returns:

a ValueResult with the accepted parameter values to use

Throws:

BundleNotFoundException - if any of the dependencies defined for the session could not be resolved

getFieldValues

org.mule.runtime.api.value.ValueResult getFieldValues(org.mule.runtime.app.declaration.api.ParameterizedElementDeclaration parameterizedElementDeclaration,
                                                      String providerName,
                                                      String targetSelector)

Retrieve all Value that can be configured for the field in the given parameter.

Parameters:

parameterizedElementDeclaration - a ParameterizedElementDeclaration for the component from which the available values can be used on the parameter . In case the value provider requires any acting parameters to be able to resolve this values, those parameters should be populated in this declaration. Also, if the Component requires values from a Configuration, then its reference name should be specified in the declaration.

providerName - the name of the value provider for which to resolve the Values

targetSelector - The path to locate the field within the given parameter

Returns:

a ValueResult with the accepted parameter values to use

Throws:

BundleNotFoundException - if any of the dependencies defined for the session could not be resolved

getMetadataKeys

org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> getMetadataKeys(org.mule.runtime.app.declaration.api.ComponentElementDeclaration component)

Returns the list of keys that can be resolved associated to the specified component.

Parameters:

component - the location of the MetadataKeyProvider component to query for its available keys

Returns:

Successful MetadataResult if the keys are successfully resolved Failure MetadataResult if there is an error while resolving the keys

Throws:

BundleNotFoundException - if any of the dependencies defined for the session could not be resolved

resolveComponentMetadata

org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataTypesDescriptor> resolveComponentMetadata(org.mule.runtime.app.declaration.api.ComponentElementDeclaration component)

Retrieve all the dynamic metadata for the given component. It includes input parameters, output (payload) and output attributes. If a metadata key is needed all parts of the key must be provided.

Parameters:

component - the component whose dynamic metadata types are required

Returns:

a MetadataResult of ComponentMetadataTypesDescriptor containing all the dynamic types

Throws:

BundleNotFoundException - if any of the dependencies defined for the session could not be resolved

disposeMetadataCache

void disposeMetadataCache(org.mule.runtime.app.declaration.api.ComponentElementDeclaration component)

Disposes the MetadataCache associated to the component metadata resolution which is provided in order to store resources cross resolution by resolvers.

Parameters:

component - the component whose has a dynamic metadata types.

getSampleData

org.mule.runtime.api.sampledata.SampleDataResult getSampleData(org.mule.runtime.app.declaration.api.ComponentElementDeclaration component)

Retrieves any sample data available for the component.

Parameters:

component - the component whose sample data is required

Returns:

a SampleDataResult with the sample data message

Throws:

BundleNotFoundException - if any of the dependencies defined for the session could not be resolved

dispose

void dispose()

Stops and disposes all resources used by this DeclarationSession.