Execução de web service
Os web services podem ser executados a partir de regras LSP, aplicação de terceiros ou depuração. Cada um desses formatos pode possuir suas próprias configurações e características.
Tipos de execução
Há quatro tipos possíveis de execução: Local, Síncrono, Assíncrono e Agendado. Nos tipos síncrono, assíncrono e agendado, o ambiente em que o sistema Senior está instalado deve possuir o Middleware. Apenas no tipo local isso não é necessário.
Local
Modo utilizado apenas para realizar testes e no caso de web services customizados, para depuração de regras LSP.
O processamento da requisição irá ocorrer na mesma instância do aplicativo, diretamente dentro do Sistema e o processamento ocorre no mesmo momento da chamada.
Parâmetros para aplicação de terceiros: Como a execução é local, não há alteração nos parâmetros utilizados.
Permite uso em LSP:Sim.
Síncrono
Ao executar, é enviada uma solicitação do servidor WildFly que irá gerar uma instância do sistema Senior para processar a requisição.
O processamento tem início no momento da chamada e o retorno será feito pelo servidor WildFly.
Permite uso em LSP:Sim.
Assíncrono
Ao executar, é enviada uma solicitação do servidor WildFly que irá gerar uma instância do sistema Senior para processar a requisição.
O processamento tem início no momento da chamada e não haverá retorno sobre o processamento da requisição.
Permite uso em LSP:Sim.
Agendado
A solicitação de execução será direcionada ao Middleware Senior, porém não ocorrerá no momento da requisição, ela será agendada para execução no Middleware.
Os web services agendados ficam armazenados no WildFly, com o agendamento sendo gerido pelo web service ScheduledService. Esse serviço controla os agendamentos e mantém todas as informações criptografadas dos web services agendados.
Neste modo de execução não há retorno da execução para o solicitante.
Permite uso em LSP:Não, pois não é possível informar a periodicidade na regra.
Parâmetros para aplicação de terceiros:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
id | Obrigatório | String | Identificador do serviço previamente agendado quando a operação for "Alterar" (operation = 1). |
operation | Obrigatório | Integer | Operação a ser realizada:
0 = Adicionar: agenda um novo serviço; 1 = Alterar: altera o agendamento do serviço identificado pelo parâmetro "id". |
regularity | Obrigatório | Integer | Periodicidade de execução do serviço, indicando como deve ser tratado o intervalo (parâmetro "interval"):
0 = Executa apenas uma vez; 1 = O intervalo é medido em minutos; 2 = O intervalo é medido em horas; 3 = O intervalo é medido em dias; 4 = O intervalo é medido em semanas; 5 = O intervalo é medido em meses. |
interval | Obrigatório | Integer | Intervalo de execução do serviço, de acordo com a periodicidade (parâmetro "regularity"). |
initDate | Obrigatório | String | Data inicial de execução do serviço.
Formato = DD/MM/YYYY. |
initTime | Obrigatório | String | Data inicial de execução do serviço.
Formato = HH:MM:SS (24 horas). |
fixedHour | Obrigatório | String | Hora em que o serviço deve ser executado, quando o parâmetro "regularity" for 3, 4 ou 5. |
fixedDay | Obrigatório | Integer | Dia em que o serviço deve ser executado, quando o parâmetro "regularity" for 5. |
weekDays | Obrigatório | String |
Dias da semana em que o serviço deve ser executado, quando o parâmetro "regularity" for 4. Deve ser informada uma String com o valor decimal de todos os dias concatenados sem nenhum separador, onde "1" representa o domingo e "7" representa o sábado.
Exemplo weekDays = "246" indica que o serviço executa na segunda-feira, na quarta-feira e na sexta-feira. |
execLate | Obrigatório | Boolean | Indica se o serviço pode ou não ser executado atrasado. |
validDate | Obrigatório | String | Data de validade do serviço, indicando qual a data máxima que ele pode ser executado.
Formato: DD/MM/YYYY. |
parameters | Obrigatório | Complex | Ver descrição na documentação das portas deste serviço. |
Autenticação
Parâmetros para aplicação de terceiros quando houver autenticação:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
user | Obrigatório | String | Nome do usuário para autenticação. |
password | Obrigatório | String | Senha do usuário para autenticação. |
encryption | Obrigatório | Integer | Versão de criptografia. Podendo ser: 0 – Indica que os parâmetros usuário e senha, trafegam como strings abertas formatadas com padrão "texto - utf8". 1 – A senha é cifrada com um algoritmo próprio da Senior (esta opção não pode ser usada por sistemas terceiros, apenas na integração entre sistemas Senior). 2 – O serviço não recebe a senha, mas um token Senior de autenticação (conforme documentação de Logon integrado com criptografia). 3 – O serviço não recebe a senha, mas um token do serviço de usuários G7 (esta opção não pode ser usada por sistemas terceiros, apenas na integração entre sistemas Senior). |