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