diff --git a/README.md b/README.md index 4083fcb..e6c7d8b 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,6 @@ Alguns serviços adicionais foram desenvolvidos para extrair dados que não são ## Procedimentos para instalação ### Configurar as propriedades dos datasources no JBoss. - O broker possui dois datasources e ambos estão declarados no arquivo `sei-broker-ds.xml`, eles são identificados como `jdbc/sei-broker` e `jdbc/sei-mysql`. O `jdbc/sei-broker` foi definido para acessar as tabelas que foram projetadas para o broker, o `jdbc/sei-mysql` se conecta ao banco de dados do SEI. O funcionamento dos datasources depende da declaração de algumas **System Properties** no JBoss. | Chave | Valor | @@ -42,7 +41,6 @@ Abaixo um exemplo de declaração de propriedades feita no arquivo `standalone.x ``` ### Criar e configurar os arquivos de propriedades no JBoss - O SEI-Broker faz uso de dois arquivos de propriedades que ficam na pasta `\ans\properties`, os arquivos necessários são `services.properties` e `ws-users.properties`. @@ -75,20 +73,17 @@ O SEI-Broker faz uso de dois arquivos de propriedades que ficam na pasta `
-### Criar security-domain no JBoss {: #config-security-domain} - +### Criar security-domain no JBoss É necessário que haja um security-domain registrado com o nome `ans-ws-auth`, o mesmo pode utilizar um banco de dados[^1] ou o LDAP. É importante destacar que o Broker trabalha com autorização baseada em papéis(RBAC[^2]) e que os usuários precisam ter seus papéis atribuídos. [^1]: https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html/how_to_configure_identity_management/configuring_a_security_domain_to_use_a_database [^2]: https://en.wikipedia.org/wiki/Role-based_access_control ### Implantar pacote gerado pelo Maven - Após a realização de todos os passos anteriores, teremos o JBoss pronto para receber o pacote do SEI-Broker. O deploy pode ser feito de diversas maneiras e não é o foco desse manual. Para essa etapa é necessário ter o Maven instalado e configurado. Ao realizar o primeiro build devemos desabilitar os testes automatizados, os testes dependem de uma instância ativa e impedirão a geração do pacote. ### Configurar Sistema no SEI - É preciso cadastrar o SEI-Broker como um sistema que se integrará ao SEI, conforme [manual de webservices do SEI](https://softwarepublico.gov.br/social/sei/manuais/manual-de-webservices). É importante ter atenção para a **sigla** quer será definida, por padrão o broker está configurado para utilizar a sigla `SEI-Broker`. Após o cadastro do Sistema precisaremos atribuir os serviços que serão utilizados pelo Broker, nesta etapa é preciso ter atenção para o valor que será definido no campo **identificação** e aos **servidores**. A identificação do serviço precisa ser enviada a cada requisição feita aos serviços do SEI, por padrão o Broker utiliza o valor `REALIZAR_INTEGRACAO`. No campo servidores informaremos os IPs dos servidores onde o SEI-Broker estará implantado. @@ -96,7 +91,6 @@ Após o cadastro do Sistema precisaremos atribuir os serviços que serão utiliz Os valores utilizados pelo Broker podem ser configurados na classe `Constantes`, **sigla** e **identificação** são respectivamente `SIGLA_SEI_BROKER` e `CHAVE_IDENTIFICACAO`. ### Gerar documentação da API - Após a implantação é **fundamental** que a documentação da API seja disponibilizada para os clientes do Broker. A documentação do Broker foi escrita utilizando a ferramenta [apiDoc](http://apidocjs.com/) e os fontes estão no diretório `/src/main/resources/apidoc/`. Será preciso fazer a instalação do apiDoc[^3] e executar o comando abaixo na raiz do projeto. [^3]: http://apidocjs.com/#install @@ -106,6 +100,22 @@ apidoc -f ".*\\.apidoc$" -i src/main/resources/apidoc/ -o