12. Referencia de clases y módulos

12.1. HTTPRequest

A continuación se listan los métodos de la clase HTTPRequest. La lista contiene valores correspondientes a la siguiente petición HTTP de ejemplo:

      GET /foo/bar?key1=value&KEY2=value2 HTTP/1.1
      Host: localhost:8080
      Accept: text/xml, application/xml,application/xhtml+xml,text/html;q=0.9
      Accept: text/plain;q=0.8,image/png,image/jpeg,image/gif;q=0.2,*/*;q=0.1
      Accept-Encoding: gzip,deflate
      Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
      Keep-Alive: 300
      Connection: keep-alive
  

• Línea de arranque

  request_line

  "GET /foo/bar?key1=value&KEY2=value2 HTTP/1.1\r\n"

  request_method

  "GET"

  unparsed_uri

  "/foo/bar?key1=value&KEY2=value2"

  http_version

  "HTTPVersion.new("1.1")". Si en la línea de petición no aparece el protocolo HTTP se considera que es HTTP 0.9

• URI de la petición

  request_uri

  ::URI::parse("http://localhost:8080/foo/bar?key1=value&KEY2=value2")

  host

  "localhost"

  port

  "8080"

  path

  "/foo/bar"

  query_string

  "key1=value&KEY2=value"

  script_name

  "/bar"

  path_info

  "/foo"

• Cabecera y cuerpo

  raw_header

           	 [ "Host: localhost:8080",
  		   "Accept: text/xml, application/xml,application/xhtml+xml,text/html;q=0.9",
  		   "Accept: text/plain;q=0.8,image/png,image/jpeg,image/gif;q=0.2,*/*;q=0.1",
  	 	   "Accept-Encoding: gzip,deflate",
  		   "Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7",
  		   "Keep-Alive: 300",
  		   "Connection: keep-alive" ]
  		

  header

  Hash donde las claves son el nombre de las cabeceras. Los nombres de las cabeceras están en minúsculas. Si existen varias cabeceras con el mismo nombre sus valores se agrupan en un array.

  El resultado de request['ACCEPT'] es request.header['ACCEPT'.downcase].join(", ")

  each

  Ejecuta el bloque que se le pasa para cada par clave/valor del hash de cabeceras (header). e.g.

  req.each{|key, value| puts "#{key}= #{value}"}

  keep_alive

  Toma el valor true si la cabecera "connection" no toma el valor close y la petición utiliza el protocolo HTTP 1.1

  keep_alive?

  Alias de keep_alive

  cookies

  Array que contiene objetos de la clase Cookie, cada uno de los cuales representa una cookie enviada por el usuario. Éstos no se copian automáticamente a un objeto de la clase HTTPResponse.

  query

  {"key1"=>"value1", "KEY2"=>"value2"}. Hash con los parámetros de la petición, la parte del valor son objetos de la clase FormData que es simplemente una subclase de String. Esto sólo es importante en el caso de que se tengan claves duplicadas en los parámetros de la petición.

  body

  Objeto de la clase String con el cuerpo de la petición. Siempre es nil excepto si el método de la petición es POST o PUT.

• Varios.

  user

  Este campo toma valor sólo si se está utilizando autenticación.

  addr

  Dirección local del socket que esta recibiendo las peticiones. e.g. ["AF_INET", 8080, "jfglez", "127.0.0.1"].

  peeraddr

  La dirección del cliente. e.g. ["AF_INET", 37934, "jfglez", "127.0.0.1"].

  attributes

  TODAVÍA NO.

  request_time

  Un objeto de la clase Time con la hora en la que se realizó la petición.

  meta_vars

  Hash con las meta-variables CGI. La especificación del CGI contiene una lista con estas meta-variables.

12.2. HTTPUtils::FormData

La clase FormData deriva de la clase String. Se utiliza para representar los valores de los parámetros de una petición. Una petición puede tener una clave con múltiples valores. Cada valor se asigna a un objeto de la clase FormData. Cada objeto de la clase guarda una referencia al siguiente objeto FormaData que contiene el siguiente valor y así sucesivamente.

12.3. HTTPResponse

Muchos de los métodos de HTTPResponse son llamados por WEBrick después de que el servlet haya dado servicio a la petición. En vez de listar todos los métodos públicos como se hizo para la clase HTTPRequest, a continuación sólo se presentan aquellos que tienen sentido dentro del contexto de los servlets.

12.4. Cookie

12.5. HTTPStatus