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_xciphercontext_idl_
28#define __com_sun_star_xml_crypto_xciphercontext_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_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_DisposedException_idl__
39#include <com/sun/star/lang/DisposedException.idl>
40#endif
41
42//============================================================================
43
44 module com {  module sun {  module star {  module xml { module crypto {
45
46//============================================================================
47/** This interface allows to encrypt/decrypt data using the cipher context.
48    <p>
49    The algorithm as well as encryption data are specified on object creation.
50    </p>
51
52    @see <type>XCipherContextSupplier</type>
53    @since OOo 3.4
54 */
55interface XCipherContext : com::sun::star::uno::XInterface
56{
57    //------------------------------------------------------------------------
58    /** encrypts/decrypts the data using the cipher.
59        <p>
60        Please have in mind, the cipher object state might depend from the
61        already encrypted/decrypted data ( it depends from the used
62        algorithm ).
63        </p>
64
65        <p>
66        Whether the object does encryption or decryption is specified by
67        creation of the object.
68        </p>
69
70        @param aData
71            data that should be encrypted/decrypted
72     */
73    sequence<byte> convertWithCipherContext( [in] sequence< byte > aData )
74        raises( ::com::sun::star::lang::IllegalArgumentException,
75                ::com::sun::star::lang::DisposedException );
76
77    //------------------------------------------------------------------------
78    /** finalizes cipher and disposes context.
79     */
80    sequence<byte> finalizeCipherContextAndDispose()
81        raises( ::com::sun::star::lang::DisposedException );
82};
83
84//============================================================================
85
86}; }; }; }; };
87
88#endif
89
90