Histórico da Página

Através da função de callback onBlock, o usuário/desenvolvedor pode definir quais serviços REST (

endpoints + método) serão bloqueados para uso ou somente ocultados na listagem de serviços disponíveis.

Esse recurso é útil quando queremos manter disponíveis somente alguns serviços REST para determinado ambiente.

Parâmetro Recebido

A função customizada recebe somente 1 (um) parâmetro, sendo:

1 - oList

Classe contendo valores da execução e métodos para informar que determinado

endpoint +

método deve ser bloqueado ou oculto.

oList:block( cEndpoint, cMethod )

oList:hide( cEndpoint, cMethod )

[HTTPSERVER]
Servers=SERVIDOR_REST_01

[HTTPSERVER]
Servers=SERVIDOR_REST_01
 
[HTTP_DBMONITOR]
port=8080

[HTTPSERVER]
Servers=SERVIDOR_REST_01
 
[SERVIDOR_REST_01]
port=8080
locations=LOC_SRV_01

[LOC_SRV_01]
ThreadPool=THREAD_POOL_SRV_01

[HTTPSERVER]
Servers=SERVIDOR_REST_01
 
[HTTP_DBMONITOR]
userData={"sua_chave":"seu_valor"}

Responsável por adicionar um Endpoint e Método que será bloqueado no ambiente REST.

oList:hide( cEndpoint as character, cMethod as character )

Responsável por adicionar um Endpoint e Método que será somente ocultado no ambiente REST, ou seja, ele não aparece em nenhuma listagem de serviços disponíveis, porém, quem conhecer a sua assinatura poderá acessá-lo.

Retorno

Não há utilidade para retorno algum pois é ignorado, portanto sugerimos que o retorno seja NULL.

Exemplo

TlppData={"OnBlockGetApiList":true}

jTP_TlppData := {"OnBlockGetApiList":true}
jREST['ThreadPool']['TlppData'] := jTP_TlppData

{
    "required": false,
    "success": false,
    "annotation": [],
    "json": []
}

{
    "required": true,
    "success": true,
    "annotation": [
        { "/exemplo1/annotation": ["GET","POST","PUT"] },
        { "/exemplo2/annotation": ["GET"] }
    ],
    "json": [
        { "/exemplo1/loadurn": ["GET"] }
    ]
}

Retorno

Sugerimos que o retorno seja NULL pois todo e qualquer retorno será ignorado.

Exemplo

function U_onBlock( 

oList )

  local cEndpoint as character
  local cServiceName as character
  local nServicePort as numeric
  local cThreadPoolName as character
  local cUserData as character
  local jApis as json

  // Use os valores abaixo conforme sua necessidade de implementação
  // Embora você sempre receberá tais valores, seu uso é opcional.
  
  cServiceName    := 

oList:getServiceName()
  nServicePort    := 

oList:getServicePort()
  cThreadPoolName := 

oList:getThreadPoolName()
  cUserData       := 

oList:getUserData()
  jApis           := oList:getApiList() 


  // Para bloquear ou ocultar algum serviço, utilize os métodos Sets

  cEndpoint := '/exemplo1/urn'
    

oList:block( cEndpoint, 'get'  )
    

oList:block( cEndpoint, 'post' )
    

oList:hide(  cEndpoint, 'put'  )

  cEndpoint := '/exemplo2/urn'
    

oList:block( cEndpoint, 'get' )

return

Conclusão

É muito simples bloquear/ocultar um serviço REST, basta utilizar um dos métodos mencionados acima indicando a ação (block | hide)

, o

endpoint e seu método.

Note que sempre é preciso informar o

endpoint e

método para cada ação

; sendo assim, poderemos bloquear todos os métodos de um mesmo

endpoint ou somente alguns, conforme necessidade.