En este apartado se explicarán los servicios de pfi y cómo inicializar su cliente java

ÍNDICE DEL CONTENIDO

Table of Contents

Inicialización del cliente mediante CXF

Mediante sintaxis xml podemos definir fácilmente la configuración del cliente CXF para que acceda a los servicios de PFI. Inicialmente deberemos definir la referencia a la interfaz del servicio, que se encuentra dentro del cliente suministrado, así como a la dirección a la que apunta el wsdl levantado.

Code Block

language	xml
theme	Eclipse
title	IDocumentIntegrationService

<simple:client id="pfiClient" 
			   serviceClass="es.aragon.pfi.core.ws.IDocumentIntegrationService" 
			   address="http://[entorno:puerto]/pfi_core/services/IDocumentIntegrationServiceWS"
			   serviceName="s:IDocumentIntegrationService" 
			   xmlns:s="http://ws.core.pfi.aragon.es/ "
		       endpointName="s:IDocumentIntegrationServiceWS"
>
	<simple:outInterceptors>
		<ref bean="authorizeInterceptor" />
	</simple:outInterceptors>
</simple:client>

...

Para ello, utilizando los denominados interceptores, es posible rellenar este valor automáticamente en todas las peticiones. Como se ve en la definición del cliente se ha definido un interceptor de salida que entra en funcionamiento en el momento de construir la petición SOAP y que inserta el valor del código de aplicación en los parámetros de todos los métodos de PFI invocados.

Code Block

language	xml
theme	Eclipse

<simple:outInterceptors>
	<ref bean="authorizeInterceptor" />
</simple:outInterceptors>

...

Code Block

language	xml
theme	Eclipse

<bean id="authorizeInterceptor" class="es.aragon.pfi.core.util.interceptors.AuthorizeOutInterceptor">
	<property name="applicationId" value="[código aplicación llamante]"/>
</bean>

-

Capturar notificaciones sobre cambios de estado en los documentos

Las aplicaciones integradoras deben definir un servlet al que invoque PFI cuando cambie el estado de un documento, no obstante, se puede consultar directamente al repositorio una vez que haya sido notificado el cambio para garantizar el último estado real.

No debe utilizarse la consulta directa al repositorio como mecanismo de control del estado de los documentos, ya que el número de llamadas recurrentes genera sobrecarga en los entornos, causando problemas tanto al propio integrador como al resto de los usuarios.

Dicho servlet se invocará con tres parámetros mediante querystring:

...

-

Info
Para que PFI pueda invocar a dicha url, ésta debe estar asociada a la aplicación a través de la plataforma PAU, en el atributo responseUrl correspondiente a la aplicación. Para ello el integrador deberá completar primero el 1241284867 descrito previamente en este manual.

-

Método 'findSignerByNif'

Método que busca un firmante atendiendo a unos parámetros de búsqueda establecidos en concreto se buscará el firmante que corresponde a un Nif

...

title	Más detalles

Signatura

Signer findSignerByNif(SignerSearch signerSearch)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

SignerSearch signerSearch = new SignerSearch();
signerSearch.setUserNif("78965412X");
Signer signer = iSignerImpl.findSignerByNif(signerSearch);

Método 'findProposedSigner'

Método que busca un firmante propuesto para un documento atendiendo a unos criterios de búsqueda

...

title	Más detalles

Signatura

ParamProposedSigner findProposedSigner(ParamProposedSignerSearch paramProposedSignerSearch)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSigner proposedSigner = iSignerImpl.findProposedSigner(paramProposedSignerSearch);

Método 'findProposedSignerList'

Método que busca la lista de firmantes propuestos según los criterios establecidos en el parámetro de entrada

...

title	Más detalles

Signatura

ParamProposedSignerList findProposedSignerList(ParamProposedSignerSearch paramProposedSignerSearch)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSignerList proposedSigner = iSignerImpl.findProposedSignerList(paramProposedSignerSearch);

