offapi/com/sun/star/xml/crypto/XXMLSignatureTemplate.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: XXMLSignatureTemplate.idl,v $
  10  * $Revision: 1.5 $
  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_xxmlsignaturetemplate_idl_
  36 #define __com_sun_star_xml_crypto_xxmlsignaturetemplate_idl_
  37
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40
  41 #include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
  42 #include <com/sun/star/xml/crypto/XUriBinding.idl>
  43 #include <com/sun/star/xml/crypto/XXMLSecurityTemplate.idl>
  44
  45 module com { module sun { module star { module xml { module crypto {
  46
  47 /**
  48  * Interface of XML signature template
  49  *
  50  * <p>This interface represents a signature template, which is the same as the
  51  * desired xml signature element but some of the nodes may be empty. The empty
  52  * entities include digest value and signature value. Empty entities are not
  53  * allowed in a signature template when performing validation.</p>
  54  *
  55  * <p>In some cases, the signer or vertifier can dertermine and locate the
  56  * contents to be signed from the template by dereference the URI.</p>
  57  *
  58  * <p>With the help of signature context, the signer or verifier specifies the
  59  * key from the KeyInfo in the signature template.</p>
  60  *
  61  * Owner: Andrew Fan
  62  */
  63 interface XXMLSignatureTemplate : XXMLSecurityTemplate
  64 {
  65     /**
  66      * Get the target xml element, i.e. the element to be signed
  67      */
  68     sequence< com::sun::star::xml::wrapper::XXMLElementWrapper > getTargets(
  69     ) ;
  70
  71     /**
  72      * Set the dynamic URI binding
  73      */
  74     void setBinding(
  75         [in] com::sun::star::xml::crypto::XUriBinding aUriBinding
  76     ) raises( com::sun::star::lang::IllegalArgumentException ) ;
  77
  78     /**
  79      * Get the dynamic URI binding
  80      */
  81     com::sun::star::xml::crypto::XUriBinding getBinding( ) ;
  82 } ;
  83
  84 } ; } ; } ; } ; } ;
  85
  86
  87 #endif
  88