Class: Broker

@nginstack/engine/lib/router/Broker~ Broker


new 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.

Methods


<static> getInstance()

Retorna uma instância única do Broker para todas as execuções.

Returns:
Type
Broker

<static> runStartupScripts()

Executa todos os scripts configurados em "/Configuração/Inicialização do Gerenciador de Classes". Essa execução é disparada automaticamente na construção de uma instância de Broker.


authorizeUser(request)

Autoriza a sessão com as credenciais enviadas pelo usuário.

Parameters:
Name Type Description
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.


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:
Name Type Description
path

Caminho da controladora que se deseja obter a versão.


handleRequest(route, pathParameters [, opt_options])

Trata uma requisição HTTP executando a ação no controlador indicado nas rotas HTTP.

Parameters:
Name Type Argument Description
route Object

Rota que deverá ser tratada.

Properties
Name Type Description
path string

Caminho declarado na rota.

controller string

Controladora a ser executada.

action string

Ação da controladora a ser executada.

requiresAuth boolean

Indica se a ação da controladora requer a autenticação de um usuário.

allowedOrigins Array.<string>

Indica quais a origens permitidas para essa rota.

realm string

Nome do realm associado à rota.

debug boolean

Indica que devem ser geradas informações de depuração deste atendimento.

pathParameters Object.<{value: string, kind: string}>

Mapa contendo os parâmetros extraídos da URL. A chave do mapa será o nome do parâmetro.

opt_options Object <optional>

Opções.

Properties
Name Type Argument Description
request Request <optional>

Requisição a ser tratada.

response Response <optional>

Objeto de resposta que será preenchido com o resultado da ação.


runStartupScripts()

Executa todos os scripts configurados em "/Configuração/Inicialização do Gerenciador de Classes". Essa execução é disparada automaticamente pelo sistema.


validAcceptHeader(result, request)

Realiza a validação do Accept da requisição HTTP com o ContentType do Response

Parameters:
Name Type Description
result RouteResult

Resultado de um controlador para uma requisição HTTP.

request Request

Requisição HTTP.

Returns:

Retorna o resultado informado caso o tipo de mídia seja suportado ou um novo resultado com o status NOT_ACCEPTABLE caso contrário.

Type
RouteResult