1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24//i20156 - new file for xmlsecurity module
25
26/** -- idl definition -- **/
27
28#ifndef __com_sun_star_xml_crypto_xxmlsignature_idl_
29#define __com_sun_star_xml_crypto_xxmlsignature_idl_
30
31#include <com/sun/star/uno/XInterface.idl>
32#include <com/sun/star/uno/SecurityException.idl>
33
34#include <com/sun/star/xml/crypto/XXMLSignatureTemplate.idl>
35#include <com/sun/star/xml/crypto/XXMLSecurityContext.idl>
36#include <com/sun/star/xml/crypto/XMLSignatureException.idl>
37
38module com { module sun { module star { module xml { module crypto {
39
40/**
41 * Interface of XML signature
42 *
43 * <p>This interface represents a xml signer or vertifier.</p>
44 *
45 * <p>The signer or vertifier concrete a key by retrieve signature context and
46 * signature template.</p>
47 *
48 * <p>In some cases, the signer or vertifier can dertermine and locate the
49 * contents to be signed from the signature template by dereference the URI.</p>
50 *
51 * <p>In some cases, the contents to be signed need to be clearly pointed out by
52 * the signature template.</p>
53 */
54interface XXMLSignature : com::sun::star::uno::XInterface
55{
56	/**
57	 * Perform signature in the environment of signature template and context.
58	 */
59	com::sun::star::xml::crypto::XXMLSignatureTemplate generate(
60		[in] com::sun::star::xml::crypto::XXMLSignatureTemplate aTemplate ,
61		[in] com::sun::star::xml::crypto::XSecurityEnvironment aEnvironment
62	) raises( com::sun::star::xml::crypto::XMLSignatureException ,
63		com::sun::star::uno::SecurityException ) ;
64
65	/**
66	 * Perform validation in the environment of signature template and context.
67	 */
68	com::sun::star::xml::crypto::XXMLSignatureTemplate validate(
69		[in] com::sun::star::xml::crypto::XXMLSignatureTemplate aTemplate ,
70		[in] com::sun::star::xml::crypto::XXMLSecurityContext aContext
71	) raises( com::sun::star::xml::crypto::XMLSignatureException ,
72		com::sun::star::uno::SecurityException ) ;
73
74	/**
75	 * get the time used by the engine, JSR105,
76	 * this method is used for evaluation.
77	 */
78	 /*
79	hyper getEngineTime([in] long id);
80	*/
81};
82
83} ; } ; } ; } ; } ;
84#endif
85