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