offapi/com/sun/star/xml/crypto/XDigestContextSupplier.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 get an object to generate a digest of a specified
  24     format.
  25
  26     @since OOo 3.4
  27  */
  28 interface XDigestContextSupplier : com::sun::star::uno::XInterface
  29 {
  30     /** returns an object that allows to generate the specified digest.
  31
  32         @param nDigestID
  33             the internal ID specifying the algorithm,
  34             should take value from DigestID
  35
  36         @param aParams
  37             optional parameters that could be used to initialize the digest,
  38             for example, it could contain a key and etc.
  39
  40         @throws ::com::sun::star::lang::IllegalArgumentException
  41             one of provided arguments is illegal
  42      */
  43     XDigestContext getDigestContext(
  44                 [in] long nDigestID,
  45                 [in] sequence< ::com::sun::star::beans::NamedValue > aParams )
  46         raises( ::com::sun::star::lang::IllegalArgumentException );
  47 };
  48
  49
  50 }; }; }; }; };
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */