offapi/com/sun/star/xml/crypto/XXMLSecurityContext.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 module com { module sun { module star { module xml { module crypto {
  21
  22 /**
  23  * Interface of XML security context
  24  *
  25  * <p>This interface specifies a certain signature context. By signature
  26  * context, the signer or verifier retrieves key specification.</p>
  27  */
  28 interface XXMLSecurityContext : com::sun::star::uno::XInterface
  29 {
  30     /**
  31      * Add personal security environment , and return the index of the added environment.
  32      */
  33     long addSecurityEnvironment( [in] XSecurityEnvironment aSecurityEnvironment
  34     ) raises( com::sun::star::security::SecurityInfrastructureException ) ;
  35
  36     /**
  37      * Get the number of security environments
  38      */
  39     long getSecurityEnvironmentNumber( ) ;
  40
  41     /**
  42      * Get personal security environment
  43      */
  44     com::sun::star::xml::crypto::XSecurityEnvironment getSecurityEnvironmentByIndex([in] long index ) ;
  45
  46     /**
  47      * An handy method to get the first personal security environment.
  48      * In XMLSec/NSS, the first personal security environment should be the "internal slot"
  49      */
  50     com::sun::star::xml::crypto::XSecurityEnvironment getSecurityEnvironment( ) ;
  51
  52     /**
  53      * Get the ID of the internal security environment
  54      */
  55     long getDefaultSecurityEnvironmentIndex( ) ;
  56
  57     /**
  58      * set the ID of the internal security environment
  59      */
  60     void setDefaultSecurityEnvironmentIndex([in] long index ) ;
  61
  62 } ;
  63
  64 } ; } ; } ; } ; } ;
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */