csbase.client.rest.resources.v1

Class ApplicationRestService

java.lang.Object

csbase.client.rest.resources.v1.ApplicationRestService

@Path(value="v1/applications")
public class ApplicationRestService
extends Object

Classe que implementa o endpoint server para aplicações Métodos nesse serviço são exportados a partir da URL base applications; Created by tiago on 10/3/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationRestService.ApplicationResource Classe que representa uma aplicação que pode ser lançada via API Rest do cliente.
static class	ApplicationRestService.MessageResponse Classe que representa respostas Rest para mensagens síncronas enviadas a apliações; Essa classe possui dois campos: o identificador da instância que está respondendo a requisição e a resposta da chamada propriamente dita.
static class	ApplicationRestService.RESTApplicationInstance Classe que representa respostas de erro Rest para mensagens;
static class	ApplicationRestService.RESTError Classe que representa respostas de erro Rest para mensagens;
static class	ApplicationRestService.RunningApplicationResource Classe que representa aplicações em execução no cliente.

Constructor Summary

Constructors

Constructor and Description
ApplicationRestService()

Method Summary

Modifier and Type	Method and Description
List<ApplicationRestService.ApplicationResource>	getApps() Endpoint do método GET da chamada Rest /aplications
List<ApplicationRestService.RunningApplicationResource>	getRunningApps() Endpoint do método GET da chamada Rest /aplications/running
javax.ws.rs.core.Response	killRunningApp(String instanceId, String force) Endpoint do método DELETE da chamada Rest /aplications Mata uma aplicação em execução no cliente.
javax.ws.rs.core.Response	register(String appType, String uri) Endpoint do método POST da chamada Rest /aplications/register Registra uma aplicação externa com um id que pode ser usado no resposta da aplicação.
javax.ws.rs.core.Response	runApp(String appType) Endpoint do método POST da chamada Rest /aplications Executa uma aplicação no cliente
javax.ws.rs.core.Response	sendMessageAsync(String instanceId, String body) Endpoint do método POST da chamada Rest /aplications/{instanceId}/asyncmessage Envia uma mensagem assíncrona à aplicação.
javax.ws.rs.core.Response	sendMessageSync(String instanceId, String body) Endpoint do método POST da chamada Rest /aplications/{instanceId}/message Envia uma mensagem síncrona à aplicação.
javax.ws.rs.core.Response	unregister(String appId) Endpoint do método DELETE da chamada Rest /aplications/{appType}/unregister Registra uma aplicação externa com um id que pode ser usado no resposta da aplicação.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationRestService

public ApplicationRestService()

Method Detail

getApps

@GET
 @Produces(value="application/json")
public List<ApplicationRestService.ApplicationResource> getApps()

Endpoint do método GET da chamada Rest /aplications

Returns:

Uma lista de recursos de aplicações disponíveis no cliente.

getRunningApps

@GET
 @Path(value="/running")
 @Produces(value="application/json")
public List<ApplicationRestService.RunningApplicationResource> getRunningApps()

Endpoint do método GET da chamada Rest /aplications/running

Returns:

Uma lista de recursos de aplicações em execução no cliente.

killRunningApp

@DELETE
 @Path(value="{instanceId}")
public javax.ws.rs.core.Response killRunningApp(@PathParam(value="instanceId")
                                                                                     String instanceId,
                                                                                     @QueryParam(value="force")
                                                                                     String force)

Endpoint do método DELETE da chamada Rest /aplications Mata uma aplicação em execução no cliente.

Parameters:

instanceId - O identificador de instância da aplicação

force - indicativo de desligado forçado.

Returns:

A resposta REST relativa à requisição

runApp

@POST
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="application/json")
public javax.ws.rs.core.Response runApp(@FormParam(value="type")
                                                                                                                                         String appType)

Endpoint do método POST da chamada Rest /aplications Executa uma aplicação no cliente

Parameters:

appType - Tipo da aplicação a ser executada

Returns:

A resposta Rest relativa à requisição cliente contendo o identificador da instância da aplicação executada.

sendMessageSync

@POST
 @Path(value="{instanceId}/syncmessage")
 @Produces(value="application/json")
public javax.ws.rs.core.Response sendMessageSync(@PathParam(value="instanceId")
                                                                                                                                     String instanceId,
                                                                                                                                     String body)

Endpoint do método POST da chamada Rest /aplications/{instanceId}/message Envia uma mensagem síncrona à aplicação. Esse método aguarda a resposta da aplicação.

Parameters:

instanceId - O identificador da instância que irá tratar a mensagem

body - O dado que deverá ser tratado pela aplicação, deve ser um dado com formato JSON

Returns:

A resposta Rest (200 - OK) relativa à mensagem retornada pela instância da aplicação. Contêm o identificador da instância da aplicação e sua resposta em formato JSON, 404 caso a instância não seja válida, 500 caso a aplicação lance uma exceção, ou 400 se a mensagem não estiver no formato JSON.

sendMessageAsync

@POST
 @Path(value="{appid}/asyncmessage")
 @Produces(value="application/json")
public javax.ws.rs.core.Response sendMessageAsync(@PathParam(value="appid")
                                                                                                                                  String instanceId,
                                                                                                                                  String body)

Endpoint do método POST da chamada Rest /aplications/{instanceId}/asyncmessage Envia uma mensagem assíncrona à aplicação. Esse método não aguarda a resposta da aplicação.

Parameters:

instanceId - O identificador da instância que irá tratar a mensagem

body - O dado que deverá ser tratado pela aplicação

Returns:

Status 200 (OK) caso a mensagem tenha sido enviada com sucesso, ou 404 caso a instância não seja válida.

register

@POST
 @Path(value="register")
 @Consumes(value="application/x-www-form-urlencoded")
public javax.ws.rs.core.Response register(@FormParam(value="type")
                                                                                                                               String appType,
                                                                                                                               @FormParam(value="uri")
                                                                                                                               String uri)

Endpoint do método POST da chamada Rest /aplications/register Registra uma aplicação externa com um id que pode ser usado no resposta da aplicação.

Parameters:

appType - O identificador da instância que irá tratar a mensagem

uri - O dado que deverá ser tratado pela aplicação

Returns:

Status 200 (OK) caso a mensagem tenha sido enviada com sucesso, ou 404 caso a instância não seja válida.

unregister

@DELETE
 @Path(value="{appId}/unregister")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response unregister(@PathParam(value="appId")
                                                                                                                      String appId)

Endpoint do método DELETE da chamada Rest /aplications/{appType}/unregister Registra uma aplicação externa com um id que pode ser usado no resposta da aplicação.

Parameters:

appId - O identificador da instância que irá tratar a mensagem

Returns:

Status 200 (OK) caso a mensagem tenha sido enviada com sucesso, ou 404 caso a instância não seja válida.