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#ifndef __com_sun_star_xml_crypto_xciphercontextsupplier_idl_
28#define __com_sun_star_xml_crypto_xciphercontextsupplier_idl_
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_beans_NamedValue_idl__
35#include <com/sun/star/beans/NamedValue.idl>
36#endif
37
38#ifndef __com_sun_star_xml_crypto_XCipherContext_idl__
39#include <com/sun/star/xml/crypto/XCipherContext.idl>
40#endif
41
42#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
43#include <com/sun/star/lang/IllegalArgumentException.idl>
44#endif
45
46//============================================================================
47
48 module com {  module sun {  module star {  module xml { module crypto {
49
50//============================================================================
51/** This interface allows to get an object that allows to encrypt/decrypt data
52    using the specified algorithm.
53
54    @since OOo 3.4
55 */
56interface XCipherContextSupplier : com::sun::star::uno::XInterface
57{
58    //------------------------------------------------------------------------
59    /** returns an object that allows to encrypt/decrypt data.
60
61        @param nCipherID
62            the internal ID specifying the algorithm,
63            should take value from <type>CipherID</type>
64
65        @param aKey
66            the key that should be used for the encryption
67
68        @param aInitializationVector
69            the initialization vector that should be used for the encryption
70
71        @param bEncryption
72            whether an encryption or decryption cipher should be created
73            <TRUE/> - Encryption
74            <FALSE/> - Decryption
75
76        @param aParams
77            optional parameters that could be used to initialize the cipher,
78
79        @throws ::com::sun::star::lang::IllegalArgumentException
80            one of provided arguments is illegal
81     */
82
83    XCipherContext getCipherContext( [in] long nCipherID, [in] sequence< byte > aKey, [in] sequence< byte > aInitializationVector, [in] boolean bEncryption, [in] sequence< ::com::sun::star::beans::NamedValue > aParams )
84        raises( ::com::sun::star::lang::IllegalArgumentException );
85};
86
87//============================================================================
88
89}; }; }; }; };
90
91#endif
92