Mudanças entre as edições de "Instalação"

De PJe
Ir para: navegação, pesquisa
(Softwares requeridos)
Linha 544: Linha 544:
 
# execute o comando keytool -import -alias <alias> -file <certificado> -keystore <truststore>, onde <alias> é o apelido do certificado, <certificado> é o caminho onde o certificado foi salvo no passo 1 e <truststore> é o caminho de armazenamento dos certificados no java. Exemplo: keytool -import -alias cnj -file \tmp\www.cnj.jus.br.crt -keystore /usr/lib/jvm/java-6-openjdk-amd64/jre/lib/security/cacerts
 
# execute o comando keytool -import -alias <alias> -file <certificado> -keystore <truststore>, onde <alias> é o apelido do certificado, <certificado> é o caminho onde o certificado foi salvo no passo 1 e <truststore> é o caminho de armazenamento dos certificados no java. Exemplo: keytool -import -alias cnj -file \tmp\www.cnj.jus.br.crt -keystore /usr/lib/jvm/java-6-openjdk-amd64/jre/lib/security/cacerts
 
     Concluído o procedimento de instalação do certificado digital do CNJ, envie e-mail ao grupo g-lideres.pje@cnj.jus.br, informando os endereços IPs de saída dos servidores de aplicação para acesso ao serviço de consulta da Receita Federal do Brasil. Após a confirmação de cadastro, certifique-se de que os IPs de saída estão de fato cadastrados no CNJ, acessando o endereço https://www.cnj.jus.br/testeReceitaFederal/wsdl/proxyReceita.wsdl, por meio da execução do comando WGET diretamente na máquina servidora da aplicação.
 
     Concluído o procedimento de instalação do certificado digital do CNJ, envie e-mail ao grupo g-lideres.pje@cnj.jus.br, informando os endereços IPs de saída dos servidores de aplicação para acesso ao serviço de consulta da Receita Federal do Brasil. Após a confirmação de cadastro, certifique-se de que os IPs de saída estão de fato cadastrados no CNJ, acessando o endereço https://www.cnj.jus.br/testeReceitaFederal/wsdl/proxyReceita.wsdl, por meio da execução do comando WGET diretamente na máquina servidora da aplicação.
 +
 +
 +
=== Configuração para uso do ''jcr-storage'' ===
 +
 +
# Baixar o projeto do git(git@git.cnj.jus.br:utilitarios/jcr-storage.git)
 +
# Gerar o pacote "mvn clean package -DskipTests"
 +
# Entrar na pasta do projeto jcr-storage/server/target para iniciar o serviço
 +
## Executar o comando "nohup java -Xmx2048m -jar jcr-storage-server-xec.jar -httpPort 9000"
 +
# Incluir as seguintes dependência pasta lib do jboss
 +
## commons-io-1.4.jar
 +
## commons-lang3-3.1.jar
 +
## jcr-storage-client-x.x.x.jar
 +
## jcr-storage-common-x.x.x.jar
 +
# Criar o arquivo "jcr-storage.properties", dentro da mesma pasta das libs acima com os seguinte valores
 +
## jcr.url=http://localhost:9000/storage/documents
 +
## jcr.username=usuario
 +
## jcr.password=senha

Edição das 13h12min de 20 de junho de 2014

Os direcionamentos a seguir se destinam a instruir a equipe de infraestrutura de tecnologia da informação dos tribunais que utilizam o sistema PJe sobre os procedimentos necessários para a realização de uma instalação inicial do sistema, assim como sobre os procedimentos necessários para uma evolução de versão. As instruções têm por base a versão 1.4.x do sistema PJe – Processo Judicial Eletrônico.

Conteúdo

Público-alvo

As instruções a seguir se destinam à equipe de infraestrutura de tecnologia da informação do tribunal, especificamente àqueles responsáveis por:

  • instalar e manter sistemas gerenciadores de bancos de dados;
  • instalar e manter servidores de aplicação Java;
  • instalar e manter servidores de distribuição de carga de demandas Web.

Conhecimento prévio

Embora não seja essencial, é de grande utilidade que o responsável pela execução dos passos descritos a seguir:

  • esteja ambientado com os sistemas operacionais escolhidos para hospedar o sistema gerenciador de banco de dados e o servidor de aplicação em que será instalado o sistema PJe;
  • conheça a ferramenta de controle de pacotes de softwares instalados dos sistemas operacionais escolhidos para hospedar o sistema gerenciador de banco de dados e o servidor de aplicação em que será instalado o PJe;
  • conheça as configurações mais elementares do sistema gerenciador de banco de dados PostgreSQL 9.1;
  • conheça as configurações mais elementares de máquina virtual Java 1.6;
  • conheça as configurações mais elementares do servidor de aplicação JBoss AS 5.1;

Softwares requeridos

A depender do sistema operacional hospedeiro das aplicações, é necessário que o responsável pela instalação do sistema tenha disponível os seguintes softwares:

Alguns desses softwares podem ser obtidos diretamente no servidor FTP do Conselho Nacional de Justiça, além de algumas modificações destinadas a melhorar o desempenho da aplicação.

Pacote de instalação do PJe

O sistema PJe – Processo Judicial Eletrônico é disponibilizado para instalação no FTP do CNJ. Em sua versão 1.4.x, o pacote de instalação é composto pelos seguintes arquivos:

  • pje.war: arquivo de deploy da aplicação
  • instalacao_pje_1_4_x.pdf: manual de instalação do sistema
  • release_notes_pje_[versão].doc: lista das melhorias e correções incluídas na versão
  • PJE-ds.xml: arquivo de configuração de acesso às bases de dados do sistema
  • pje_[versão]_limpa.sql e pje_[versão]_limpa_bin.sql: scripts para criação das bases de dados minimamente configuradas
  • /scripts: diretório onde são incluídos scripts para migração da versão imediatamente anterior para a versão atual
  • /scripts/imports: diretório onde são incluídos scripts de carga de dados
  • /outros/InstallCert.java: arquivo utilitário para inclusão do certificado do CNJ na lista de certificados confiáveis da JVM

