XMLHttpRequest es un objeto Javascript que incorpora la misma funcionalidad que el objeto originalmente desarrollado por Microsoft. Nos da una forma sencilla de obtener datos de una url. Aunque el nombre pueda despistar, XMLHttpRequest puede ser usado para obtener cualquier tipo de dato, no sólo XML.

Requiere importarla previamente a su uso:

importClass ( "XMLHttpRequest" );

Para el acceso mediante proxy, esta clase accederá a Internet con la configuración Proxy del sistema.

También podremos establecer una configuración diferente en caso de que lo necesitemos. En este caso, debemos configurar en el registro correspondiente a la rama del cliente una rama proxy, con los siguientes valores de cadena:

enabled: true para habilitar, false para deshabilitar la configuraicón.

hostName: Dominio o ip del proxy.

port: Puerto del proxy.

userName: Usuario del proxy.

password: Contraseña del proxy.

type: 0 = socket5, 1 = http

En Windows, por ejemplo en:

HKEY_CURRENT_USER\Software\Velneo\vClient\proxy

En Linux en:

/home/usuario/.config/Velneo/vClient.conf

En Mac en:

~/Library/Preferences/com.velneo.vclient.plist

Indice de funciones

Constructor

Generales

Auxiliares

Señales

onreadystatechange

ontimeout

Enumeraciones

Modos de validación de certificado

VerifyNone: no solicitará un certificado al peer. Puede establecer este modo si no estás interesado en la identidad del otro lado de la conexión. La conexión seguirá estando encriptada, y tu socket seguirá enviando su certificado local al peer si es solicitado.

QueryPeer: solicitará un certificado al peer, pero no requiere que este certificado sea válido. Esto es útil cuando se quieren mostrar los detalles del certificado del par al usuario sin afectar al handshake SSL real. Este modo es el predeterminado para los servidores. Nota: En Schannel este valor actúa igual que VerifyNone.

VerifyPeer: solicitará un certificado al peer durante la fase de handshake SSL, y requiere que este certificado sea válido. Si falla, emitirá la señal de error de SSL. Este modo es el predeterminado para los clientes.

AutoVerifyPeer: es el modo por defecto. Utilizará automáticamente QueryPeer para los sockets del servidor y VerifyPeer para los sockets del cliente.

Documentación de propiedades

errorCode

Retorna un entero indicando el error que se ha producido.

0 = No se ha producido ningún error.

1 = El servidor remoto rechazó la conexión (el servidor no está aceptando peticiones).

2 = El servidor remoto ha cerrado la conexión, antes de que la petición fuera recibida y procesada.

3 = El nombre del host remoto no se ha encontrado (hostname inválido).

4 = Ha expirado el tiempo máximo de conexión al servidor remoto (timeout).

5 = La operación se ha cancelado por una llamada a abort() o close() antes de que acabara.

6 = La comunicación SSL/TLS ha fallado y la comunicación encriptada no se puede establecer.

7 = La conexión fue interrumpida debido a una desconexión de la red, sin embargo el sistema se ha iniciado.

201 = El acceso al contenido remoto fue denegado (similar al error HTTP 401).

202 = La operación solicitada sobre el contenido remoto no está permitida.

203 = El contenido remoto no fue encontrado en el servidor (similar al error HTTP 404).

204 = El servidor remoto solicita autenticación para servir el contenido, pero las credenciales suministras no son correctas.

301 = No se puede procesar la petición porque el protocolo es desconocido.

302 = La operación solicitada es inválida para este protocolo.

99 = Un error desconocido relacionado con la red ha sido detectado.

299 = Un error desconocido relacionado con el contenido remoto ha sido detectado.

399 = Un error ha sido detectado en el protocolo (error de parseo, respuesta inválida o no esperada, etc).

readyState

Retorna un entero indicando el estado de la petición.

0 = UNSENT Todavía no se ha llamado a open().

1 = OPENED send() ha sido llamada.

2 = HEADERS_RECEIVED send() ha sido llamada, y tanto las cabeceras como el estado están disponibles.

3 = LOADING Descargando. La propiedad responseText contiene datos parciales

4 = DONE La operación se ha completado.

response

Retorna un arraybuffer, un objeto Javascript o una cadena, dependiendo del valor de responseType.

Contiene el cuerpo completo de la respuesta. Es nulo si la petición no pudo completarse o es incompleta.

responseText

Retorna una cadena conteniendo la cadena de respuesta retornada por el servidor HTTP.

A diferencia de la propiedad status, esta incluye el texto completo del mensaje de respuesta (por ejemplo "200 OK")

responseType

Puede retornar uno de los siguientes valores:

"" String (Valor por defecto)

"json" Objeto javascript, parseado desde una cadena JSON retornada por el servidor.

status

Retorna el estado de la respuesta de la petición.