Método 'saveProposedSigner'

Método que guarda en base de datos un firmante propuesto correspondiente a un documento

...

title	Más detalles

Signatura

ParamProposedSigner saveProposedSigner(ParamProposedSigner paramProposedSigner, Document document)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSigner proposedSigner = iSignerImpl.findProposedSigner(paramProposedSignerSearch);

DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setCsv("CSV6F70H2A66T1E01PFI");
Document document = iDocumentImpl.findDocument(documentSearch);

ParamProposedSigner result = iSignerImpl.saveProposedSigner(paramProposedSigner, document);

Método 'deleteProposedSigner'

Método que borra un firmante propuesto de un documento y reordena el resto de firmantes

...

title	Más detalles

Signatura

void deleteProposedSigner(ParamProposedSigner paramProposedSigner, Long documentId)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Ejemplos de invocación

...

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

...

En este apartado se explicarán los servicios de pfi y cómo inicializar su cliente java

ÍNDICE DEL CONTENIDO

Table of Contents

Inicialización del cliente mediante CXF

Mediante sintaxis xml podemos definir fácilmente la configuración del cliente CXF para que acceda a los servicios de PFI. Inicialmente deberemos definir la referencia a la interfaz del servicio, que se encuentra dentro del cliente suministrado, así como a la dirección a la que apunta el wsdl levantado.

Code Block

language	xml
theme	Eclipse
title	IDocumentIntegrationService

<simple:client id="pfiClient" 
			   serviceClass="es.aragon.pfi.core.ws.IDocumentIntegrationService" 
			   address="http://[entorno:puerto]/pfi_core/services/IDocumentIntegrationServiceWS"
			   serviceName="s:IDocumentIntegrationService" 
			   xmlns:s="http://ws.core.pfi.aragon.es/ "
		       endpointName="s:IDocumentIntegrationServiceWS"
>
	<simple:outInterceptors>
		<ref bean="authorizeInterceptor" />
	</simple:outInterceptors>
</simple:client>

Como se puede observar en la definición XML del cliente CXF, se deberán configurar las urls donde se ubica el servicio IDocumentIntegrationServiceWS, para ello habrá que sustituir entorno y puerto por los valores correctos.
Las aplicaciones que se integran con PFI deben proporcionar en todas las peticiones el código de aplicación.

Para ello, utilizando los denominados interceptores, es posible rellenar este valor automáticamente en todas las peticiones. Como se ve en la definición del cliente se ha definido un interceptor de salida que entra en funcionamiento en el momento de construir la petición SOAP y que inserta el valor del código de aplicación en los parámetros de todos los métodos de PFI invocados.

Code Block

language	xml
theme	Eclipse

<simple:outInterceptors>
	<ref bean="authorizeInterceptor" />
</simple:outInterceptors>

La definición al bean authotizeInterceptor que se incluye a continuación, permite indicarle el código de la aplicación, de esta manera el interceptor se encarga de establecer dicho valor en todos los parámetros de las llamadas a los servicios PFI. La clase con el interceptor de salida AuthorizeOutInterceptor se proporciona junto con el cliente de PFI.

Code Block

language	xml
theme	Eclipse

<bean id="authorizeInterceptor" class="es.aragon.pfi.core.util.interceptors.AuthorizeOutInterceptor">
	<property name="applicationId" value="[código aplicación llamante]"/>
</bean>

-

Capturar notificaciones sobre cambios de estado en los documentos

...

Las aplicaciones integradoras deben definir un servlet al que invoque PFI cuando cambie el estado de un documento, no obstante, se puede consultar directamente al repositorio una vez que haya sido notificado el cambio para garantizar el último estado real.

No debe utilizarse la consulta directa al repositorio como mecanismo de control del estado de los documentos, ya que el número de llamadas recurrentes genera sobrecarga en los entornos, causando problemas tanto al propio integrador como al resto de los usuarios.