Para acesso ao FTP são necessários os seguintes procedimentos:
1. Conectar ao FTP do CNJ (via linha de comando ou ferramenta): FTP;
2. Informar o usuário e a senha fornecidos aos tribunais para acesso ao FTP do CNJ;
3. Certificar-se de que a configuração de transferência do FTP esteja setada para binário ou automático a fim de realizar a transferência do pacote de instalação corretamente;
4. Navegar até o diretório “pje_descanso”;
5. Baixar o arquivo da versão mais recente.

Sistema gerenciador de banco de dados

O sistema PJe – Processo Judicial Eletrônico, em sua versão 1.4.x, prevê sua utilização com o sistema gerenciador de banco de dados PostgreSQL, em sua versão 9.2 ou superior. A versão 9.2 do SGBD PostgreSQL apresenta significativas vantagens sobre as versões anteriores desse banco de dados, em especial aquelas pertinentes à replicação imediata de bases e à possibilidade de realização de cópias de segurança com a aplicação em uso. Não obstante essa escolha, há retrocompatibilidade de banco de dados com a versão 8.4, caso a estrutura do banco seja repetida nesta versão. Atualmente o CNJ utiliza com sucesso a versão 9.3.

Instalação

A instalação do SGBD PostgreSQL é extremamente mutável, a depender do sistema operacional. Uma vez que não é nosso escopo abranger todas as possibilidades de instalação, descreveremos a configuração de um banco de dados já instalado no sistema operacional. Uma vez instalado o PostgreSQL no sistema operacional hospedeiro, é necessário realizar algumas configurações mínimas para seu adequado funcionamento com o PJe.

Usuário básico

Ao ser instalado, o PostgreSQL define um usuário básico responsável pela administração do banco de dados. Ordinariamente, esse usuário tem o login “postgres” e sua senha é definida durante o processo de instalação do SGBD. Se essa senha não foi definida durante a instalação, é necessário que o administrador do sistema operacional hospedeiro o faça em seguida. Para isso, considerando um SO do padrão POSIX, devem ser executados alguns comandos na linha de comando do SO hospedeiro. São os seguintes:


usuario@sohost:~$ sudo su – postgres -c 'psql'
[sudo] password for usuario:
psql (9.x)
Type “help”for help.
(1)
postgres=# \password
Enter new password:
Enter it again:
(2)
postgres=# \quit (3)

O comando (1) permite que o administrador assuma a identidade do usuário “postgresql”, ao mesmo tempo em que executa, como este usuário, o cliente de banco de dados psql na base padrão. Dependendo da configuração do sistema operacional, será exigida do usuário administrador a entrada de sua senha de usuário para a execução desse comando.
O comando (2) indica que o usuário “postgres” pretende definir ou modificar sua senha. A senha deve ser definida por meio de sua inserção seguida da tecla enter e a repetição do procedimento. Após, basta executar o comando (3) para sair do sistema.

Liberação para acesso em rede

Por padrão, a instalação do PostgreSQL não permite que clientes de outros computadores da mesma rede possam acessar o banco de dados. Em razão disso, é necessário modificar dois arquivos de configuração do PostgreSQL para permitir tais acessos.
O primeiro arquivo a ser modificado é o arquivo postgresql.conf, localizado na pasta main da tablespace do sistema (/etc/postgresql/9.x, /var/local/postgresql/9.x, etc.). Nesse arquivo, é necessário editar a linha com o parâmetro listen_addresses, que originalmente contém “localhost”. Deve ser substituído o conteúdo “localhost” pelos números IPs, separados por vírgulas, dos equipamentos autorizados a acessar o banco de dados. Embora não seja recomendável, caso a estrutura e a política de segurança do tribunal permita, a lista de IPs, pode ser substituída por asterisco (*), caso em que o servidor de banco de dados poderá receber conexões de qualquer origem.
No mesmo arquivo, é recomendável ativar o parâmetro password_encryption, atribuindo a ele o valor “on”.
Finalmente, é necessário editar o arquivo pg_hba.conf, localizado na mesma pasta. Esse arquivo tem uma longa documentação explicativa. Em síntese, o objetivo desse arquivo é fazer o ajuste fino a respeito de como e o que pode ser acessado remotamente. Para uma configuração simples é necessário acrescentar, após a última linha, linhas contendo a configuração de acesso às bases do PJe. No caso de criação dos bancos de dados “pje_descanso” e “pje_descanso_bin” com o controle pelo usuário padrão “postgres” e acesso à uma subrede 10.0.0.*, as linhas acrescentadas poderiam ser:

host pje_descanso postgres 10.0.0.0/24 md5
host pje_descanso_bin postgres 10.0.0.0/24 md5

Essas duas linhas significam que o usuário “postgres” poderá acessar os bancos de dados “pje_descanso” e “pje_descanso_bin” se seu acesso for realizado com o uso de senha encriptada a partir de máquinas cujo IP estejam entre 10.0.0.1 e 10.0.0.255.
Para mais informações a respeito dessas configurações de acesso, consulte http://www.postgresql.org/docs/9.1/interactive/client-authentication.html.

Configuração específica

O sistema PJe utiliza dois bancos de dados para suas operações usuais. Isso por vezes demanda a preparação de mais de uma transação em um mesmo momento. Para suportar esse tipo de operação, é necessário modificar uma configuração específica do SGBD. Essa configuração é feita no mesmo arquivo postgresql.conf anteriormente mencionado. Após abri-lo, deve ser modificado o parâmetro max_prepared_transactions para que esse tipo de operação seja ativado, configurando-se o valor para, no mínimo, 10, conforme a capacidade do equipamento servidor disponibilizado para o SGDB.
Favor verificar a documentação do SGBD a respeito.

Carga inicial dos dados do PJe no SGBD

O sistema PJe – Processo Judicial Eletrônico foi concebido para funcionamento em cenários muito diversos de instalações, especialmente considerando a multiplicidade de segmentos do Judiciário e suas especificidades. Em razão disso, ele encerra uma quantidade significativa de configurações que, feitas manualmente, tornaria difícil, senão impossível chegar a um cenário utilizável em um prazo razoável. Em razão disso, são disponibilizadas, com a versão binária do sistema, cópias de bases de dados com uma configuração mínima a partir da qual os tribunais podem começar a configurar o sistema conforme suas características próprias. As cópias são disponibilizadas, ordinariamente, em formato SQL, que permitem o uso entre versões diferentes do PostgreSQL. Eventualmente, podem ser disponibilizadas em formato binário.

