es.gob.afirma.transformers.xmlTransformers

Class CommonXmlTransformer

java.lang.Object

es.gob.afirma.transformers.xmlTransformers.CommonXmlTransformer

All Implemented Interfaces:

IXmlTransformer

public class CommonXmlTransformer
extends java.lang.Object
implements IXmlTransformer

Class that transforms input parameters to a XML request for the native web services of @Firma.

Project:

Library for the integration with the services of @Firma, eVisor and TS@.

Version:

1.1, 18/04/2022.

Constructor Summary

Constructors

Constructor and Description
CommonXmlTransformer() Constructor method for the class CommonXmlTransformer.java.
CommonXmlTransformer(java.lang.String svc, java.lang.String methodParam, java.lang.String typ, java.lang.String msgVersion) Constructor method for the class CommonXmlTransformer.java.

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).
void	setMessageVersion(java.lang.String msgVersion) Sets the value of the attribute messageVersion.
void	setService(java.lang.String svc) Sets the value of the attribute service.
void	setType(java.lang.String typ) Sets the value of the attribute type.
java.lang.Object	transform(java.lang.Object params) Method that transforms a structure to an input or output parameter of a web service.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonXmlTransformer

public CommonXmlTransformer()

Constructor method for the class CommonXmlTransformer.java.

CommonXmlTransformer

public CommonXmlTransformer(java.lang.String svc,
                            java.lang.String methodParam,
                            java.lang.String typ,
                            java.lang.String msgVersion)

Constructor method for the class CommonXmlTransformer.java.

Parameters:

svc - Parameter that represents the native service name.

methodParam - Parameter that represents the method of web service.

typ - Parameter that represents the type.

msgVersion - Parameter that represents the message version.

Method Detail

getService

public final java.lang.String getService()

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

Specified by:

getService in interface IXmlTransformer

Returns:

the name of the service used to configure the generator.

See Also:

IXmlTransformer.getService()

getType

public final 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.

Specified by:

getType in interface IXmlTransformer

Returns:

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

See Also:

IXmlTransformer.getType()

getMessageVersion

public final java.lang.String getMessageVersion()

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

Specified by:

getMessageVersion in interface IXmlTransformer

Returns:

the version of the parameter used to configure the generator.

See Also:

IXmlTransformer.getMessageVersion()

transform

public final 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.

Specified by:

transform in interface IXmlTransformer

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.

See Also:

IXmlTransformer.transform(java.lang.Object)

setMessageVersion

public final void setMessageVersion(java.lang.String msgVersion)

Sets the value of the attribute messageVersion.

Parameters:

msgVersion - The value for the attribute messageVersion.

setService

public final void setService(java.lang.String svc)

Sets the value of the attribute service.

Parameters:

svc - The value for the attribute service.

setType

public final void setType(java.lang.String typ)

Sets the value of the attribute type.

Parameters:

typ - The value for the attribute type.

getMethod

public final java.lang.String getMethod()

Method that obtains the name of the method to invoke.

Specified by:

getMethod in interface IXmlTransformer

Returns:

the name of the method to invoke.

See Also:

IXmlTransformer.getMethod()