summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/xml/crypto/XCipherContext.idl
blob: bae91c7b139de251dd7d855904c2a7dc8753810a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_xml_crypto_xciphercontext_idl_
#define __com_sun_star_xml_crypto_xciphercontext_idl_

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/lang/DisposedException.idl>


 module com {  module sun {  module star {  module xml { module crypto {

/** This interface allows to encrypt/decrypt data using the cipher context.
    <p>
    The algorithm as well as encryption data are specified on object creation.
    </p>

    @see XCipherContextSupplier
    @since OOo 3.4
 */
interface XCipherContext : com::sun::star::uno::XInterface
{
    /** encrypts/decrypts the data using the cipher.
        <p>
        Please have in mind, the cipher object state might depend from the
        already encrypted/decrypted data ( it depends from the used
        algorithm ).
        </p>

        <p>
        Whether the object does encryption or decryption is specified by
        creation of the object.
        </p>

        @param aData
            data that should be encrypted/decrypted
     */
    sequence<byte> convertWithCipherContext( [in] sequence< byte > aData )
        raises( ::com::sun::star::lang::IllegalArgumentException,
                ::com::sun::star::lang::DisposedException );

    /** finalizes cipher and disposes context.
     */
    sequence<byte> finalizeCipherContextAndDispose()
        raises( ::com::sun::star::lang::DisposedException );
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */