...
Todos os serviços disponíveis são implementados utilizando o uma adaptatção do padrão de Restful Objects. Esta camada oferece uma forma de comunicação entre as diferentes partes do plugin.
...
O modelo de URI é baseado nas operações HTTP (POST, PUT, DELETE e GET). E tratando-se do padrão Restful Objects a padrão Restful a URI do serviço exposto tem uma estrutura diferente, mantendo, entretanto, sua estrutura base acima citada.
...
Para operações do tipo GET, existem duas maneiras de resgatar objetos através dos serviços rest, A primeira é passando o ID do objeto a ser buscado e a segunda é passando uma condicional para buscar uma lista de um determinado objeto. Estas duas maneiras serão abordadas a seguir:
Passando ID:
URI: http://{host}:{port}/{context}/rest/shield/latest/domain/{object}/{id}
Nesta maneira de buscar objetos no banco, a URI base é concatenada com o identificador único É a maneira simplificada de resgatar objetos através do serviço, onde será retornado um registro único caso o mesmo exista. Assim sendo, a forma de utilizar este serviço é através da URI base concatenando ela com o identificador único (ID) do objeto a ser resgatado. A camada de serviço interpretará a operação requisitada e realizará uma pesquisa utilizando o identificador passado retornando o referido objeto, caso ele exista. Abaixo podemos ver um exemplo:
URI: ~/{id}
No exemplo acima, foi requisitada uma operação do tipo GET para o serviço, passando como parâmetro o Identificador Único "1" e o {object} "company". Ou seja, no exemplo acima a camada de persistência sera acionada e realizará uma busca de uma "Company" com identificador único
| Parâmetro | Descrição |
|---|---|
| company | Este é o objeto representativo do banco de dados. Ou seja, este parâmetro substitui o atributo {object} da URI base da camada de serviço. Neste caso, existe uma classe "Company" que representa uma tabela do banco de dados |
| 1 | É o identificador único (ID) da entidade company no banco de dados. |
Assim sendo, no exemplo acima foi requisitada uma operação do tipo GET para o serviço, tentando buscar uma "company" com ID "1". O retorno desta consulta, como podemos ver, é uma String com os atributos do classe representativa da entidade de banco de dados Company.
Usando condicional:
URI: http://{host}:{port}/{context}/rest/shield/latest/domain/{object}~/actions/find
POST
PUT