offapi/com/sun/star/xml/crypto/XXMLSecurityContext.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_xxmlsecuritycontext_idl_
  33 #define __com_sun_star_xml_crypto_xxmlsecuritycontext_idl_
  34
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #include <com/sun/star/security/SecurityInfrastructureException.idl>
  37
  38 #include <com/sun/star/xml/crypto/XSecurityEnvironment.idl>
  39
  40 module com { module sun { module star { module xml { module crypto {
  41
  42 /**
  43  * Interface of XML security context
  44  *
  45  * <p>This interface specifies a certain signature context. By signature
  46  * context, the signer or verifier retrieves key specification.</p>
  47  */
  48 interface XXMLSecurityContext : com::sun::star::uno::XInterface
  49 {
  50     /**
  51      * Add personal security environment , and return the index of the added env.
  52      */
  53     long addSecurityEnvironment( [in] XSecurityEnvironment aSecurityEnvironment
  54     ) raises( com::sun::star::security::SecurityInfrastructureException ) ;
  55
  56     /**
  57      * Get the number of security environments
  58      */
  59     long getSecurityEnvironmentNumber( ) ;
  60
  61     /**
  62      * Get personal security environment
  63      */
  64     com::sun::star::xml::crypto::XSecurityEnvironment getSecurityEnvironmentByIndex([in] long index ) ;
  65
  66     /**
  67      * An handy method to get the first personal security environment.
  68      * In xmlsec/nss, the first personal security environment should be the "internal slot"
  69      */
  70     com::sun::star::xml::crypto::XSecurityEnvironment getSecurityEnvironment( ) ;
  71
  72     /**
  73      * Get the ID of the internal security environment
  74      */
  75     long getDefaultSecurityEnvironmentIndex( ) ;
  76
  77     /**
  78      * set the ID of the internal security environment
  79      */
  80     void setDefaultSecurityEnvironmentIndex([in] long index ) ;
  81
  82 } ;
  83
  84 } ; } ; } ; } ; } ;
  85
  86 #endif
  87