offapi/com/sun/star/xml/crypto/XCipherContext.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module xml { module crypto {
  22
  23 /** This interface allows to encrypt/decrypt data using the cipher context.
  24     <p>
  25     The algorithm as well as encryption data are specified on object creation.
  26     </p>
  27
  28     @see XCipherContextSupplier
  29     @since OOo 3.4
  30  */
  31 interface XCipherContext : com::sun::star::uno::XInterface
  32 {
  33     /** encrypts/decrypts the data using the cipher.
  34         <p>
  35         Please have in mind, the cipher object state might depend from the
  36         already encrypted/decrypted data ( it depends from the used
  37         algorithm ).
  38         </p>
  39
  40         <p>
  41         Whether the object does encryption or decryption is specified by
  42         creation of the object.
  43         </p>
  44
  45         @param aData
  46             data that should be encrypted/decrypted
  47      */
  48     sequence<byte> convertWithCipherContext( [in] sequence< byte > aData )
  49         raises( ::com::sun::star::lang::IllegalArgumentException,
  50                 ::com::sun::star::lang::DisposedException );
  51
  52     /** finalizes cipher and disposes context.
  53      */
  54     sequence<byte> finalizeCipherContextAndDispose()
  55         raises( ::com::sun::star::lang::DisposedException );
  56 };
  57
  58
  59 }; }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */