org.mule.tooling.client.api.artifact.declaration

Interface ArtifactSerializationService

public interface ArtifactSerializationService

Service for serialization and deserialization of an ArtifactDeclaration.

Supported serialization formats are JSON and XML

Since:

1.0

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.app.declaration.api.ArtifactDeclaration	fromJson(JsonArtifactDeserializationRequest request) Creates an ArtifactDeclaration from a given mule artifact JSON representation.
org.mule.runtime.app.declaration.api.ArtifactDeclaration	fromXml(XmlArtifactDeserializationRequest request) Creates an ArtifactDeclaration from a given mule artifact XML configuration file.
String	toJson(JsonArtifactSerializationRequest request) Serializes an ArtifactDeclaration into an XML Document
String	toXml(XmlArtifactSerializationRequest request) Serializes an ArtifactDeclaration into an XML Document

Method Detail

toXml

String toXml(XmlArtifactSerializationRequest request)
      throws ArtifactSerializationException

Serializes an ArtifactDeclaration into an XML Document

Parameters:

request - the XmlArtifactDeserializationRequest that contains the ArtifactDeclaration and all the required configuration for the serialization.

Returns:

an XML representation of the ArtifactDeclaration

Throws:

ArtifactSerializationException

fromXml

org.mule.runtime.app.declaration.api.ArtifactDeclaration fromXml(XmlArtifactDeserializationRequest request)
                                                          throws ArtifactSerializationException

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

Parameters:

request - the XmlArtifactDeserializationRequest that contains the artifact source and all the required configuration for the deserialization.

Returns:

an ArtifactDeclaration that represents the given mule configuration.

Throws:

ArtifactSerializationException

toJson

String toJson(JsonArtifactSerializationRequest request)
       throws ArtifactSerializationException

Serializes an ArtifactDeclaration into an XML Document

Parameters:

request - the XmlArtifactDeserializationRequest that contains the ArtifactDeclaration and all the required configuration for the serialization.

Returns:

an XML representation of the ArtifactDeclaration

Throws:

ArtifactSerializationException

fromJson

org.mule.runtime.app.declaration.api.ArtifactDeclaration fromJson(JsonArtifactDeserializationRequest request)
                                                           throws ArtifactSerializationException

Creates an ArtifactDeclaration from a given mule artifact JSON representation.

Parameters:

request - the XmlArtifactDeserializationRequest that contains the artifact source and all the required configuration for the deserialization.

Returns:

an ArtifactDeclaration that represents the given mule configuration.

Throws:

ArtifactSerializationException