Criação dos bancos de dados

Os bancos de dados do PJe devem ser criados utilizando algumas características essenciais, quais sejam:

  • encoding: LATIN1
  • template: template0
  • collation: C
  • character type: C

A criação do banco pode ser feita diretamente do sistema operacional utilizando o comando createdb. Eis um exemplo:

usuario@sohost:~$ createdb -E LATIN1 –-lc-collate=C –lc-ctype=C -O postgres -T template0 -h 123.45.67.8 -W -U postgres pje_descanso

O comando acima criou um banco de dados chamado “pje_descanso” pertencente ao usuário “postgre” no banco de dados localizado na máquina “123.45.67.8” com as características essenciais do PJe. O mesmo deveria ser feito para o banco binário, que deve, por óbvio, ter outro nome, por exemplo: “pje_descanso_bin”.

Carga de banco de dados em script SQL

A carga do banco de dados a partir de scripts SQL deve também ser feita por meio da linha de comando, agora utilizando o cliente de terminal do PostgreSQL, psql:

psql -U USUARIO -h SERVIDOR -d DATABASE -W < ARQUIVO, onde:

USUARIO - usuário de banco de dados com acesso a base criada
SERVIDOR - IP ou DNS do servidor que responde ao PostgreSQL
DATABASE - banco de dados criado para restauração do dump
ARQUIVO - caminho completo ou relativo para o arquivo SQL que contém a restauração

usuario@sohost:~$ psql -U postgres -h 123.45.67.8 -d pje_descanso –W < ./ pje_descanso_1.4.3_limpa.sql

O exemplo acima carrega o banco “pje_descanso” com os dados do backup SQL contido no arquivo “pje_descanso_1.4.3_limpa.sql”. O mesmo deve ser feito com o backup SQL do banco binário.
Após a carga de dados, é necessário executar o comando SQL de INSERT listado abaixo na base “pje_descanso” para definição do CPF e nome do usuário administrador do sistema. Isso é necessário para que seja possível ao admin cadastrar os usuários da aplicação a partir do serviço de consulta de pessoas físicas e jurídicas da Receita Federal. Atente para a necessidade de substituir os parâmetros <CPF> e <NOME> pelo número do CPF (com máscara) e nome do detentor do documento.

INSERT INTO client.tb_pess_doc_identificacao
(  
  id_pessoa_doc_identificacao, 
  cd_tp_documento_identificacao, 
  nr_documento_identificacao, 
  dt_expedicao, 
  ds_nome_pessoa, 
  in_usado_falsamente, 
  in_ativo, 
  ds_orgao_expedidor, 
  id_estado_expedidor, 
  id_pessoa, 
  in_principal, 
  dt_usado_falsamente, 
  id_pais, 
  id_usuario_cadastrador
)
VALUES 
(
  nextval('client.sq_tb_pess_doc_identificacao'), 
  'CPF', 
  '<CPF>', 
  NULL, 
  '<NOME>', 
  'FALSE', 
  'TRUE',
  'Secretaria da Receita Federal', 
  NULL, 
  1, 
  'TRUE',
  NULL, 
  NULL, 
  NULL
);

Instalação e configuração do servidor de aplicação

