Adaptador JavaScript HTTP

Visión general

Mediante los adaptadores HTTP, puede enviar solicitudes GET o POST HTTP y recuperar datos del cuerpo y la cabecera de la respuesta. Los adaptadores HTTP funcionan con servicios basados en SOAP y RESTful, y pueden leer orígenes HTTP estructurados como, por ejemplo, canales de información RSS.

Puede personalizar fácilmente los adaptadores HTTP con código JavaScript simple del lado del servidor. Por ejemplo, podría configurar filtrado del lado del servidor si fuese necesario. El formato de los datos recuperados puede ser XML, HTML, JSON o texto sin formato.

El adaptador se configura con XML para definir sus procedimientos y propiedades.
Opcionalmente, también es posible utilizar XSL para filtrar los campos y registros recibidos.

Requisito previo: Asegúrese de leer primero la guía de aprendizaje Adaptadores JavaScript.

El archivo XML

El archivo XML contiene los valores y metadatos.
Para editar el archivo XML del adaptador, debe:

• Establecer el protocolo en HTTP o HTTPS.
• Establecer el dominio HTTP en la parte de dominio del URL HTTP.
• Establecer el puerto TCP.

Declarar los procedimientos necesarios bajo el elemento connectivity:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<mfp:adapter name="JavaScriptHTTP"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:mfp="http://www.ibm.com/mfp/integration"
	xmlns:http="http://www.ibm.com/mfp/integration/http">

	<displayName>JavaScriptHTTP</displayName>
	<description>JavaScriptHTTP</description>
	<connectivity>
		<connectionPolicy xsi:type="http:HTTPConnectionPolicyType">
			<protocol>https</protocol>
			<domain>mobilefirstplatform.ibmcloud.com</domain>
			<port>443</port>
			<connectionTimeoutInMilliseconds>30000</connectionTimeoutInMilliseconds>
			<socketTimeoutInMilliseconds>30000</socketTimeoutInMilliseconds>
			<maxConcurrentConnectionsPerNode>50</maxConcurrentConnectionsPerNode>
		</connectionPolicy>
	</connectivity>

	<procedure name="getFeed"/>
	<procedure name="getFeedFiltered"/>
</mfp:adapter>

Implementación JavaScript

Para las invocaciones de procedimiento se utiliza un URL de servicio. Algunas partes del URL son fijas, por ejemplo, http://example.com/.
Es posible parametrizar otras partes del URL, esto es, sustituirlas en tiempo de ejecución mediante valores de parámetro que el procedimiento proporciona.

Es posible parametrizar las siguientes partes del URL.

• Elementos de vía de acceso
• Parámetros de serie de consulta
• Fragmentos

Para llamar a una solicitud HTTP, utilice el método MFP.Server.invokeHttp.
Proporcione un objeto de parámetro de entrada, que debe especificar:

• El método HTTP: GET,POST, PUT, DELETE
• El tipo de contenido devuelto: XML, JSON, HTML o plain
• El valor de path de servicio
• Los parámetros de consulta (opcional)
• El cuerpo de la solicitud (opcional)
• El tipo de transformación (opcional)

function getFeed() {
  var input = {
      method : 'get',
      returnedContentType : 'xml',
      path : "feed.xml"
  };


  return MFP.Server.invokeHttp(input);
}

Consulte la Referencia de API para “MFP.Server.invokeHttp” en la documentación del usuario para obtener una lista completa de opciones.

Filtrado de transformación XSL

También puede aplicar una transformación XSL para los datos recibidos, por ejemplo para filtrar los datos.
Para aplicar la transformación XSL, cree un archivo filtered.xsl junto al archivo de implementación JavaScript.

Puede entonces especificar las opciones de transformación en los parámetros de entrada de la invocación del procedimiento. Por ejemplo:

function getFeedFiltered() {

  var input = {
      method : 'get',
      returnedContentType : 'xml',
      path : "feed.xml",
      transformation : {
        type : 'xslFile',
        xslFile : 'filtered.xsl'
      }
  };

  return MFP.Server.invokeHttp(input);
}

Creación de una solicitud de servicio basada en SOAP

Puede utilizar el método de API MFP.Server.invokeHttp para crear un sobre SOAP.
Nota: Para llamar a un servicio basado en SOAP en un adaptador JavaScript HTTP, puede codificar el sobre XML de SOAP dentro del cuerpo de la solicitud utilizando E4X.

var request =
		<soap:Envelope
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:xsd="http://www.w3.org/2001/XMLSchema"
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
			<soap:Body>
				<GetCitiesByCountry xmlns="http://www.webserviceX.NET">
					<CountryName>{countryName}</CountryName>
				</GetCitiesByCountry>
			</soap:Body>
		</soap:Envelope>;