Dicho servlet se invocará con tres parámetros mediante querystring:

Parámetro	Descripción
idApp	PFI
CSV	Identificador del documento que ha sufrido un cambio de estado
estado	Estado en que se ha quedado el documento, borrador(1) u original(0)

-

Info
Para que PFI pueda invocar a dicha url, ésta debe estar asociada a la aplicación a través de la plataforma PAU, en el atributo responseUrl correspondiente a la aplicación. Para ello el integrador deberá completar primero el 1241284867 descrito previamente en este manual.

-

Servicios DocumentService

...

Expand

title	Más detalles

Signatura

Document findDocument(DocumentSearch documentSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
documentSearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
document	1241284867	Documento encontrado según el criterio de búsqueda proporcionada

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENT_02	Error genérico durante el servicio findDocument

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setCsv("CSV6F70H2A66T1E01PFI");
Document document = iDocumentImpl.findDocument(documentSearch);

...

Expand

title	Más detalles

Signatura

List<Document> findDocumentList(DocumentSearch documentSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
documentSearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
documentList	List<1241284867>	Lista de documentos encontrados según los parámetros de búsqueda indicados

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTLIST_01	Error genérico durante el servicio findDocumentList
DOCUMENTSERVICEIMPL_FINDDOCUMENTLIST_02	Error genérico durante el servicio findDocumentList

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setState(2);
List<Document> documentList = iDocumentImpl.findDocumentList(documentSearch);

...

Expand

title	Más detalles

Signatura

ResultTrayList findDocumentTray(ParamTraySearch paramTraySearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramTraySearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultTrayList	ResultTrayList	Lista de documentos para la bandeja que cumplen los criterios de búsqueda

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTTRAY	Error genérico durante el servicio findDocumentTray
FIND_DOCUMENT_LIST	Error al buscar los documentos en bbdd

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamTraySearch paramTraySearch = new ParamTraySearch();
paramTraySearch.setDraft(true);
ResultTrayList resultTrayList = iDocumentImpl.findDocumentTray(paramTraySearch);

...

Expand

title	Más detalles

Signatura

ResultTrayListVisibility findDocumentTrayVisibility(ParamTraySearch paramTraySearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramTraySearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultTrayListVisibility	ResultTrayListVisibility	Lista de documentos para la bandeja que cumplen los criterios de búsqueda con información de visibilidad

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTTRAY	Error genérico durante el servicio findDocumentTrayVisibility
PAUINTEGRATION_PROCEDURELISTBYUSER	Error en el sistema de autentificación. Se ha producido el siguiente error al buscar la lista de procedimientos del usuario desde PAU
FIND_DOCUMENT_LIST	Error al buscar los documentos en bbdd

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamTraySearch paramTraySearch = new ParamTraySearch();
paramTraySearch.setDraft(true);
ResultTrayListVisibility resultTrayListVisibility = iDocumentImpl.findDocumentTrayVisibility(paramTraySearch);

...

Expand

title	Más detalles

Signatura

List<ParamFolder> findDocumentFolderList(DocumentSearch document)

Parámetros de invocación

Nombre	Tipo	Descripción
document	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
paramFolder	List<ParamFolder>	Error inesperado al buscar los diferentes folder a los que pertenecen los documentos

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTFOLDERLIST	Error genérico durante el servicio findDocumentFolderList
NOT_EXIST_DOCUMENT

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

DocumentMetadataSearch documentMetadataSearch = new DocumentMetadataSearch();

...

Expand

title	Más detalles

Signatura

signDocument(ParamSignDocument paramSignDocument)

Parámetros de invocación

Nombre	Tipo	Descripción
paramSignDocument	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_01	Error al firmar el documento porque ya esta en uso o superado la fecha de firma
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_02	El proceso de firma ha superado la fecha de firma del documento. Por favor, inténtelo de nuevo
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_03	No se puede actualizar el contenido porque ya está en uso
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_04	No se puede cambiar el estado porque ya está en uso
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_05	Error si se trata de firma simple simpre queda firmado, situacion imposible
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_06	No se puede guardar la firma en el documento porque ya está en uso

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamSignDocument paramSignDocument = new ParamSignDocument();
paramSignDocument.setCsv("CSV6F70H2A66T1E01PFI");
iDocumentImpl.signDocument(paramSignDocument);

...

Expand

title	Más detalles

Signatura

Document saveDocument(Document document)

Parámetros de invocación

Nombre	Tipo	Descripción
document	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
document	1241284867	El documento resultante de la operación

Códigos error

Código	Descripción
PARSE_CREATE_BLOB	No se ha podido crear el objeto de base de datos para el binario correspondiente
UTILSCORE_GENERATETEMPORALDOCUMENT_01	Error al generar el documento temporal
UTILSCORE_GENERATETEMPORALDOCUMENT_02	Error al generar el documento temporal
DOCUMENTSERVICEIMPL_SAVEDOCUMENT	Error genérico durante el método saveDocument

Code Block

language	java
theme	Eclipse
title	Ejemplo de invocación
collapse	true

	System.out.println("- PRUEBA 1.1: GUARDAR UN DOCUMENTO Pendiente de firma CON CSV");
		Document document = createNewDocument(Integer.parseInt(EstadoPFI.PENDIENTE_DE_FIRMA), null);
		document.setSaveFile(true);
		try {
			System.out.println("Guardar el documento");
			System.out.println("CSV: " + document.getCsv());
			document = documentServiceWS.saveDocument(document);

			System.out.println("Documento guardado");
		} catch (InternalCoreException e) {
			System.out.println("Error al guardar el documento con csv " + document.getCsv());
			System.out.println("Error: " + e.getMsg());

		}
	public es.aragon.pfi.core.ws.data.Document createNewDocument(Integer state, String csv) {
		es.aragon.pfi.core.ws.data.Document document = new es.aragon.pfi.core.ws.data.Document();
		if (csv == null) {
			document.setCsv(Utils.obtenerCSV());
		} else {
			document.setCsv(csv);
		}
		ParamFile paramFile = new ParamFile();
		paramFile.setContent(new DataHandler(new FileDataSource(new File("./src/main/resources/pdf.pdf"))));
		paramFile.setFileName("test.pdf");
		paramFile.setFileSize(new Long(1024));
		paramFile.setFileGenerated(new DataHandler(new FileDataSource(new File("./src/main/resources/pdf.pdf"))));
		paramFile.setFileGeneratedDate(new Date());
		document.setFile(paramFile);
		document.setFolder("testFolder");
		document.setPriority(Integer.parseInt(PFICoreConstants.PRIORITY_MEDIUM));
		document.setRejected(PFICoreConstants.DOCUMENT_NOREJECTED);
		document.setSignType(1);
		// XXX: contemplar la creación de un propose_signer con la posición
		// document.setSignaturePosition(PFICoreConstants.SIGNATURE_POS_NOSIGN);
		document.setState(state);
		document.setMetadataCache(createMetadataCache());
		return document;
	}

	public static Map<ParamMetadataId, ParamMetadata> createMetadataCache() {
		Map<ParamMetadataId, ParamMetadata> metadataCache = new HashMap<ParamMetadataId, ParamMetadata>();
		// Se crea el firmante propuesto
		ParamMetadata paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.SIGNER_ENTITY);
		paramMetadata.setMetadataName("agente_desc_nombre");
		paramMetadata.setMetadataValue("LUCIA CASPE - CADUCADO PRUEBAS AUTOMATIZADAS");
		ParamMetadataId paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.SIGNER_ENTITY);
		paramMetadata.setMetadataName("agente_ident_identificacion");
		paramMetadata.setMetadataValue("96666666N");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea el preparador
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.ISSUER_ENTITY);
		paramMetadata.setMetadataName("agente_desc_nombre");
		paramMetadata.setMetadataValue("LUCIA CASPE - CADUCADO PRUEBAS AUTOMATIZADAS");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.SIGNER_ENTITY);
		paramMetadata.setMetadataName("agente_ident_identificacion");
		paramMetadata.setMetadataValue("96666666N");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea la fecha de captura
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_ident_fecha_captura");
		paramMetadata.setMetadataValue(Utils.fechaISO86012004(new Date()));
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea la descripción
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_desc_descripcion");
		paramMetadata.setMetadataValue("Documento de test");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea el procedimiento
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_cont_nom_procedimiento");
		paramMetadata.setMetadataValue("AYUDA A LOS CONTRATOS AGRARIOS");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_cont_codprocedimiento");
		paramMetadata.setMetadataValue("404");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea el tipo de documento
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_desc_tipo_documento");
		paramMetadata.setMetadataValue("ACUERDO");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		// Se crea el estado y el origen
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_desc_estado");
		paramMetadata.setMetadataValue("0");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		paramMetadata = new ParamMetadata();
		paramMetadata.setEntity(PFICoreConstants.DOCUMENT_ENTITY);
		paramMetadata.setMetadataName("dea_ident_origen");
		paramMetadata.setMetadataValue("1");
		paramMetadataId = new ParamMetadataId();
		paramMetadataId.setMetadataName(paramMetadata.getMetadataName());
		paramMetadataId.setEntity(paramMetadata.getEntity());
		metadataCache.put(paramMetadataId, paramMetadata);
		return metadataCache;
	}

