org.mule.runtime.module.tooling.internal.config

Class DefaultDeclarationSession

java.lang.Object

org.mule.runtime.module.tooling.internal.AbstractArtifactAgnosticService

org.mule.runtime.module.tooling.internal.config.DefaultDeclarationSession

All Implemented Interfaces:

DeclarationSession

public class DefaultDeclarationSession
extends AbstractArtifactAgnosticService
implements DeclarationSession

Nested Class Summary

Nested classes/interfaces inherited from class org.mule.runtime.module.tooling.internal.AbstractArtifactAgnosticService

AbstractArtifactAgnosticService.ApplicationStartingException

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 component, 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 component, 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.

Methods inherited from class org.mule.runtime.module.tooling.internal.AbstractArtifactAgnosticService

getStartedApplication, withTemporaryApplication

Methods inherited from class java.lang.Object

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

Method Detail

testConnection

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

Description copied from interface: DeclarationSession

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

Specified by:

testConnection in interface DeclarationSession

Parameters:

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

Returns:

a ConnectionValidationResult with the result of the connectivity testing

getValues

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

Description copied from interface: DeclarationSession

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

Specified by:

getValues in interface DeclarationSession

Parameters:

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

getFieldValues

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

Description copied from interface: DeclarationSession

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

Specified by:

getFieldValues in interface DeclarationSession

Parameters:

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

getMetadataKeys

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

Description copied from interface: DeclarationSession

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

Specified by:

getMetadataKeys in interface DeclarationSession

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

resolveComponentMetadata

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

Description copied from interface: DeclarationSession

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.

Specified by:

resolveComponentMetadata in interface DeclarationSession

Parameters:

component - the component whose dynamic metadata types are required

Returns:

a MetadataResult of ComponentMetadataTypesDescriptor containing all the dynamic types

disposeMetadataCache

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

Description copied from interface: DeclarationSession

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

Specified by:

disposeMetadataCache in interface DeclarationSession

Parameters:

component - the component whose has a dynamic metadata types.

getSampleData

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

Description copied from interface: DeclarationSession

Retrieves any sample data available for the component.

Specified by:

getSampleData in interface DeclarationSession

Parameters:

component - the component whose sample data is required

Returns:

a SampleDataResult with the sample data message

dispose

public void dispose()

Description copied from interface: DeclarationSession

Stops and disposes all resources used by this DeclarationSession.

Specified by:

dispose in interface DeclarationSession

Overrides:

dispose in class AbstractArtifactAgnosticService