es.juntadeandalucia.afirma.custody
Interface CustodyClient

All Known Implementing Classes:
CustodyClientImpl

public interface CustodyClient

Interfaz del componente afirma-custody-client.

El componente <afirma-custody-client> tiene como objetivo fundamental facilitar a los integradores el acceso a documentos y firmas en el módulo de Custodia de @Firma. Se trata de un componente software encargado de implementar toda la lógica necesaria relacionada con la mensajería y las comunicaciones (SOAP), ofreciendo a los integradores una interfaz sencilla y bien documentada.

Para poder obtener una instancia del componente es necesario que exista, en el CLASSPATH del sistema, el fichero afirma.properties y éste esté correctamente configurado.

Version:
Revision: $Rev: 19257 $
, Last modified: $Date: 2016-01-26 11:58:14 +0100 (mar, 26 ene 2016) $, Modified by: $Author: alejandro.roman $
Author:
Ernesto Salgado Suárez

Method Summary
 GetDocumentContentResponse getDocumentContent(String transactionId)
          Obtiene un documento almacenado en el módulo de Custodia de @Firma.
 GetDocumentContentResponse getDocumentContentByDocId(String docId)
          Obtiene un documento almacenado en el módulo de Custodia de @Firma.
 GetESignatureResponse getESignature(String transactionId)
          Obtiene una firma electrónica almacenada en el módulo de Custodia de @Firma
 

Method Detail

getDocumentContent

GetDocumentContentResponse getDocumentContent(String transactionId)
                                              throws CustodyException
Obtiene un documento almacenado en el módulo de Custodia de @Firma.

Parameters:
transactionId - identificador de transacción de la firma del documento
Returns:
objeto de tipo GetDocumentContentResponse
Throws:
CustodyException

getDocumentContentByDocId

GetDocumentContentResponse getDocumentContentByDocId(String docId)
                                                     throws CustodyException
Obtiene un documento almacenado en el módulo de Custodia de @Firma.

Parameters:
docId - identificador del documento custodiado
Returns:
objeto de tipo GetDocumentContentResponse
Throws:
CustodyException

getESignature

GetESignatureResponse getESignature(String transactionId)
                                    throws CustodyException
Obtiene una firma electrónica almacenada en el módulo de Custodia de @Firma

Parameters:
transactionId -
Returns:
objeto de tipo GetESignatureResponse
Throws:
CustodyException


Copyright © 2016. All rights reserved.