Class Index | File Index

Classes


Class ngin.router.Broker


Defined in: broker.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Classe responsável por tratar as requisições HTTP, avaliar as rotas definidas e executar o controlador responsável por tratar a requisição, caso haja um.
Field Summary
Field Attributes Field Name and Description
<static>  
ngin.router.Broker.ROUTE_NOT_FOUND_STATUS
Status HTTP retornado pelo Engine quando ele não possui uma rota para atender a requisição.
Method Summary
Method Attributes Method Name and Description
 
authorizeUser(request)
Autoriza a sessão com as credenciais enviadas pelo usuário.
 
Limpa todas as definições do broker, sendo necessário utilizar o método loadRoutesFromDirectory, para recarregar as definições de rota, antes de utilizar o broker novamente.
 
Solicita ao Engine que a sessão seja descartada na próxima execução a fim de limpar o cache de includes.
 
Verifica se houveram alterações nas definições de rota tanto na VFS quanto na UFS.
<static>  
ngin.router.Broker.getInstance()
Retorna uma instância única do Broker para todas as execuções.
 
Retorna a versão da vfs, ou o timestamp da ufs da controladora indicada em 'path'.
 
handleRequest(request, response)
Trata uma requisição HTTP executando a ação no controlador indicado nas rotas HTTP.
 
Verifica se houve alguma modificação na estrutura de rotas ou em algum arquivo JAZ, tanto na VirtualFileSystem quanto na UnionFileSystem.
 
Carrega todos as configurações de rotas do diretório informado.
 
Executa todos os scripts configurados em "/Configuração/Inicialização do Gerenciador de Classes".
 
validAcceptHeader(result, request)
Realiza a validação do Accept da requisição HTTP com o ContentType do Response
Class Detail
ngin.router.Broker()
Classe responsável por tratar as requisições HTTP, avaliar as rotas definidas e executar o controlador responsável por tratar a requisição, caso haja um.
Field Detail
<static> ngin.router.Broker.ROUTE_NOT_FOUND_STATUS
Status HTTP retornado pelo Engine quando ele não possui uma rota para atender a requisição. Utilizado o código o 418 (I'm a teapot) para indicar que o Engine não deseja tratar a requisição, visto que este é um código reservado que jamais poderia ser utilizado em uma resposta de um controlador associado a rota.
Method Detail
authorizeUser(request)
Autoriza a sessão com as credenciais enviadas pelo usuário.
Parameters:
{Request} request
Requisição com os credenciais do usuário.

clear()
Limpa todas as definições do broker, sendo necessário utilizar o método loadRoutesFromDirectory, para recarregar as definições de rota, antes de utilizar o broker novamente.

clearIncludeCaches()
Solicita ao Engine que a sessão seja descartada na próxima execução a fim de limpar o cache de includes. A limpeza da sessão é um workaround enquanto o Engine não implementa o descarte correto do cache de scripts ou possibilite a gestão do cache.

{number} getDefinitionsVersion_()
Verifica se houveram alterações nas definições de rota tanto na VFS quanto na UFS. Utilizado para indicar para o broker, quando será necessário descartar as definições e carrega-las novamente.
Returns:
{number}

<static> {ngin.router.Broker} ngin.router.Broker.getInstance()
Retorna uma instância única do Broker para todas as execuções.
Returns:
{ngin.router.Broker}

getModuleVersion_(path)
Retorna a versão da vfs, ou o timestamp da ufs da controladora indicada em 'path'. Utilizada para validar se uma controladora se encontra desatualizada.
Parameters:
path
Caminho da controladora que se deseja obter a versão.

handleRequest(request, response)
Trata uma requisição HTTP executando a ação no controlador indicado nas rotas HTTP.
Parameters:
{Request} request
{Response} response

{boolean} hasOutdatedDefinitions()
Verifica se houve alguma modificação na estrutura de rotas ou em algum arquivo JAZ, tanto na VirtualFileSystem quanto na UnionFileSystem.
Returns:
{boolean}

{boolean} loadRoutesFromDirectory(directory)
Carrega todos as configurações de rotas do diretório informado.
Parameters:
{number} directory
Diretório da VFS onde estão as configurações das rotas HTTP.
Returns:
{boolean} True se todas as rotas foram carregadas com sucesso.

runStartupScripts()
Executa todos os scripts configurados em "/Configuração/Inicialização do Gerenciador de Classes".

{ngin.router.Result} validAcceptHeader(result, request)
Realiza a validação do Accept da requisição HTTP com o ContentType do Response
Parameters:
{ngin.router.Result} result
Resultado de um controlador para uma requisição HTTP.
{Request} request
Requisição HTTP.
Returns:
{ngin.router.Result} Retorna o resultado informado caso o tipo de mídia seja suportado ou um novo resultado com o status NOT_ACCEPTABLE caso contrário.

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