O sistema PJe – Processo Judicial Eletrônico é uma aplicação Web escrita na linguagem de programação Java. Assim sendo, ela é executada em um servidor de aplicação específico, o JBoss Application Server 5.1.0. Para garantir o correto funcionamento do sistema, certifique-se que os passos abaixo foram executados com sucesso.


  1. Uma das premissas do sistema é que esteja instalada no sistema operacional uma máquina virtual Java JDK com versão 1.6.0_45. Recomendamos o uso do java JDK 1.7.0_51, porém para este JDK funcionar com o JBoss Server 5.1.0, deve ser aplicado um patch que corrige um classloader no bootstrap.xml ou usar a versão EAP 5.2.0. Atualmente o CNJ utiliza o JBOSS EAP 5.2.0 junto com o Java SDK 1.7.0_51. Para verificar se o sistema operacional possui uma versão JDK devidamente instalada, execute o comando a seguir.
    usuario@sohost:~$ java -version
    
  2. Baixe e instale o JBoss Application Server 5.1.0 para JDK 1.6, para isso siga os passos seguintes:
    1. Baixe o JBoss disponível na URL http://downloads.sourceforge.net/project/jboss/JBoss/JBoss-5.1.0.GA/jboss-5.1.0.GA-jdk6.zip?r=&ts=1386707755&use_mirror=ufpr. Certifique-se que o pacote baixado é o jboss-5.1.0.GA-jdk6.zip e não o pacote jboss-5.1.0.GA.zip, pois a versão para JDK 1.6 já vem com as bibliotecas do Jboss que implementam o padrão jaxws instaladas. Essas bibliotecas são condição para o perfeito funcionamento das comunicações via web service.
    2. Descompacte o arquivo jboss-5.1.0.GA-jdk6.zip para o local desejado na estrutura de arquivos (Ex: /opt/jboss-5.1.0.GA). Deve-se atentar que alguns sistemas operacionais permitem a instalação desses servidores por meio de pacotes de instalação que já configuram a inicialização e parada do servidor.
  3. Reconfigure os limites de memória disponibilizados para o servidor de aplicação. Isso pode ser feito no script de inicialização do servidor, pela linha de comando ou diretamente no arquivo run.conf, localizado na pasta descompactada JBOSS_DIR/bin. Em quaisquer dos cenários, o que se faz é modificar a variável de ambiente JAVA_OPTS para disponibilizar mais memória para a aplicação Java. Essencialmente, devem ser aumentadas a memória total de pilha – parâmetro -Xmx – e o tamanho máximo da memória permanente – parâmetro -XX:MaxPermSize. O tamanho máximo disponível da memória total de pilha é severamente limitado pelo sistema operacional quando ele é de 32 bits, motivo por que é recomendável utilizar sistemas operacionais de 64 bits, caso em que a barreira de 3GB de memória disponível é facilmente superada. O ideal é dispor do máximo possível da memória disponível no servidor de aplicação para a máquina virtual Java, assegurando um mínimo de 1024MB. Para a memória permanente (MaxPermSize), recomenda-se um mínimo de 256MB. Desse modo, os parâmetros acima devem ser modificados no arquivo JBOSS_DIR/bin/run.conf ou nas variáveis de ambiente ou script para o seguinte:
    JAVA_OPTS=”$JAVA_OPTS –Xms1024m -Xmx1024m -XX:MaxPermSize=256m”
    
  4. Modifique o arquivo JBOSS_DIR/server/default/deployers/seam.deployer/META-INF/seam-deployers-jboss-beans.xml, apagando ou comentando a linha que define o bean SeamMTMatcher, conforme recomendado em registro de falha específico [1]. Note-se que a afirmação retro parte da premissa de que a configuração do servidor escolhida para execução do PJe é a default, devendo esse nome ser substituído pelo do servidor efetivamente escolhido.
  5. Modifique o arquivo JBOSS_DIR/server/default/deployers/jbossws.deployer/META-INF/standard-jaxws-client-config.xml, alterando o valor da propriedade chunksize de “2048” para “0”. Isso é necessário para permitir consultas a webservices que exigem autenticação via SOAP Header, caso do serviço de consultas a advogados da OAB.
  6. Acrescente a biblioteca JAR do driver JDBC do PostgreSQL à pasta JBOSS_DIR/server/default/lib.
  7. Para servidores de aplicação configurados em rede interna e disponibilizados na Internet através de proxy, o arquivo JBOSS_DIR/server/default/deployers/jbossws.deployer/META-INF/jboss-beans.xml deve ser alterado conforme a seguir:
    • comentar a linha "property name="webServiceHost..."
    • alterar o valor da propriedade "modifySOAPAddress" para "false"
    Abaixo, trecho do arquivo conforme alteração:
    <!--property name="webServiceHost">${jboss.bin.address}</property-->
    <property name="modifySOAPAddress">false</property>
    
    Essa alteração corrige a informação exibida na lista de serviços do PJe disponibilizada através de <urlpje>/intercomunicacao?wsdl
  8. Para o correto funcionamento dos webservices é necessário atualizar as bibliotecas jaxb do JBoss para a versão 2.2.7. Para isso siga os passos abaixo:
    1. Baixe o JAXWS 2.2.7 da URL https://jax-ws.java.net/2.2.7/JAXWS2.2.7-20120813.zip;
    2. Copie e substitua os arquivos JAXWS2.2.7-20120813.zip/jaxws-ri/lib/jaxb-impl.jar e JAXWS2.2.7-20120813.zip/jaxws-ri/lib/jaxb-xjc.jar para a pasta JBOSS_DIR/lib;
    3. Copie e substitua o aquivo JAXWS2.2.7-20120813.zip/jaxws-ri/lib/jaxb-api.jar a para a pasta JBOSS_DIR/lib/endorsed.
    4. Caso a biblioteca em questão não esteja devidamente instalada, na fase de deploy do war acontecerá o seguinte erro:

             Caused by: java.lang.IllegalStateException: Cannot build JAXB context
             at org.jboss.ws.metadata.builder.jaxws.JAXWSMetaDataBuilder.createJAXBContext(JAXWSMetaDataBuilder.java:994)
             at org.jboss.ws.metadata.builder.jaxws.JAXWSWebServiceMetaDataBuilder.buildWebServiceMetaData(JAXWSWebServiceMetaDataBuilder.java:163)
             at org.jboss.ws.metadata.builder.jaxws.JAXWSServerMetaDataBuilder.setupProviderOrWebService(JAXWSServerMetaDataBuilder.java:52)
             at org.jboss.ws.metadata.builder.jaxws.JAXWSMetaDataBuilderJSE.buildMetaData(JAXWSMetaDataBuilderJSE.java:62)
             at org.jboss.wsf.stack.jbws.UnifiedMetaDataDeploymentAspect.start(UnifiedMetaDataDeploymentAspect.java:64)
             at org.jboss.wsf.framework.deployment.DeploymentAspectManagerImpl.deploy(DeploymentAspectManagerImpl.java:129)
             at org.jboss.wsf.container.jboss50.deployer.ArchiveDeployerHook.deploy(ArchiveDeployerHook.java:76)
             at org.jboss.wsf.container.jboss50.deployer.AbstractWebServiceDeployer.internalDeploy(AbstractWebServiceDeployer.java:60)
             at org.jboss.deployers.spi.deployer.helpers.AbstractRealDeployer.deploy(AbstractRealDeployer.java:55)
             at org.jboss.deployers.plugins.deployers.DeployerWrapper.deploy(DeployerWrapper.java:179)
             ... 31 more
      

      Obs.: Na instalação padrão do red-hat enterprise linux 6.5, os arquivos .jar dos diretórios JBOSS_DIR/lib e JBOSS_DIR/lib/endorsed são links simbólicos. Assim, convém alterar os arquivos apontados por estes links. Desta forma, bastar copiar os arquivos acima para o diretório /usr/share/java-signed/glassfish-jaxb.

  9. Instale a biblioteca Apache Portable Runtime (libtcnative), que faz com que algumas chamadas Java sejam delegadas para bibliotecas nativas do sistema operacional, melhorando o desempenho do sistema em produção. Para isso siga os passoa abaixo:
    1. Baixe o JBOSS NATIVE 2.0.10 disponível na URL http://downloads.jboss.org/jbossnative//2.0.10.GA/jboss-native-2.0.10-linux2-x64-ssl.tar.gz;
    2. Copie o arquivo jboss-native-2.0.10-linux2-x64-ssl.tar.gz/bin/native/openssl para a pasta JBOSS_DIR/bin/;
    3. Copie os arquivos jboss-native-2.0.10-linux2-x64-ssl.tar.gz/bin/native/* para a pasta JBOSS_DIR/bin/META-INF/lib/linux2/x64/.
  10. Observação: Para que o APR seja inicializado com sucesso pelo Eclipse é necessário colocar a linha abaixo no início dos parâmetros da VM do launch do servidor. -Djava.net.preferIPv4Stack=true -Djava.library.path=JBOSS_DIR/bin/META-INF/lib/linux2/x64

  11. Para habilitar o SSL do JBoss altere o arquivo JBOSS_DIR/server/default/deploy/jbossweb.sar/server.xml, descomentando e alterando o connector SSL para ficar conforme exemplo abaixo.
    A configuração a seguir refere-se ao cenário onde o JBoss faz o papel de Container Web e Servidor de Aplicações, muitos tribunais usam o Apache como Container Web, neste caso a habilitação do SSL é feita no próprio Apache.
    <Connector 
        protocol="org.apache.coyote.http11.Http11Protocol" 
        SSLEnabled="true" 
        port="8443" 
        address="${jboss.bind.address}"
        scheme="https" 
        secure="true" 
        clientAuth="want" 
        keystoreFile="{CAMINHO DO KEYSTORE}"
        keystorePass="{SENHA DO KEYSTORE}" 
        truststoreFile="{CAMINHO DO TRUSTSTORE}" 
        truststorePass="{SENHA DO TRUSTSTORE}"
        sslProtocol = "TLS" />
    

    Exemplo:

    <Connector 
        protocol="org.apache.coyote.http11.Http11Protocol" 
        SSLEnabled="true" 
        port="8443" 
        address="${jboss.bind.address}"
        scheme="https" 
        secure="true" 
        clientAuth="want" 
        keystoreFile="/desenvolvimento/documento/certificado-digital/pje-documentacao/cnj-jboss.keystore"
        keystorePass="123456" 
        truststoreFile="/desenvolvimento/documento/certificado-digital/pje-documentacao/cnj-jboss.truststore" 
        truststorePass="123456"
        sslProtocol = "TLS" />
    

    Segue a rotina para geração de keystore e truststore de exemplo.

    usuario@sohost:~$ keytool -genkey -alias jbosskey -keyalg RSA -keystore cnj-jboss.keystore -storepass 123456 -keypass 123456 -dname "CN=jboss, OU=PJe, O=Conselho Nacional de Justica, L=Brasilia, ST=DF, C=BR"
    usuario@sohost:~$ keytool -export -alias jbosskey -keystore cnj-jboss.keystore -storepass 123456 -file cnj-jboss.cer
    usuario@sohost:~$ keytool -genkey -alias clientekey  -keyalg RSA -keystore cnj-cliente.keystore -storepass 123456 -keypass 123456 -dname "CN=cliente, OU=PJe, O=Conselho Nacional de Justica, L=Brasilia, S=DF, C=BR" 
    usuario@sohost:~$ keytool -export -alias clientekey -keystore cnj-cliente.keystore -storepass 123456 -file cnj-cliente.cer
    usuario@sohost:~$ keytool -import -v -keystore cnj-cliente.truststore  -storepass 123456 -file cnj-jboss.cer -alias jbosskey
    usuario@sohost:~$ keytool -import -v -keystore cnj-jboss.truststore  -storepass 123456 -file cnj-cliente.cer -alias clientekey
    

Observações gerais:

  1. Deve-se lembrar que, pretendendo-se disponibilizar o sistema para uso em produção, o servidor de aplicação deve ser configurado para responder pela porta 80 com reencaminhamento para a porta segura 443, com disponibilização da aplicação apenas por meio do protocolo HTTPS.
  2. Certifique-se que o LOCALE do servidor de aplicações esteja corretamente configurado para PT_BR. Em servidores Linux RedHat, essa configuração é feita no atributo LANG do arquivo /etc/sysconfig/i18n.
  3. LANG=”pt_BR.UTF-8” 
    

Instalação do PJe no servidor de aplicação

A instalação do PJe no servidor de aplicação é feita em duas etapas: a configuração dos bancos de dados no servidor de aplicação e a efetiva implantação do sistema.

Configuração dos esquemas

Na utilização de postgres, para que a manipulação do banco de dados do PJe possa ser feita sem utilização dos esquemas na referência às tabelas, é necessário incluir no parâmetro search_path os esquemas existentes no banco.

O search_path é um parâmetro que está presente no arquivo "postgresql.conf". Por padrão, a linha estará assim:

#search_path = '"$user",public' # schema names

Deverá ficar assim:

search_path = '"$user",public,client,core,jt,criminal,acl' # schema names

Se, por ventura em um outro momento, for criado um novo esquema no banco, deverá ser incluído no search_path. É importante retirar o símbolo "#" da frente do nome search_path, caso contrário, as alterações não serão reconhecidas pelo servidor de Banco de Dados.

Após as alterações é necessário rodar este comando com o usuário "postgres" na base "postgres":

SELECT pg_reload_conf();

O comando acima deverá ser executado uma vez em cada servidor que foi alterado. Por exemplo: suponhamos que há um servidor "172.172.0.170" e nesse servidor há dez bases de dados. É suficiente rodar o comando pg_reload apenas uma vez na base "postgres" desse servidor. As configurações já servirão para todas as outras bases do servidor. Se por ventura for criada uma nova base depois, a mesma já reconhecerá as configurações também. Caso tenha um outro servidor de banco de dados, o mesmo procedimento deverá ser feito para ele também.

Obs: Não será necessário reiniciar o servidor de Banco de Dados, pois esse parâmetro é dinâmico e a execução do pg_reload é suficiente para o servidor reconhecer as novas configurações.

Configuração dos mocks

Para uso em ambiente de teste, o PJe permite a utilização de simulação no acesso a serviços externos, em particular à validação de CPF e CNPJ na Receita Federal do Brasil e à validação da OAB no Conselho Federal da OAB. Para utilizar os simuladores, deve-se configurar, no arquivo components.xml, disponível no pacote war da aplicação, os seguintes parâmetros como "true".

<component name="consultaClienteReceitaPFCNJ" class="br.jus.cnj.pje.nucleo.service.ConsultaClienteReceitaPFMock" 
    precedence="100" installed="true"/>
<component name="consultaClienteReceitaPJCNJ" class="br.jus.cnj.pje.nucleo.service.ConsultaClienteReceitaPJMock" 
    precedence="100" installed="true"/>
<component name="consultaClienteOAB" class="br.jus.cnj.pje.nucleo.service.ConsultaClienteOABMock" precedence="100" installed="true"/>

Configuração de parâmetros para upload de arquivos

A partir da versão 1.6.0, nas funcionalidades de protocolo inicial, de anexação de documentos nos detalhes do processo e na resposta de expediente, o PJE permite que se faça upload de documentos múltiplos anexados ao documento principal. A configuração padrão de instalação do PJe utiliza os seguintes parâmetros como base:

application/pdf:1572864 
audio/mpeg:5242880
audio/ogg:5242880
audio/vorbis:5242880 
image/png:1572864
video/ogg:10485760
video/mp4:10485760

Ou seja, permite os mimetypes listados acima com os respectivos tamanhos em bytes.

Pode-se alterar esse parâmetros acrescentando uma linha no arquivo components.xml, que adicione os tipos que se deseja permitir associados aos respectivos tamanhos. Como exemplo, pode-se utilizar a linha abaixo:

<factory name="mimeData" scope="application" value="application/pdf:1572864;audio/mpeg:5242880;audio/ogg:5242880;audio/vorbis:5242880;
  image/png:1572864;video/ogg:10485760;video/mp4:10485760" auto-create="true"/>

É válido ressaltar que no web.xml deve estar permitido o tamanho configurado, ou seja, o parâmetro maxRequestSize deve ser maior ou igual ao maior tamanho configurado no components.xml.

<param-name>maxRequestSize</param-name>
<param-value>10485760</param-value>

Configuração dos bancos de dados no servidor de aplicação

O PJe utiliza, atualmente, duas fontes de dados para armazenamento das informações. Uma das fontes é o banco de metadados do sistema, onde ficam armazenadas todas as informações das partes, processos e documentos. A segunda fonte de dados é um banco onde ficam armazenados apenas os documentos binários, ou seja, o efetivo conteúdo daqueles documentos que foram enviados pelas partes ao sistema, e não produzidos no próprio sistema. Há a possibilidade de se utilizar uma terceira fonte de dados, responsável por armazenar os dados de log do sistema (tb_log e tb_log_detalhe). Recomendamos essa possibilidade para melhoria de performance.
Essas fontes de dados recebem nomes específicos nos arquivos de configuração do próprio PJe, que devem ser referenciados quando da criação do arquivo de fontes de dados, no JBoss AS. Independente de se utilizar uma fonte de dados separada para o armazenamento de logs, a referência aos logs é feita separadamente no arquivos de fontes de dados. Em nossos testes, configuramos a quantidade mínima de conexões da base de log com a metade da máxima da base da aplicação e a quantidade máxima com os mesmos valores da base de aplicação. Mas os tribunais devem configurar da forma que acharem mais adequado.
A definição de fontes de dados no JBoss AS é feita por meio de arquivos XML terminados em “-ds.xml” localizados no diretório /deploy da configuração do servidor escolhido. Para uma configuração padrão, seria o arquivo JBOSS_DIR/server/default/deploy/PJE-ds.xml.
Junto com o pacote de instalação do sistema, é disponibilizado o arquivo PJE-ds.xml, que precisa ser alterado com as configurações locais. O conteúdo desse arquivo deve seguir o padrão da definição de fontes de dados. Abaixo, transcreve-se um arquivo de exemplo cujos IPs dos servidores de bancos de dados, nomes de bancos de dados e usuários e senhas devem ser modificados apropriadamente.

<?xml version="1.0" encoding="UTF-8"?> 
<!-- $Id: PJE2-dev-ds.xml 10915 2010-08-17 21:14:53Z daniel_cnj $ -->
<!DOCTYPE datasources PUBLIC "-//JBoss//DTD JBOSS JCA Config 1.5//EN" "http://www.jboss.org/j2ee/dtd/jboss-ds_1_5.dtd"> <datasources> <xa-datasource> <jndi-name>PJE_DESCANSO_DS</jndi-name> <xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class> <xa-datasource-property name="ServerName">192.168.122.55</xa-datasource-property> <xa-datasource-property name="PortNumber">5432</xa-datasource-property> <xa-datasource-property name="DatabaseName">pje_descanso</xa-datasource-property> <user-name>postgres</user-name> <password>senha</password> <track-connection-by-tx /> <metadata> <type-mapping>PostgreSQL 8.0</type-mapping> </metadata> </xa-datasource> <xa-datasource> <jndi-name>PJE_DESCANSO_BIN_DS</jndi-name> <xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class> <xa-datasource-property name="ServerName">192.168.122.55</xa-datasource-property> <xa-datasource-property name="PortNumber">5432</xa-datasource-property> <xa-datasource-property name="DatabaseName">pje_descanso_bin</xa-datasource-property> <user-name>postgres</user-name> <password>senha</password> <track-connection-by-tx /> <metadata> <type-mapping>PostgreSQL 8.0</type-mapping> </metadata> </xa-datasource> <xa-datasource> <jndi-name>PJE_DESCANSO_LOG_DS</jndi-name> <xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class> <xa-datasource-property name="ServerName">192.168.122.55</xa-datasource-property> <xa-datasource-property name="PortNumber">5432</xa-datasource-property> <xa-datasource-property name="DatabaseName">pje_log</xa-datasource-property> <user-name>postgres</user-name> <password>senha</password> <track-connection-by-tx/> <metadata> <type-mapping>PostgreSQL 8.0</type-mapping> </metadata> </xa-datasource> </datasources>

Implantação do PJe

A implantação do PJe no servidor de aplicação, mantidas as informações padronizadas, limita-se a colocar o arquivo WAR do sistema na pasta /deploy da configuração de servidor escolhida para a instalação.
Uma vez efetivada essa cópia na pasta e inicializado o servidor de aplicação (comando run.sh), o próprio servidor de aplicação se responsabilizará por complementar a instalação. O sistema estará disponível para acesso no endereço em que foi disponibilizado o servidor, com o nome sem a extensão. Assim, se o arquivo WAR tinha nome “pje.war” e o servidor estiver disponibilizando o acesso seguro HTTPS no endereço “123.45.67.89”, o sistema será acessível apontando o navegador para https://123.45.67.89/pje.
Como ato final da instalação, ainda utilizando o exemplo acima, acesse o endereço https://123.45.67.89/pje/pages/admin/reindex.seam (utilizando o mesmo servidor do exemplo acima) para gerar os índices necessários à aplicação. O procedimento força a atualização dos índices do hibernate-search, utilizado, entre outras funcionalidades, na identificação de processos preventos.

Acesso ao serviço da Receita Federal

Finalizada a instalação do servidor de aplicação, deve-se instalar o certificado digital do CNJ. Somente assim o sistema será capaz de se comunicar com o serviço de consulta a dados da Receita Federal do Brasil. O serviço de validação de CPF da receita federal é um serviço contratado pelos órgãos, públicos ou não, para consulta de CPF. Dessa forma, a receita exige que o órgão forneça sua identificação para que ela responda à consulta só aos órgãos com os quais ela tem contrato. A forma automática que a receita tem de validar quem está fazendo a consulta é através do certificado digital do órgão contratante, que é fornecido quando o site que realiza a consulta o envia para a receita. Ao se utilizar métodos java, o certificado a ser enviado deve estar configurado na máquina java utilizada pelo servidor de aplicação que faz a consulta do CPF. Os passos descritos aqui se destinam a esse fim, ou seja, configurar o java utilizado pelo Jboss de forma que ele armazene o certificado que será utilizado para que a receita valide se a consulta está sendo realizada através de um órgão contratante do seu serviço. Para o caso de tribunais que não têm contrato próprio, pode-se utilizar o certificado do CNJ. O certificado do CNJ pode ser obtido através de transações seguras realizadas com o CNJ. Através do site https://www.cnj.jus.br/ecnj é um exemplo. Ao acessar esse endereço, você terá acesso a um cadeado do lado esquerdo da barra de endereços que, sendo acionado, permitirá a exibição e guarda do certificado. Ao exibir o certificado, haverá uma aba Detalhes contendo um botão para exportação do certificado, que deve ser salvo em uma pasta do servidor para posterior importação para o java. Esse arquivo é importado para o Java através das instruções a seguir:

  1. salve o arquivo do certificado em algum diretório
  2. abra uma janela onde você possa executar comandos via linha de comando
  3. na pasta lib/security do java, renomeie o arquivo cacerts para um outro nome qualquer, por exemplo, cacerts_old
  4. execute o comando keytool -import -alias <alias> -file <certificado> -keystore <truststore>, onde <alias> é o apelido do certificado, <certificado> é o caminho onde o certificado foi salvo no passo 1 e <truststore> é o caminho de armazenamento dos certificados no java. Exemplo: keytool -import -alias cnj -file \tmp\www.cnj.jus.br.crt -keystore /usr/lib/jvm/java-6-openjdk-amd64/jre/lib/security/cacerts
  5. ao executar o comando, o sistema solicitará a senha de acesso ao banco de certificados (<trutstore>) que, se não tiver sido alterada na instalação do Java, será changeit
  6. Concluído o procedimento de instalação do certificado digital do CNJ, envie e-mail ao grupo g-lideres.pje@cnj.jus.br, informando os endereços IPs de saída dos servidores de aplicação para acesso ao serviço de consulta da Receita Federal do Brasil. Após a confirmação de cadastro, certifique-se de que os IPs de saída estão de fato cadastrados no CNJ, acessando o endereço https://www.cnj.jus.br/testeReceitaFederal/wsdl/proxyReceita.wsdl, por meio da execução do comando WGET diretamente na máquina servidora da aplicação


Ao atualizar o seu certificado, o CNJ notificará os tribunais usuários do PJe através de lista de contatos para que eles realizem a atualização conforme procedimento acima. Após a atualização, o servidor deverá ser reiniciado.

Para instalações de teste, o acesso ao serviço pode ser interceptado por um serviço interno do PJe, que retornará dados aleatórias para os CPFs e CNPJs consultados. Para utilizar o simulador (Mock), deve-se configurar, no arquivo components.xml, disponível no pacote war da aplicação, os seguintes parâmetros:

<component name="consultaClienteReceitaPFCNJ" class="br.jus.cnj.pje.nucleo.service.ConsultaClienteReceitaPFMock" precedence="100" installed="true"/>
<component name="consultaClienteReceitaPJCNJ" class="br.jus.cnj.pje.nucleo.service.ConsultaClienteReceitaPJMock" precedence="100" installed="true"/>

Procedimentos para evolução de versão

Em um cenário de evolução de versão em situação de produção, os passos para reinstalação são os mesmos acima, devendo-se atentar especialmente no que é posto nas notas de liberação de versão. Nelas são destacados os procedimentos especiais de modificação e atualização dos bancos de dados e o meio de preservação de dados já existentes não armazenados em bancos de dados.
Deve-se sempre lembrar que a evolução de versão em situação de produção deve ser sempre precedida de realização de cópia de segurança dos dados e de testes de evolução em ambientes de homologação.

Guia rápido de instalação

Softwares requeridos

Pacote de instalação do PJe

O pacote de instalação do PJe é composto dos seguintes arquivos:

  • pje.war: arquivo de deploy da aplicação
  • instalacao_pje_1_4_x.pdf: manual de instalação do sistema
  • release_notes_pje_[versão].doc: lista das melhorias e correções incluídas na versão
  • PJE-ds.xml: arquivo de configuração de acesso às bases de dados do sistema
  • pje_[versão]_limpa.sql e pje_[versão]_limpa_bin.sql: scripts para criação das bases de dados minimamente configuradas
  • /scripts: diretório onde são incluídos scripts para migração da versão imediatamente anterior para a versão atual
  • /scripts/imports: diretório onde são incluídos scripts de carga de dados
  • /outros/InstallCert.java: arquivo utilitário para inclusão do certificado do CNJ na lista de certificados confiáveis da JVM

Para baixar o pacote de instalação do PJe, é necessário acessar a área de versões do sistema, disponibilizada no FTP do CNJ.
1. Conecte-se ao FTP do CNJ (via prompt de comando ou ferramenta): ftp.cnj.jus.br
2. Informe o usuário e a senha disponibilizados aos tribunais para acesso ao FTP do CNJ
3. Certifique-se que a configuração de transferência do FTP esteja setada para binário ou automático a fim de realizar a transferência do pacote de instalação corretamente
4. navegue até o diretório “pje_descanso”
5. baixe o arquivo compactado da versão mais recente

Sistema gerenciador do banco de dados

1. Instale a versão 9.1 do PostgreSQL e configure os arquivos postgresql.conf e pg_hba.conf
2. Crie as bases de dados “pje_versao” e “pje_versao_bin”, onde “versao” referencia o número da versão macro do sistema. Por exemplo: “pje_1_4” e “pje_1_4_bin”
3. Certifique-se que as bases de dados sejam criadas com as configurações exigidas para o correto funcionamento do sistema:

  • encoding: LATIN1
  • template: template0
  • collation: C
  • character type: C

4. Utilizando o comando psql, restaure as bases de dados “pje_versao_limpa.sql” e “pje_versao_limpa_bin.sql”, onde “versão” referencia o número da versão micro do sistema. Por exemplo: “pje_1_4_3_limpa.sql” e “pje_1_4_3_limpa_bin.sql”:

psql -U USUARIO -h SERVIDOR -d DATABASE -W < ARQUIVO, onde:

USUARIO - usuário de banco de dados com acesso a base criada
SERVIDOR - IP ou DNS do servidor que responde ao PostgreSQL
DATABASE - banco de dados criado para restauração do dump
ARQUIVO - caminho completo ou relativo para o arquivo SQL que contém a restauração

5. Execute o comando SQL de INSERT listado abaixo para especificar o CPF e o nome usuário administrador (admin). Atente para a necessidade de substituir os parâmetros <CPF> e <NOME> pelo número do CPF (com máscara) e o nome do detentor do documento.

INSERT INTO client.tb_pess_doc_identificacao
(  
  id_pessoa_doc_identificacao, 
  cd_tp_documento_identificacao, 
  nr_documento_identificacao, 
  dt_expedicao, 
  ds_nome_pessoa, 
  in_usado_falsamente, 
  in_ativo, 
  ds_orgao_expedidor, 
  id_estado_expedidor, 
  id_pessoa, 
  in_principal, 
  dt_usado_falsamente, 
  id_pais, 
  id_usuario_cadastrador
)
VALUES 
(
  nextval('client.sq_tb_pessoa_doc_identificacao'), 
  'CPF', 
  '<CPF>', 
  NULL, 
  '<NOME>', 
  'N', 
  'S',
  'Secretaria da Receita Federal', 
  NULL, 
  1, 
  'S',
  NULL, 
  NULL, 
  NULL
);

Servidor de aplicação

1. Instale o servidor JBoss Application Server 5.1.0, descompactando o arquivo de instalação jboss-5.1.0.GA-jdk6, que se encontra disponível http://sourceforge.net/projects/jboss/files/JBoss/JBoss-5.1.0.GA/
2. Modifique o arquivo JBOSS_DIR/server/default/deployers/seam.deployer/META-INF/seam-deployers-jboss-beans.xml, apagando ou comentando a linha que define o bean SeamMTMatcher
3. Modifique o arquivo JBOSS_DIR/server/default/deployers/jbossws.deployer/META-INF/standard-jaxws-client-config.xml, alterando o valor da propriedade chunksize de “2048” para “0”
4. Acrescente a biblioteca JAR do driver JDBC do PostgreSQL à pasta JBOSS_DIR/Server/default/lib
5. Certifique-se que o LOCALE do servidor de aplicações esteja corretamente configurado para PT_BR. Em servidores Linux RedHat, essa configuração é feita no atributo LANG do arquivo /etc/sysconfig/i18n (LANG=”pt_BR.UTF-8”)
6. Copie o arquivo PJE-ds.xml para a pasta JBOSS_DIR/Server/default/deploy e altere seu conteúdo para refletir as configurações de acesso às bases de dados instaladas
7. Descompacte o conteúdo do arquivo “pje.war” na pasta JBOSS_DIR/Server/default/deploy
8. O sistema estará disponível para acesso no endereço em que foi disponibilizado o servidor. Por exemplo: https://host/pje, onde “host” é o endereço do servidor.
9. Como ato final da instalação, acesse o endereço http://host/pje/pages/admin/reindex.seam para gerar os índices necessários à aplicação

Acesso ao serviço da Receita Federal

Importar o certificado digital para acesso à Receita através das instruções a seguir:

  1. salve o arquivo do certificado em algum diretório
  2. abra uma janela onde você possa executar comandos via linha de comando
  3. na pasta lib/security do java, renomeie o arquivo cacerts para um outro nome qualquer, por exemplo, cacerts_old
  4. execute o comando keytool -import -alias <alias> -file <certificado> -keystore <truststore>, onde <alias> é o apelido do certificado, <certificado> é o caminho onde o certificado foi salvo no passo 1 e <truststore> é o caminho de armazenamento dos certificados no java. Exemplo: keytool -import -alias cnj -file \tmp\www.cnj.jus.br.crt -keystore /usr/lib/jvm/java-6-openjdk-amd64/jre/lib/security/cacerts
   Concluído o procedimento de instalação do certificado digital do CNJ, envie e-mail ao grupo g-lideres.pje@cnj.jus.br, informando os endereços IPs de saída dos servidores de aplicação para acesso ao serviço de consulta da Receita Federal do Brasil. Após a confirmação de cadastro, certifique-se de que os IPs de saída estão de fato cadastrados no CNJ, acessando o endereço https://www.cnj.jus.br/testeReceitaFederal/wsdl/proxyReceita.wsdl, por meio da execução do comando WGET diretamente na máquina servidora da aplicação.


Configuração para uso do jcr-storage

  1. Baixar o projeto do git(git@git.cnj.jus.br:utilitarios/jcr-storage.git)
  2. Gerar o pacote "mvn clean package -DskipTests"
  3. Entrar na pasta do projeto jcr-storage/server/target para iniciar o serviço
    1. Executar o comando "nohup java -Xmx2048m -jar jcr-storage-server-xec.jar -httpPort 9000"
  4. Incluir as seguintes dependência pasta lib do jboss
    1. commons-io-1.4.jar
    2. commons-lang3-3.1.jar
    3. jcr-storage-client-x.x.x.jar
    4. jcr-storage-common-x.x.x.jar
  5. Criar o arquivo "jcr-storage.properties", dentro da mesma pasta das libs acima com os seguinte valores
    1. jcr.url=http://localhost:9000/storage/documents
    2. jcr.username=usuario
    3. jcr.password=senha
Ferramentas pessoais
Espaços nominais

Variantes
Ações
Navegação
Informações Gerais
Aplicativos PJe
Manuais
Suporte
Ferramentas