...

Expand

title	Más detalles

Signatura

findMetadataValue(ParamMetadata paramMetadata)

Parámetros de invocación

Nombre	Tipo	Descripción
paramMetadata	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
value	String	El valor de metadato encontrado

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDMETADATAVALUE	Error genérico durante el servicio findMetadataValue

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamMetadata paramMetadata = new ParamMetadata();
paramMetadata.setMetadataName("metatada-name");
String value = iDocumentImpl.findMetadataValue(paramMetadata);

...

Expand

title	Más detalles

Signatura

Integer getDocumentState(ParamGetDocumentState paramGetDocumentState)

Parámetros de invocación

Nombre	Tipo	Descripción
paramGetDocumentState	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre

Tipo

Descripción

state

Integer

Numero de estado correspondiente en porta-firmas:

6 → En paralelo

4 → Anulado

3 → Firma Programada

2 → Firmado

1 → Pendiente de firma

0 → Borrador

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_GETDOCUMENTSTATE	Error genérico durante el servicio getDocumentState
FIND_DOCUMENT	Error inesperado al buscar un documento
DOCUMENTMANAGERIMPL_FINDDOCUMENT	Error buscando documento

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamGetDocumentState paramGetDocumentState = new ParamGetDocumentState();
paramGetDocumentState.setCsv("CSVP55RYQS7R9AF01PFI");
Integer documentState = IDocumentService.getDocumentState(paramGetDocumentState);

