/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XXMLSecurityContext.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 09:42:26 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

//i20156 - new file for xmlsecurity module

/** -- idl definition -- **/

#ifndef __com_sun_star_xml_crypto_xxmlsecuritycontext_idl_
#define __com_sun_star_xml_crypto_xxmlsecuritycontext_idl_

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/security/SecurityInfrastructureException.idl>

#include <com/sun/star/xml/crypto/XSecurityEnvironment.idl>

module com { module sun { module star { module xml { module crypto {

/**
 * Interface of XML security context
 *
 * <p>This interface specifies a certain signature context. By signature
 * context, the signer or verifier retrieves key specification.</p>
 */
interface XXMLSecurityContext : com::sun::star::uno::XInterface
{
    /**
     * Add personal security environment , and return the index of the added env.
     */
    long addSecurityEnvironment( [in] XSecurityEnvironment aSecurityEnvironment
    ) raises( com::sun::star::security::SecurityInfrastructureException ) ;

    /**
     * Get the number of security environments
     */
    long getSecurityEnvironmentNumber( ) ;

    /**
     * Get personal security environment
     */
    com::sun::star::xml::crypto::XSecurityEnvironment getSecurityEnvironmentByIndex([in] long index ) ;

    /**
     * An handy method to get the first personal security environment.
     * In xmlsec/nss, the first personal security environment should be the "internal slot"
     */
    com::sun::star::xml::crypto::XSecurityEnvironment getSecurityEnvironment( ) ;

    /**
     * Get the ID of the internal security environment
     */
    long getDefaultSecurityEnvironmentIndex( ) ;

    /**
     * set the ID of the internal security environment
     */
    void setDefaultSecurityEnvironmentIndex([in] long index ) ;

} ;

} ; } ; } ; } ; } ;

#endif

