es.gob.afirma.transformers.xmlTransformers

Interface IXmlTransformer

All Known Implementing Classes:

CommonXmlTransformer, DSSXmlTransformer

public interface IXmlTransformer

Interface that defines the common methods for the generators of input parameters and output parameters for the web services of @Firma, eVisor and TS@.

Project:

@Firma and TS@ Web Services Integration Platform.

Version:

1.0, 29/12/2014.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessageVersion() Method that obtains the version of the parameter used to configure the generator.
java.lang.String	getMethod() Method that obtains the name of the method to invoke.
java.lang.String	getService() Method that obtains the name of the service used to configure the generator.
java.lang.String	getType() Method that obtains the type of the parameter to generate (input or output).
java.lang.Object	transform(java.lang.Object params) Method that transforms a structure to an input or output parameter of a web service.

Method Detail

getService

java.lang.String getService()

Method that obtains the name of the service used to configure the generator.

Returns:

the name of the service used to configure the generator.

getMethod

java.lang.String getMethod()

Method that obtains the name of the method to invoke.

Returns:

the name of the method to invoke.

getType

java.lang.String getType()

Method that obtains the type of the parameter to generate (input or output). The allowed values are:

• request: For input parameter.
• response: For output parameter.

Returns:

the type of the parameter to generate (request or response).

getMessageVersion

java.lang.String getMessageVersion()

Method that obtains the version of the parameter used to configure the generator.

Returns:

the version of the parameter used to configure the generator.

transform

java.lang.Object transform(java.lang.Object params)
                    throws TransformersException

Method that transforms a structure to an input or output parameter of a web service.

Parameters:

params - Values of the input or output parameters on XML format.

Returns:

a String that represents the input or output parameter on XML format.

Throws:

TransformersException - If the method fails.