Esto es el código del resultado HTTP (por ejemplo, retorna 200 para una petición correcta)

statusText

Devuelve la cadena de respuesta. A diferencia de status, incluye el texto completo del mensaje de respuesta.

timeout

Representa el número de milisegundos que una petición puede tomar antes de ser automáticamente terminada.

Si no se especifica ningún valor, se define como valor por defecto 30 minutos.

Documentación de funciones

Constructor

XMLHttpRequest XMLHttpRequest()

Requiere importar previamente la clase:

importClass ( "XMLHttpRequest" );

Funciones generales

void abort()

Aborta la petición si ya ha sido enviada.

String getAllResponseHeaders()

Retorna todas las cabeceras de respuesta como una cadena, o vacío si no se han recibido.

String getResponseHeader( String name )

Retorna una cadena conteniendo el texto de la cabecera indicada en name, o vacío tanto si la respuesta no ha sido recibida o si la cabecera indicada no existe en la respuesta.

Parámetros:

• name: Nombre de la cabecera.

void open( String method, String url, bool async = true, String username = "", String password = "" )

Inicia una petición

Parámetros:

• method: El método HTTP a usar, tal como GET, POST, etc.

• url: La url a la que se envía la petición.

• async: Un valor booleano opcional, por defecto true, que indica si realizar o no la operación de forma asíncrona. Si este valor es falso, la función send() no retorna hasta que la respuesta es recibida. Si el valor es true, la notificación de que la transacción se ha completado se sabe usando la propiedad readyState (en este caso hay que mantener el proceso javascript abierto "entreteniendolo". Mirar ejemplo).

• user: Valor opcional pasa usar en la autenticación. Por defecto es una cadena vacía. Usa el método de autenticación basado en URL.

• password: Valor opcional pasa usar en la autenticación. Por defecto es una cadena vacía. Usa el método de autenticación basado en URL.

void send( String data )

Envía la petición. Si la petición es síncrona, no retorna hasta que llega la respuesta.

Parámetros:

• data: cadena con los datos que son enviados con la petición. Es convertida a UTF8 antes del envio.

void send( VByteArray data )

Envía la petición. Si la petición es síncrona, no retorna hasta que llega la respuesta.

Parámetros:

void send()

Envía la petición.

Si la petición es síncrona, no retorna hasta que llega la respuesta. Si la petición es asíncrona, esta función retorna inmediatamente y hay que "entretener" al proceso javascript que la ha llamado hasta que llegue la respuesta (ver ejemplo).

void setRequestHeader( String name, String value )

Establece el valor de la cabecera en una petición HTTP. Se debe llamar a setRequestHeader() después de open() pero antes de send().

Parámetros:

• name: Cadena con el nombre de la cabecera.

• value: Valor de la cabecera.

bool setClientCertificate( String certificado, String key[, String password] )

Establece el certificado del cliente previamente a la llamada. Parámetros:

• certificado: cadena en formato PEM que contiene el certificado.

• key: cadena que contiene la llave privada.

• password (opcional): cadena que contiene la contraseña de la llave.

Esta función es funcional en Windows y en Linux pero no en Mac OS, dado que, al contrario que en Windows y Linux que usan Open SSL, Mac usa un sistema propio llamado Secure Transport SSL, y esta función del API no es funcional con dicho sistema.

bool setClientCertificate( VSSLCertificate sslCVSSLCertificate sslCertificate )

Retorna si ha conseguido establecer el certificado correctamente(1) o no (0).

Parámetros:

Esta

void setPeerVerifyMode( mode )

Establece el modo de verificación del socket. Este modo decide si debe solicitar un certificado al par (es decir, el cliente solicita un certificado al servidor, o el servidor solicita un certificado al cliente), y si debe exigir que este certificado sea válido.

El modo por defecto es AutoVerifyPeer, que indica que utilice VerifyPeer para los clientes y QueryPeer para los servidores.

Establecer este modo después de que la encriptación haya comenzado no tiene ningún efecto en la conexión actual.

Parámetros:

Ejemplo:

Funciones auxiliares

void processEvents()

Procesa los eventos que haya en la cola de la aplicación. Debe usarse cuando realicemos una conexión asíncrona para permitir el proceso de los eventos durante el tiempo que dure.

void waitForRequestComplete()

Espera a que la petición se haya procesado. Hay que usar esta función obligatoriamente cuando se realice la petición desde tercer o cuarto plano (ver ejemplos).

Ejemplos

Obtener contenido de url de forma síncrona

Obtener contenido de url de forma asíncrona

Obtener contenido de url de forma asíncrona a través de proxy

Obtener una imagen y convertirla a Base64 para guardarla en una tabla

Petición incorrecta: obtener contenido de statusText

Petición POST enviando un JSON y obteniendo un JSON

Petición POST enviando un fichero XML con firma de certificado de cliente

Petición con autenticación usando el método BASIC