offapi/com/sun/star/xml/crypto/XXMLSignature.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XXMLSignature.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 //i20156 - new file for xmlsecurity module
  32
  33 /** -- idl definition -- **/
  34
  35 #ifndef __com_sun_star_xml_crypto_xxmlsignature_idl_
  36 #define __com_sun_star_xml_crypto_xxmlsignature_idl_
  37
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #include <com/sun/star/uno/SecurityException.idl>
  40
  41 #include <com/sun/star/xml/crypto/XXMLSignatureTemplate.idl>
  42 #include <com/sun/star/xml/crypto/XXMLSecurityContext.idl>
  43 #include <com/sun/star/xml/crypto/XMLSignatureException.idl>
  44
  45 module com { module sun { module star { module xml { module crypto {
  46
  47 /**
  48  * Interface of XML signature
  49  *
  50  * <p>This interface represents a xml signer or vertifier.</p>
  51  *
  52  * <p>The signer or vertifier concrete a key by retrieve signature context and
  53  * signature template.</p>
  54  *
  55  * <p>In some cases, the signer or vertifier can dertermine and locate the
  56  * contents to be signed from the signature template by dereference the URI.</p>
  57  *
  58  * <p>In some cases, the contents to be signed need to be clearly pointed out by
  59  * the signature template.</p>
  60  */
  61 interface XXMLSignature : com::sun::star::uno::XInterface
  62 {
  63     /**
  64      * Perform signature in the environment of signature template and context.
  65      */
  66     com::sun::star::xml::crypto::XXMLSignatureTemplate generate(
  67         [in] com::sun::star::xml::crypto::XXMLSignatureTemplate aTemplate ,
  68         [in] com::sun::star::xml::crypto::XSecurityEnvironment aEnvironment
  69     ) raises( com::sun::star::xml::crypto::XMLSignatureException ,
  70         com::sun::star::uno::SecurityException ) ;
  71
  72     /**
  73      * Perform validation in the environment of signature template and context.
  74      */
  75     com::sun::star::xml::crypto::XXMLSignatureTemplate validate(
  76         [in] com::sun::star::xml::crypto::XXMLSignatureTemplate aTemplate ,
  77         [in] com::sun::star::xml::crypto::XXMLSecurityContext aContext
  78     ) raises( com::sun::star::xml::crypto::XMLSignatureException ,
  79         com::sun::star::uno::SecurityException ) ;
  80
  81     /**
  82      * get the time used by the engine, JSR105,
  83      * this method is used for evaluation.
  84      */
  85      /*
  86     hyper getEngineTime([in] long id);
  87     */
  88 };
  89
  90 } ; } ; } ; } ; } ;
  91 #endif