xref: /aoo42x/main/offapi/com/sun/star/xml/crypto/XCipherContext.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_xml_crypto_xciphercontext_idl_
#define __com_sun_star_xml_crypto_xciphercontext_idl_

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_lang_DisposedException_idl__
#include <com/sun/star/lang/DisposedException.idl>
#endif

//============================================================================

 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 <type>XCipherContextSupplier</type>
    @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