Package es.juntadeandalucia.afirma.client

Interface AfirmaClient

All Known Implementing Classes:
AfirmaClientImpl
public interface AfirmaClient
Interfaz del componente afirma-dss-client.

El componente <afirma-dss-client> tiene como objetivo fundamental facilitar a los integradores la adopción de los nuevos servicios DSS disponibles en la plataforma @Firma. Se trata de un componente software encargado de implementar toda la lógica necesaria relacionada con la mensajería (basada en los estándares DSS de OASIS) 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 (estableciendo al menos los parámetros obligatorios).

Es importante destacar que existen métodos sobrecargados en esta interfaz que suprimen ciertos parámetros como son signatureType, xmlSignatureMode... entre otros. Estos métodos sobrecargados (cuya motivación no va más allá de aumentar la simplicidad en el código) extraen dichos parámetros de afirma.properties.
Version:
Revision: $Rev: 16955 $
, Last modified: $Date: 2021-06-21 18:32:32 +0200 (Mon, 21 Jun 2021) $, Modified by: $Author: miguelangel.ager $
Author:
Ernesto Salgado Suárez

  • Method Details

    • dssAfirmaSign

      SignResponse dssAfirmaSign(String document) throws AfirmaException
      Servicio de Firma Delegada que permite la realización de operaciones de firma de servidor en los formatos soportados por la plataforma.
      Parameters:
      document - Cadena de texto con el contenido del documento a firmar codificado en Base64
      Returns:
      Objeto de tipo SignResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error en la petición

    • dssAfirmaSign

      SignResponse dssAfirmaSign(String document, String aliasCertificadoFirma) throws AfirmaException
      Servicio de Firma Delegada que permite la realización de operaciones de firma de servidor en los formatos soportados por la plataforma.
      Parameters:
      document - Cadena de texto con el contenido del documento a firmar codificado en Base64
      aliasCertificadoFirma - identificador o alias del certificado que va a realizar la firma delegada
      Returns:
      Objeto de tipo SignResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error en la petición

    • dssAfirmaSign

      SignResponse dssAfirmaSign(String document, AfirmaClient.SignatureType signatureType, AfirmaClient.XmlSignatureMode xmlSignatureMode, AfirmaClient.SignatureForm signatureForm) throws AfirmaException
      Servicio de Firma Delegada que permite la realización de operaciones de firma de servidor en los formatos soportados por la plataforma.
      Parameters:
      document - Cadena de texto con el contenido del documento a firmar codificado en Base64
      signatureType - Tipo de firma electrónica
      xmlSignatureMode - Modalidad de la firma en caso de firmas XML
      signatureForm - Formato de firma avanzada
      Returns:
      Objeto de tipo SignResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error en la petición

    • dssAfirmaSign

      SignResponse dssAfirmaSign(String document, AfirmaClient.SignatureType signatureType, AfirmaClient.XmlSignatureMode xmlSignatureMode, AfirmaClient.SignatureForm signatureForm, String aliasCertificadoFirma) throws AfirmaException
      Servicio de Firma Delegada que permite la realización de operaciones de firma de servidor en los formatos soportados por la plataforma.
      Parameters:
      document - Cadena de texto con el contenido del documento a firmar codificado en Base64
      signatureType - Tipo de firma electrónica
      xmlSignatureMode - Modalidad de la firma en caso de firmas XML
      signatureForm - Formato de firma avanzada
      aliasCertificadoFirma - identificador o alias del certificado que va a realizar la firma delegada
      Returns:
      Objeto de tipo SignResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error en la petición

    • dssAfirmaCoSign

      SignResponse dssAfirmaCoSign(String documentArchiveId) throws AfirmaException
      Servicio de Firma Delegada que permite la realización de operaciones de cofirma de servidor en los formatos soportados por la plataforma.
      Parameters:
      documentArchiveId - Valor del identificador de transacción origen
      Returns:
      Objeto de tipo SignResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error en la petición

    • dssAfirmaCoSign

      SignResponse dssAfirmaCoSign(String documentArchiveId, String aliasCertificadoFirma) throws AfirmaException
      Servicio de Firma Delegada que permite la realización de operaciones de cofirma de servidor en los formatos soportados por la plataforma.
      Parameters:
      documentArchiveId - Valor del identificador de transacción origen
      aliasCertificadoFirma - identificador o alias del certificado que va a realizar la firma delegada
      Returns:
      Objeto de tipo SignResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error en la petición

    • dssAfirmaCounterSign

      SignResponse dssAfirmaCounterSign(String documentArchiveId) throws AfirmaException
      Servicio de Firma Delegada que permite la realización de operaciones de contrafirma de servidor en los formatos soportados por la plataforma.
      Parameters:
      documentArchiveId - Valor del identificador de transacción origen
      Returns:
      Objeto de tipo SignResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error en la petición

    • dssAfirmaCounterSign

      SignResponse dssAfirmaCounterSign(String documentArchiveId, String aliasCertificadoFirma) throws AfirmaException
      Servicio de Firma Delegada que permite la realización de operaciones de contrafirma de servidor en los formatos soportados por la plataforma.
      Parameters:
      documentArchiveId - Valor del identificador de transacción origen
      aliasCertificadoFirma - identificador o alias del certificado que va a realizar la firma delegada
      Returns:
      Objeto de tipo SignResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error en la petición

    • dssAfirmaVerifyCertificate

      VerifyCertificateResponse dssAfirmaVerifyCertificate(String certificate) throws AfirmaException
      Servicio de validación de certificados que permite la verificación de certificados X509 finales.
      Parameters:
      certificate - Certificado a validar codificada en Base64
      Returns:
      Objeto de tipo VerifyCertificateResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaVerify

      VerifySignatureResponse dssAfirmaVerify(String sign) throws AfirmaException
      Servicio de validación de firmas que recibe como parámetro la firma.
      Parameters:
      sign - Firma electrónica codificada en Base64
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaVerify

      VerifySignatureResponse dssAfirmaVerify(String sign, AfirmaClient.SignatureType signatureType, AfirmaClient.XmlSignatureMode signatureMode) throws AfirmaException
      Servicio de validación de firmas que recibe como parámetro la firma, el tipo de firma y la modalidad de firma
      Parameters:
      sign - Firma electrónica codificada en Base64
      signatureType - Tipo de firma electrónica
      signatureMode - Modalidad de la firma en caso de firmas XML
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaVerify

      VerifySignatureResponse dssAfirmaVerify(String sign, String document, String hashDocument) throws AfirmaException
      Servicio de validación de firmas que recibe como parámetro la firma y el documento o el hash del documento (uno de los dos).
      Parameters:
      sign - Firma electrónica codificada en Base64
      document - Datos originalmente firmados codificados en Base64
      hashDocument - Hash de los datos originalmente firmados
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaVerify

      VerifySignatureResponse dssAfirmaVerify(String sign, String document, String hashDocument, String hashAlgorithm) throws AfirmaException
      Servicio de validación de firmas que recibe como parámetro la firma y el documento o el hash del documento (uno de los dos).
      Parameters:
      sign - Firma electrónica codificada en Base64
      document - Datos originalmente firmados codificados en Base64
      hashDocument - Hash de los datos originalmente firmados
      hashAlgorithm - algotimos de hash de los datos originalmente firmados
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaVerify

      VerifySignatureResponse dssAfirmaVerify(String sign, String document, String hashDocument, AfirmaClient.SignatureType signatureType, AfirmaClient.XmlSignatureMode signatureMode) throws AfirmaException
      Servicio de validación de firmas que recibe como parámetros la firma, el documento original o hash del documento (uno de los dos), el tipo de firma y la modalidad de firma.
      Parameters:
      sign - Firma electrónica codificada en Base64
      document - Datos originalmente firmados codificados en Base64
      hashDocument - Hash de los datos originalmente firmados
      signatureType - Tipo de firma electrónica
      signatureMode - Modalidad de la firma en caso de firmas XML
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaVerifyExtended

      VerifySignatureResponse dssAfirmaVerifyExtended(String sign, String document, String hashDocument, String hashAlgorithm, AfirmaClient.SignatureType signatureType, AfirmaClient.XmlSignatureMode signatureMode) throws AfirmaException
      Servicio de validación de firmas extendido que recibe como parámetros la firma, el documento original o hash del documento (uno de los dos), el tipo de firma y la modalidad de firma.
      Parameters:
      sign - Firma electrónica codificada en Base64
      document - Datos originalmente firmados codificados en Base64
      signatureType - Tipo de firma electrónica
      signatureMode - Modalidad de la firma en caso de firmas XML
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaUpgrade

      VerifySignatureResponse dssAfirmaUpgrade(String sign) throws AfirmaException
      Servicio de validación de firmas que actualiza la firma enviada como parámetro.
      Parameters:
      sign - Firma electrónica codificada en Base64
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaUpgrade

      VerifySignatureResponse dssAfirmaUpgrade(String sign, String targetSigner) throws AfirmaException
      Servicio de validación de firmas que actualiza la firma enviada como parámetro al formato indicado en el parámetro targetSigner
      Parameters:
      sign - Firma electrónica codificada en Base64
      targetSigner - Certificado en base64 del firmante que será actualizado
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaUpgrade

      VerifySignatureResponse dssAfirmaUpgrade(String sign, AfirmaClient.SignatureType signatureType, AfirmaClient.XmlSignatureMode signatureMode, AfirmaClient.SignatureForm signatureForm) throws AfirmaException
      Servicio de validación de firmas que actualiza la firma enviada como parámetro al formato indicado en el parámetro signatureForm
      Parameters:
      sign - Firma electrónica codificada en Base64
      signatureType - Tipo de firma electrónica
      signatureMode - Modalidad de la firma en caso de firmas XML
      signatureForm - Formato de firma a actualizar
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaUpgrade

      VerifySignatureResponse dssAfirmaUpgrade(String sign, AfirmaClient.SignatureType signatureType, AfirmaClient.XmlSignatureMode signatureMode, AfirmaClient.SignatureForm signatureForm, String targetSigner) throws AfirmaException
      Servicio de validación de firmas que actualiza un firmante concreto de la firma al formato indicado en el parámetro signatureForm
      Parameters:
      sign - Firma electrónica codificada en Base64
      signatureType - Tipo de firma electrónica
      signatureMode - Modalidad de la firma en caso de firmas XML
      signatureForm - Formato de firma a actualizar
      targetSigner - Certificado en base64 del firmante que será actualizado
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaUpgrade

      VerifySignatureResponse dssAfirmaUpgrade(String transactionId, AfirmaClient.SignatureForm signatureForm) throws AfirmaException
      Servicio de validación de firmas que actualiza la firma cuyo identificador de transacción se pasa como parámetro.
      Parameters:
      transactionId - Identificador de transacción de la firma electrónica custodiada
      signatureForm - Formato de firma a actualizar
      Returns:
      Objeto de tipo VerifySignatureResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaAsyncRequestStatus

      AsyncResponse dssAfirmaAsyncRequestStatus(String asyncResponseId) throws AfirmaException
      Servicio para la consulta del estado de peticiones asíncronas. Este servicio es independientemente del proceso asíncrono a consultar (firma, upgrade o validaciones en lote)
      Parameters:
      asyncResponseId - Identificador del Proceso Asíncrono
      Returns:
      Objeto de tipo AsyncResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error en la petición

    • dssAfirmaBatchVerifySignature

      BatchResponse dssAfirmaBatchVerifySignature(String requestId, List<VerifySignatureObject> verifySignatureObjectList, AfirmaClient.SignatureType signatureType, AfirmaClient.XmlSignatureMode xmlSignatureMode) throws AfirmaException
      Servicio de Validación Masiva de Firmas. Mediante este servicio se puede solicitar la verificación asíncrona de un conjunto de firmas.
      Parameters:
      requestId - Identificador alfanumérico que permite relacionar la petición con la respuesta asociada a la misma. Si la aplicación cliente incluye este atributo, la respuesta generada por el servidor incluirá de igual manera un atributo con el mismo valor en el elemento BatchResponse.
      verifySignatureObjectList - Lista de objetos que encapsulan los datos de una solicitud de validación de firma. VerifySignatureObject
      signatureType - Tipo de firma electrónica
      xmlSignatureMode - Modalidad de la firma en caso de firmas XML
      Returns:
      Objeto de tipo BatchResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • dssAfirmaBatchVerifyCertificate

      BatchResponse dssAfirmaBatchVerifyCertificate(String requestId, List<String> certificateList) throws AfirmaException
      Servicio de Validación Masiva de Certificados. Mediante este servicio se puede solicitar la verificación asíncrona de un conjunto de certificados.
      Parameters:
      requestId - Identificador alfanumérico que permite relacionar la petición con la respuesta asociada a la misma. Si la aplicación cliente incluye este atributo, la respuesta generada por el servidor incluirá de igual manera un atributo con el mismo valor en el elemento BatchResponse.
      certificateList - Lista de certificados codificados en Base64
      Returns:
      Objeto de tipo BatchResponse con los datos de la respuesta
      Throws:
      AfirmaException - En caso de error

    • hashDetector

      AfirmaClient.HashAlgorithm hashDetector(String signature) throws AfirmaException
      Detecta el algoritmo de hash con el que se generó el resumen de los datos de la firma
      Parameters:
      signature - Firma codificada en formato Base64
      Returns:
      HashAlgorithm Objeto de tipo enumerado que representa el algoritmo, posibles valores: SHA1, SHA256, SHA384, SHA512, MD2, MD5
      Throws:
      AfirmaException - En caso de error

    • separarApellidos

      String[] separarApellidos(String apellidos) throws AfirmaException
      Separa una cadena formada por dos apellidos en dos cadenas con cada uno de los apellidos.
      Parameters:
      apellidos - Cadena con los dos apellidos
      Returns:
      String[ ] Array de String con cada apellido por separado
      Throws:
      AfirmaException - En caso de error