El método MFP.Server.invokeHttp(options) se utiliza entonces para llamar a una solicitud para un servicio SOAP.
El objeto Options debe incluir las siguientes propiedades:

• Una propiedad method: habitualmente POST
• Una propiedad returnedContentType: habitualmente XML
• Una propiedad path: una vía de acceso de servicio
• Una propiedad body: content (XML de SOAP como una serie) y contentType

var input = {
	method: 'post',
	returnedContentType: 'xml',
	path: '/globalweather.asmx',
	body: {
		content: request.toString(),
		contentType: 'text/xml; charset=utf-8'
	}
};

var result = MFP.Server.invokeHttp(input);

Invocación de resultados del servicio basado en SOAP

El resultado se acomoda en un objeto JSON:

{
	"statusCode" : 200,
	"errors" : [],
	"isSuccessful" : true,
	"statusReason" : "OK",
	"Envelope" : {
		"Body" : {
			"GetWeatherResponse" : {
				"xmlns" : "http://www.webserviceX.NET",
				"GetWeatherResult" : "<?xml version=\"1.0\" encoding=\"utf-16\"?>\n<CurrentWeather>\n  <Location>Shanghai / Hongqiao, China (ZSSS) 31-10N 121-26E 3M</Location>\n  <Time>Mar 07, 2016 - 01:30 AM EST / 2016.03.07 0630 UTC</Time>\n  <Wind> from the W (270 degrees) at 4 MPH (4 KT) (direction variable):0</Wind>\n  <Visibility> 4 mile(s):0</Visibility>\n  <Temperature> 69 F (21 C)</Temperature>\n  <DewPoint> 53 F (12 C)</DewPoint>\n  <RelativeHumidity> 56%</RelativeHumidity>\n  <Pressure> 29.94 in. Hg (1014 hPa)</Pressure>\n  <Status>Success</Status>\n</CurrentWeather>"
			}
		},
		"xsd" : "http://www.w3.org/2001/XMLSchema",
		"soap" : "http://schemas.xmlsoap.org/soap/envelope/",
		"xsi" : "http://www.w3.org/2001/XMLSchema-instance"
	},
	"responseHeaders" : {
		"X-AspNet-Version" : "4.0.30319",
		"Date" : "Mon, 07 Mar 2016 06:46:08 GMT",
		"Content-Length" : "1027",
		"Content-Type" : "text/xml; charset=utf-8",
		"Server" : "Microsoft-IIS/7.0",
		"X-Powered-By" : "ASP.NET",
		"Cache-Control" : "private, max-age=0",
		"X-RBT-Optimized-By" : "e8i-wx-sh4 (RiOS 8.6.2d-ibm1) SC"
	},
	"warnings" : [],
	"totalTime" : 654,
	"responseTime" : 651,
	"info" : []
}

Observe que la propiedad Envelope, que es específica de solicitudes basadas en SOAP.
La propiedad Envelope contiene el contenido resultante de la solicitud basada en SOAP.

Para acceder al contenido XML:

• En el lado del cliente, se puede utilizar jQuery para acomodar la serie resultante, y seguir los nodos del DOM:

var resourceRequest = new WLResourceRequest(
    "/adapters/JavaScriptSOAP/getWeatherInfo",
    WLResourceRequest.GET
);

resourceRequest.setQueryParameter("params", "['Washington', 'United States']");

resourceRequest.send().then(
    function(response) {
        var $result = $(response.invocationResult.Envelope.Body.GetWeatherResponse.GetWeatherResult);
		var weatherInfo = {
			location: $result.find('Location').text(),
			time: $result.find('Time').text(),
			wind: $result.find('Wind').text(),
			temperature: $result.find('Temperature').text(),
		};
    },
    function() {
        // ...
    }
)

• En el lado del servidor, se crea un objeto XML con la serie resultante. Se puede acceder entonces a los nodos como propiedades:

var xmlDoc = new XML(result.Envelope.Body.GetWeatherResponse.GetWeatherResult);
var weatherInfo = {
	Location: xmlDoc.Location.toString(),
	Time: xmlDoc.Time.toString(),
	Wind: xmlDoc.Wind.toString(),
	Temperature: xmlDoc.Temperature.toString()
};

Adaptador de ejemplo

Pulse para descargar el proyecto Maven Adapters.

Uso de ejemplo

• Utilice Maven, MobileFirst CLI o el IDE de su elección para compilar y desplegar el adaptador JavaScriptHTTP.
• Para probar o depurar un adaptador, consulte la guía de aprendizaje Pruebas y depuración de adaptadores.