xref: /AOO41X/main/offapi/com/sun/star/xml/crypto/XXMLSignatureTemplate.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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_xxmlsignaturetemplate_idl_
33#define __com_sun_star_xml_crypto_xxmlsignaturetemplate_idl_
34
35#include <com/sun/star/uno/XInterface.idl>
36#include <com/sun/star/lang/IllegalArgumentException.idl>
37
38#include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
39#include <com/sun/star/xml/crypto/XUriBinding.idl>
40#include <com/sun/star/xml/crypto/XXMLSecurityTemplate.idl>
41
42module com { module sun { module star { module xml { module crypto {
43
44/**
45 * Interface of XML signature template
46 *
47 * <p>This interface represents a signature template, which is the same as the
48 * desired xml signature element but some of the nodes may be empty. The empty
49 * entities include digest value and signature value. Empty entities are not
50 * allowed in a signature template when performing validation.</p>
51 *
52 * <p>In some cases, the signer or vertifier can dertermine and locate the
53 * contents to be signed from the template by dereference the URI.</p>
54 *
55 * <p>With the help of signature context, the signer or verifier specifies the
56 * key from the KeyInfo in the signature template.</p>
57 *
58 * Owner: Andrew Fan
59 */
60interface XXMLSignatureTemplate : XXMLSecurityTemplate
61{
62	/**
63	 * Get the target xml element, i.e. the element to be signed
64	 */
65	sequence< com::sun::star::xml::wrapper::XXMLElementWrapper > getTargets(
66	) ;
67
68	/**
69	 * Set the dynamic URI binding
70	 */
71	void setBinding(
72		[in] com::sun::star::xml::crypto::XUriBinding aUriBinding
73	) raises( com::sun::star::lang::IllegalArgumentException ) ;
74
75	/**
76	 * Get the dynamic URI binding
77	 */
78	com::sun::star::xml::crypto::XUriBinding getBinding( ) ;
79} ;
80
81} ; } ; } ; } ; } ;
82
83
84#endif
85
86