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

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>

...

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

Servicios AdviceService

Método 'sendAdvice'

Método que manda un aviso utilizando el sistema de cola de sga para informar de algún cambio en un documento

...

title	Más detalles

Signatura

void sendAdvice(Integer noteType, String csv, String text, String userAdviser)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

ADVICESERVICEIMPL_SENDADVICE

...

Ejemplos de invocación

Code Block

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

String userNif = "12345678X";
DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setCsv("CSV6F70H2A66T1E01PFI");
Document document = iDocumentImpl.findDocument(documentSearch);

IAdviceService.sendAdvice(PFICoreConstants.NOTE_TYPE_PROPOSEDSIGNER, document.getCsv(), null, userNif);

Método 'sendMail'

Método que manda un correo electrónico de manera inmediata mediante sga para informar de algún cambio en un documento

...

title	Más detalles

Signatura

void sendMail(String fiscalAnagram, String asunto, String mensaje)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

ADVICESERVICEIMPL_SENDMAIL

...

Ejemplos de invocación

...

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

...

Servicios DocumentIntegrationService

...

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 8

New Version 9

Key

Inicialización del cliente mediante CXF

Servicios DocumentService

Servicios AdviceService

Método 'sendAdvice'

Método 'sendMail'

Servicios DocumentIntegrationService

Objeto
Anchor
ParamProposedSigner
ParamProposedSigner
'ParamProposedSigner'

Objeto
Anchor
ParamSendDocument
ParamSendDocument
'ParamSendDocument'

Page Comparison

Versions Compared

Old Version 8

New Version 9

Key

Inicialización del cliente mediante CXF

Servicios DocumentService

Servicios AdviceService

Método 'sendAdvice'

Método 'sendMail'

Servicios DocumentIntegrationService

Objeto AnchorParamProposedSignerParamProposedSigner'ParamProposedSigner'

Objeto AnchorParamSendDocumentParamSendDocument'ParamSendDocument'

Objeto
Anchor
ParamProposedSigner
ParamProposedSigner
'ParamProposedSigner'

Objeto
Anchor
ParamSendDocument
ParamSendDocument
'ParamSendDocument'