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