...

Expand

title	Más detalles

Signatura

void setDocumentState(ParamSetDocumentState paramSetDocumentState)

Parámetros de invocación

Nombre	Tipo	Descripción
paramSetDocumentState	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_SIGNDOCUMENT_03	No se puede actualizar el contenido porque ya está en uso
DOCUMENTSERVICEIMPL_SETDOCUMENTSTATE	Error genérico durante el metodo setDocumentState
DOCUMENTMANAGERIMPL_FINDDOCUMENTLIST	Error inesperado al buscar una lista de documentos

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamSetDocumentState paramSetDocumentState = new ParamSetDocumentState();
paramSetDocumentState.setCsv("CSVP55RYQS7R9AF01PFI");
paramSetDocumentState.setState(0);
IDocumentService.setDocumentState(paramGetDocumentState);

...

Expand

title	Más detalles

Signatura

ResultGetOperation getOperation(ParamGetOperation paramGetOperation)

Parámetros de invocación

Nombre	Tipo	Descripción
paramGetOperation	ParamGetOperation	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultGetOperation	ResultGetOperation	Objeto que encapsula el resultado de la operación

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_GETOPERATION	Error genérico durante el servicio getOperation
SCDEINTEGRATION_GETSTATUS	Error al comprobar el estado de la operacion
LOAD_OPERATION	Error buscando operación. El usuario no tiene permisos para ver la operación
FIND_OPERATION	Error buscando operación

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamGetOperation paramGetOperation = new ParamGetOperation();
paramGetOperation.setDocumentId(1L);
ResultGetOperation resultGetOperation = IDocumentService.getOperation(paramGetOperation);

...

Expand

title	Más detalles

Signatura

ResultSendDocument sendDocumentumDocument(ParamSendDocument paramSendDocument)

Parámetros de invocación

Nombre	Tipo	Descripción
paramSendDocument	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultSendDocument	1241284867	Objeto que encapsula el resultado de la operación, proporcionado información en caso de error

Códigos error

Código	Descripción
DOCUMENTINTEGRATIONMANAGERIMPL_SENDDOCUMENTUMDOCUMENT	Error inesperado al crear un documento en la tabla de PFI_DOCUMENT
DOCUMENTMANAGERIMPL_FINDDOCUMENT	Error inesperado al buscar un documento
LOAD_DOCUMENT	Error cargando documentos
SIUINTEGRATION_SENDPROPOSEDSIGNERS	Error en el sistema de identificación. El firmante propuesto debe estar dado de alta en el sistema de identificación de usuarios (SIU)

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamSendDocument paramSendDocument = new ParamSendDocument();
paramSendDocument.setCsv("CSVDA6FLBW3PNAX01PFI");
paramSendDocument.setApplicationId("PFI");
paramSendDocument.setUserNif("00000000T");
ResultSendDocument resultSendDocument = iDocumentIntegrationImpl.sendDocumentumDocument(paramSendDocument);

...

Expand

title	Más detalles

Signatura

ResultUpdateQuorumAndLimitDate updateQuorumAndLimitDateDocument (ParamUpdateQuorumAndLimitDate paramUpdateQuorumAndDate)

Parámetros de invocación

Nombre	Tipo	Descripción
paramUpdateQuorumAndDate	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultUpdateQuorum	1241284867	Objeto que encapsula el resultado de la operación, proporcionado información en caso de error

Códigos error

Código	Descripción
QUORUMTASK_DOCUMENTNONEXISTING	El documento con el CSV especificado no existe en la base de datos de PFI
QUORUMTASK_QUORUMWRONG	El valor de quorum indicado es incorrecto. Debe ser mayor que 0 y menor o igual que el número de firmantes propuestos del documento
QUORUMTASK_DATEWRONG	La fecha límite de firma del documento ha expirado
QUORUMTASK_NOMULTIFIRMA	El documento no es multifirma
QUORUMTASK_SIGNED	El documento ya ha sido firmado por alguno de los firmantes

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamUpdateQuorumAndLimitDate paramUpdateQuorumAndDate = new ParamUpdateQuorumAndLimitDate();
paramUpdateQuorumAndDate.setCsv("CSVP55RYQS7R9AF01PFI");
paramUpdateQuorumAndDate.setQuorum(2);
//queremos de fecha límite por ejemplo el día de hoy más una semana
Calendar cal = Calendar.getInstance();
cal.setTime(new Date());
Integer incFecha = 7;
cal.add(Calendar.DATE, incFecha);
paramCheckQuorumAndDate.setDate(cal.getTime());
paramCheckQuorumAndDate.setQuorumOnly(false);

ResultUpdateQuorumAndLimitDate resultCheckQuorumAndDate = iDocumentIntegrationImpl.updateQuorumAndLimitDateDocument(paramUpdateQuorumAndDate);

...

