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

   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
  28 //i20156 - new file for xmlsecurity module
  29
  30 /** -- idl definition -- **/
  31
  32 #ifndef __com_sun_star_xml_crypto_xseinitializer_idl_
  33 #define __com_sun_star_xml_crypto_xseinitializer_idl_
  34
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #include <com/sun/star/uno/Exception.idl>
  37
  38 module com { module sun { module star { module xml { module crypto {
  39
  40 interface XXMLSecurityContext;
  41
  42 /**
  43  * Interface to manipulate Security Environment
  44  */
  45 interface XSEInitializer : com::sun::star::uno::XInterface
  46 {
  47     /**
  48      * Creates a security context.
  49      *
  50      * @param certificateDatabase      the file or directory of the key materials
  51      * @return            the security context created
  52      */
  53     com::sun::star::xml::crypto::XXMLSecurityContext createSecurityContext(
  54         [in] string certificateDatabase);
  55
  56     /**
  57      * Frees a security context.
  58      *
  59      * @param securityContext      the security context to be freed
  60      */
  61     void freeSecurityContext([in] com::sun::star::xml::crypto::XXMLSecurityContext securityContext);
  62 };
  63
  64 } ; } ; } ; } ; } ;
  65
  66
  67 #endif
  68