offapi/com/sun/star/xml/crypto/XXMLEncryption.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: XXMLEncryption.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_xxmlencryption_idl_
  36 #define __com_sun_star_xml_crypto_xxmlencryption_idl_
  37
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #include <com/sun/star/uno/Exception.idl>
  40 #include <com/sun/star/uno/SecurityException.idl>
  41
  42 #include <com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl>
  43 #include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
  44 #include <com/sun/star/xml/crypto/XXMLSecurityContext.idl>
  45 #include <com/sun/star/xml/crypto/XMLEncryptionException.idl>
  46
  47
  48 module com { module sun { module star { module xml { module crypto {
  49
  50 /**
  51  * Interface of XML encryption
  52  *
  53  * <p>This interface represents a xml encrypter or decrypter.</p>
  54  *
  55  * <p>The encrypter or decrypter concrete a key by retrieve security context
  56  * and encryption template.</p>
  57  *
  58  * <p>In some cases, the encrypter or decrypter can dertermine and locate the
  59  * EncrytedKey from the encryption template by dereference the RetrievalMethod
  60  * inside EncryptedData.</p>
  61  *
  62  * <p>In some cases, the EncryptedKey need to be clearly pointed out by the
  63  * encryption template.</p>
  64  */
  65 interface XXMLEncryption : com::sun::star::uno::XInterface
  66 {
  67     /**
  68      * Perform encryption in the environment of encryption template and context.
  69      */
  70     com::sun::star::xml::crypto::XXMLEncryptionTemplate encrypt(
  71         [in] com::sun::star::xml::crypto::XXMLEncryptionTemplate aTemplate ,
  72         [in] com::sun::star::xml::crypto::XSecurityEnvironment aEnvironment
  73     ) raises( com::sun::star::xml::crypto::XMLEncryptionException ,
  74         com::sun::star::uno::SecurityException ) ;
  75
  76     /**
  77      * Perform decryption in the environment of encrytpion template and context.
  78      */
  79     com::sun::star::xml::crypto::XXMLEncryptionTemplate decrypt(
  80         [in] com::sun::star::xml::crypto::XXMLEncryptionTemplate aTemplate ,
  81         [in] com::sun::star::xml::crypto::XXMLSecurityContext aContext
  82     ) raises( com::sun::star::xml::crypto::XMLEncryptionException ,
  83         com::sun::star::uno::SecurityException ) ;
  84 } ;
  85
  86 } ; } ; } ; } ; } ;
  87
  88
  89 #endif
  90