client-exemple-pci

Client d'exemple pels integradors de la PCI.

El següent projecte presenta un client SOAP d'exemple pels integradors que permet consumir els diferents serveis de l'AOC. Per a més informació sobre la integració podeu consultar la documentació genèrica de la PCI (Plataforma de Col·laboració Interadministrativa): https://github.com/ConsorciAOC/PCI

Addicionalment, per integrar-se amb els diferents serveis del Consorci, podreu consultar la documentació específica de cada un accedint al projecte concret que trobareu a: https://consorciaoc.github.io/

Requisits

Java

Per poder compilar i utilitzar el codi serà necessari utilitzar la JDK 17 (o superior) de java.

• jdk17: https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html

Gradle

El projecte incorpora un wrapper de gradle (gradle/wrapper) i uns fitxers executables (./gradlew) per poder fer servir el gestor sense necessitat de tenir-lo instal·lat.

Si es desitja instal·lar gradle en local: https://gradle.org/install/

Dades CAOC

Per consumir els serveis del CAOC necessitareu haver estat donats d'alta als nostres entorns prèviament. Podeu sol·licitar l'alta a través del nostre portal: https://www.aoc.cat/serveis/

Amb l'alta se us assignaran permisos per consumir els serveis demanats i necessitareu:

• Codi del servei
• Codi de la modalitat
• Codi de la finalitat
• El certificat digital amb el qual signareu les peticions XML (XMLDSIG)
• Executar el codi des d'un ordinador que la seva IP hagi estat habilitada.

Primeres passes

Configurar el certificat

Per tal que el client funcioni, necessitareu configurar el vostre certificat de signatura al fitxer src/main/resources/keystore.properties

• org.apache.ws.security.crypto.provider: Proveïdor usat per crear instàncies criptogràfiques.
• org.apache.ws.security.crypto.merlin.keystore.alias: Àlies del certificat digital.
• org.apache.ws.security.crypto.merlin.keystore.type: Format del certificat.
• org.apache.ws.security.crypto.merlin.keystore.password: Contrasenya del certificat.
• org.apache.ws.security.crypto.merlin.keystore.file: Ruta del fitxer.

Generació de codi JAXB

El projecte incorpora una sèrie d'XSD's tant de la PCI (part genèrica) com dels diferents serveis (part específica) sota el directori: src/main/resources/xsd

Per tal de convertir els esquemes a classes java es fan servir llibreries de JAXB i s'ha configurat una tasca gradle anomenada jaxb que realitza el procés automàticament. Per executar la tasca:

gradlew jaxb

La compilació del projecte java depèn d'aquesta tasca, per tant, cada cop que es necessiti compilar quelcom s'executarà abans la taca jaxb mencionada. Si desitgeu eliminar aquesta dependència per agilitzar les builds, podeu comentar la següent línia al fitxer build.gradle:

compileJava.dependsOn jaxb

Exemple d'ús

Podeu fer servir el projecte clonant el mateix repositori, compilant-lo i testejant-lo o podeu descarregar el jar generat amb l'última versió directament de github: https://github.com/ConsorciAOC/client-exemple-pci/releases/latest

A continuació veureu una crida d'exemple pel servei e-NOTUM

// Obtenir el client del servei desitjat
ClientPCI client = Serveis.ENOTUM.getClient(Entorn.PRE, Frontal.SINCRON);

// Construir una petició d'exemple
Properties clientProperties = PropertiesReader.load("src/main/resources/client.properties");
Peticion peticion = new PeticionBuilderEnotum(clientProperties).build(OperacioEnotum.CERCA, Finalitat.PROVES);
  
// Enviar una petició d'exemple
client.send(peticion);

Més exemples

Podreu trobar més exemples dels diferents serveis sota l'apartat de test del projecte.

⚠️ Els tests poden estar acoblats a les dades informades al fitxer client.properties, si canvieu el requeridor (codi INE10) que s'informa les peticions, per exemple, és possible que el resultat no sigui l'esperat.