Class Index | File Index

Classes


Class Request

Classe utilizada para acessar as informações contidas em uma requisição HTTP.
Esta classe é criada automaticamente pelo sistema quando um ambiente JavaScript está atendendo uma requisição HTTP. Neste caso, é criada a variável global request. Sessões que não tem relação com um atendimento HTTP, como ambientes do Scheduler, não possuem esta variável global.
Defined in: request.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
Cabeçalho HTTP que indica as línguas desejadas pelo requisitante.
 
Corpo da requisição.
 
Dados enviados pelo browser para o servidor.
 
MimeType dos dados enviados pelo browser para o servidor.
 
Quantidade de cookies enviados na requisição.
 
Nome do servidor solicitado pelo usuário.
 
Mensagem HTTP completa.
 
Endereço IP da interface de rede que atendeu a requisição HTTP.
 
Nome associado ao endereço IP da interface de rede que atendeu a requisição HTTP.
 
Porta TCP que atendeu a requisição HTTP.
 
Indica o método HTTP que será sendo invocado.
 
Quantidade de parâmetros enviados na requisição.
 
Retorna um mapa com todos os parâmetros informados na query string da requisição.
 
Arquivo requisitado.
 
Arquivo que originou a requisição.
 
Endereço IP do computador que realizou a requisição HTTP.
 
Nome do computador que realizou a requisição HTTP.
 
Porta TCP utilizada pelo computador remoto para realizar a requisição HTTP.
 
Identificação do aplicativo cliente que fez a requisição HTTP.
 
xml
Representação DOM dos dados enviados pelo browser para o servidor.
Method Summary
Method Attributes Method Name and Description
 
getCookie(indexOrName)
Obtém o valor do cookie informado.
 
Obtém o nome do cookie na posição informada.
 
getHeader(name)
Lê o conteúdo do cabeçalho informado da requisição HTTP.
 
Lê todos os cabeçalhos informados na requisição HTTP.
 
getParameter(indexOrName)
Obtém o valor do parâmetro informado.
 
Obtém o nome do parâmetro informado.
 
Retorna um objeto com todos os parâmetros informados na "query string" da URL da requisição.
 
param(name, opt_default)
Obtém um parâmetro informado na "query string" da URL da requisição.
Class Detail
Request()
Field Detail
acceptLanguage
Cabeçalho HTTP que indica as línguas desejadas pelo requisitante.

body
Corpo da requisição.

content
Dados enviados pelo browser para o servidor.
See:
#contentType
#xml

contentType
MimeType dos dados enviados pelo browser para o servidor.
See:
#content
#xml

cookieCount
Quantidade de cookies enviados na requisição.

host
Nome do servidor solicitado pelo usuário. Caso a URL informada seja "www.bematech.com/index.htm", o host será "www.bematech.com".

httpMessage
Mensagem HTTP completa.

localAddress
Endereço IP da interface de rede que atendeu a requisição HTTP.
See:
#localHost
#localPort
#remoteAddress
#remoteHost
#remotePort

localHost
Nome associado ao endereço IP da interface de rede que atendeu a requisição HTTP.
See:
#localAddress
#localPort
#remoteAddress
#remoteHost
#remotePort

localPort
Porta TCP que atendeu a requisição HTTP.
See:
#localAddress
#localHost
#remoteAddress
#remoteHost
#remotePort

methodType
Indica o método HTTP que será sendo invocado. Poderá ser: GET, POST ou HEAD.

{number} parameterCount
Quantidade de parâmetros enviados na requisição. Parâmetros podem ser enviados no corpo da requisição ou na query string da URL.

params
Retorna um mapa com todos os parâmetros informados na query string da requisição. Para possibilitar a pesquisa, os nomes dos parâmetros serão em minúsculo no mapa retornado. Caso haja o parâmetro definido mais de uma vez, será considerado o último valor informado na URL. Mais detalhes em http://en.wikipedia.org/wiki/Query_string.

