org.mule.runtime.config.api.dsl

Interface ArtifactDeclarationXmlSerializer

@NoImplement
public interface ArtifactDeclarationXmlSerializer

Serializer that can convert an ArtifactDeclaration into a readable and processable XML representation and from a mule XML configuration file into an ArtifactDeclaration representation.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
ArtifactDeclaration	deserialize(InputStream configResource) Creates an ArtifactDeclaration from a given mule artifact XML configuration file.
ArtifactDeclaration	deserialize(String name, InputStream configResource) Creates an ArtifactDeclaration from a given mule artifact XML configuration file.
static ArtifactDeclarationXmlSerializer	getDefault(DslResolvingContext context) Provides an instance of the default implementation of the ArtifactDeclarationXmlSerializer.
String	serialize(ArtifactDeclaration declaration) Serializes an ArtifactDeclaration into an XML Document

Method Detail

getDefault

static ArtifactDeclarationXmlSerializer getDefault(DslResolvingContext context)

Provides an instance of the default implementation of the ArtifactDeclarationXmlSerializer.

Parameters:

context - a DslResolvingContext that provides access to all the extensions required for loading a given artifact config to an ArtifactDeclaration

Returns:

an instance of the default implementation of the ArtifactDeclarationXmlSerializer

serialize

String serialize(ArtifactDeclaration declaration)

Serializes an ArtifactDeclaration into an XML Document

Parameters:

declaration - ArtifactDeclaration to be serialized

Returns:

an XML representation of the ArtifactDeclaration

deserialize

ArtifactDeclaration deserialize(InputStream configResource)

Creates an ArtifactDeclaration from a given mule artifact XML configuration file.

Parameters:

configResource - the input stream with the XML configuration content.

Returns:

an ArtifactDeclaration that represents the given mule configuration.

deserialize

ArtifactDeclaration deserialize(String name,
                                InputStream configResource)

Creates an ArtifactDeclaration from a given mule artifact XML configuration file.

Parameters:

name - name of the file to display a better error messages (if there are any).

configResource - the input stream with the XML configuration content.

Returns:

an ArtifactDeclaration that represents the given mule configuration.