sendEvent → Método que informa sobre los cambios de estado de los documentos de PFI. Para poder recibir estos eventos de cambios de estado, los documentos deben tener asignado el alias de la aplicación receptora en el metadato dea_ident_codigo_aplicacion. De lo contrario, no se recibirán los eventos. El evento se compone de clave y valor. La clave es el CSV del documento y el valor es el estado del documento. Los cambios de estado que se notifican son los siguientes:
- Estado 3 (Firmando asíncronamente) → Estado al que se pasan los documentos al inicio del proceso de firma para indicar que se está realizando la firma del documento.
- Estado 6 (Firma paralela) → Se alcanza este estado cuando un documento tiene varios firmantes propuestos y alguno de ellos ya ha firmado pero todavía no se cumple el quorum.
- Estado 2 (Firmado) → Documento firmado.
- Estado 0 (Borrador) → Se recibe este evento cuando se rechaza un documento pendiente de firma.
- Estado 9 (Anulado) → Se recibe este evento cuando se anula un documento.

...

Objeto
Anchor
ParamProposedSigner
ParamProposedSigner
'ParamProposedSigner'

Nombre	Tipo	Descripción
proposedSignerId	Long	Id del firmante propuesto
signerNif	String	Nif del firmante propuesto
signerName	String	Nombre del firmante propuesto
signerDateFrom	String	Fecha de selección del firmante
signerOrder	String	Orden de firma del firmante propuesto
signaturePosition	String	Tipo de posición de los pies de firma
position	String	Coordenadas donde se ha colocado el pie de firma del firmante propuesto
delegationText	String	Texto de delegación del firmante propuesto
signed	String	Indica si el firmante propuesto ha firmando (1) o no (0)
signerOrgCode	String	Código de organismo del firmante propuesto
signerOrganism	String	Nombre de organismo del firmante propuesto
signerRole	String	Cargo del firmante propuesto
signerStatus	String	Condición del firmante
revised	String	Indica si el firmate propuesto ha sido revisado o no. Valores: S o N
deleteSign	Boolean	Indica si se ha de borrar la firma al actualizar el firmante propuesto

...

Objeto
Anchor
ParamSendDocument
ParamSendDocument
'ParamSendDocument'

Nombre	Tipo	Descripción
applicationId	String	Aplicación que ejecuta el método
userNif	String	Nif del usuario
csv	String	Código seguro de verificación del documento

...

Versions Compared

Old Version 6

New Version 7

Key

Inicialización del cliente mediante CXF

Capturar notificaciones sobre cambios de estado en los documentos

Método 'findSignerByNif'

Método 'findProposedSigner'

Método 'findProposedSignerList'

Método 'saveProposedSigner'

Método 'deleteProposedSigner'

Inicialización del cliente mediante CXF

Capturar notificaciones sobre cambios de estado en los documentos

Servicios DocumentService

Objeto
Anchor
ParamProposedSigner
ParamProposedSigner
'ParamProposedSigner'

Objeto
Anchor
ParamSendDocument
ParamSendDocument
'ParamSendDocument'

Page Comparison

Versions Compared

Old Version 6

New Version 7

Key

Inicialización del cliente mediante CXF

Capturar notificaciones sobre cambios de estado en los documentos

Método 'findSignerByNif'

Método 'findProposedSigner'

Método 'findProposedSignerList'

Método 'saveProposedSigner'

Método 'deleteProposedSigner'

Inicialización del cliente mediante CXF

Capturar notificaciones sobre cambios de estado en los documentos

Servicios DocumentService

Objeto AnchorParamProposedSignerParamProposedSigner'ParamProposedSigner'

Objeto AnchorParamSendDocumentParamSendDocument'ParamSendDocument'

Objeto
Anchor
ParamProposedSigner
ParamProposedSigner
'ParamProposedSigner'

Objeto
Anchor
ParamSendDocument
ParamSendDocument
'ParamSendDocument'