path
Arquivo requisitado. Caso a URL informada seja "www.inteq.com.br/index.htm", o path será "/index.htm".

referer
Arquivo que originou a requisição. Exemplo: se o cliente abrir a página /index.htm e nesta for requisitado um segundo documento, o referer deste último será /index.htm.

remoteAddress
Endereço IP do computador que realizou a requisição HTTP.
See:
#remoteHost
#remotePort
#localAddress
#localHost
#localPort

remoteHost
Nome do computador que realizou a requisição HTTP.
See:
#remoteAddress
#remotePort
#localAddress
#localHost
#localPort

remotePort
Porta TCP utilizada pelo computador remoto para realizar a requisição HTTP.
See:
#remoteAddress
#remoteHost
#localAddress
#localHost
#localPort

userAgent
Identificação do aplicativo cliente que fez a requisição HTTP.

xml
Representação DOM dos dados enviados pelo browser para o servidor. Esta propriedade somente estará preenchida quando o tipo dos dados enviados for "text/xml". Para outros tipos, será null.
See:
#content
#contentType
Method Detail
getCookie(indexOrName)
Obtém o valor do cookie informado.
Parameters:
{number|string} indexOrName
Índice ou nome do cookie. O índice é um valor dentro da faixa de 0 a #cookieCount - 1.
See:
#cookieCount

getCookieName(index)
Obtém o nome do cookie na posição informada.
Parameters:
index
Índice ou nome do cookie. O índice é um valor dentro da faixa de 0 a #cookieCount - 1.
See:
#cookieCount

{string} getHeader(name)
Lê o conteúdo do cabeçalho informado da requisição HTTP. Retorna vazio, caso o cabeçalho não tenha sido preenchido pelo cliente.
// Verifica se o navegador aceita a compressão da resposta utilizando o
// algoritmo Gzip
var encodings = request.getHeader("Accept-Encoding")
encodings = encodings.toLowerCase().split(",")
var useGzip = encodings.indexOf("gzip") >= 0
Parameters:
name
Returns:
{string}

{Object} getHeaders()
Lê todos os cabeçalhos informados na requisição HTTP. O resultado será um objeto cujos nomes de propriedades são os nomes dos cabeçalhos e os valores das propriedades são os valores dos cabeçalhos.
// Script que exibe todos os cabeçalhos enviados pelo navegador
var headers = request.getHeaders()
for (var name in headers ){
   response.write( name + ": " + headers[name] + "
") }
Returns:
{Object}

{string} getParameter(indexOrName)
Obtém o valor do parâmetro informado.
Parameters:
{number|string} indexOrName
Índice ou nome do parâmetro. O índice é um valor dentro da faixa de 0 a #parameterCount - 1.
Returns:
{string} Valor do parâmetro.
See:
#parameterCount

getParameterName(index)
Obtém o nome do parâmetro informado.
Parameters:
{number|string} index
Índice do parâmetro. O índice é um valor dentro da faixa de 0 a #parameterCount - 1.
See:
#parameterCount

{Object} getParams()
Retorna um objeto com todos os parâmetros informados na "query string" da URL da requisição. Para possibilitar a pesquisa, os nomes dos parâmetros serão em minúsculo no objeto retornado. Caso haja um parâmetro definido mais de uma vez, será considerado o último valor informado na URL. Mais detalhes em http://en.wikipedia.org/wiki/Query_string.
Returns:
{Object} Objeto com as propriedade e seus valores.

{string} param(name, opt_default)
Obtém um parâmetro informado na "query string" da URL da requisição. Mais detalhes do formato em http://en.wikipedia.org/wiki/Query_string.
Parameters:
{string} name
Nome do parâmetro.
{*} opt_default
Valor padrão a ser utilizado caso o parâmetro não tenha sido informado na URL. Caso não seja informado, será considerado null.
Returns:
{string} Valor do parâmetro informado ou "opt_default" caso não haja o parâmetro informado na "query string" da URL.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Aug 23 2016 16:18:17 GMT-0300 (GFT)