xref: /trunk/main/offapi/com/sun/star/xml/crypto/sax/XSecuritySAXEventKeeper.idl (revision df3f5cbc41366d4f6c9280e40744052189d43cc6)
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_sax_xsecuritysaxeventkeeper_idl_
29#define __com_sun_star_xml_crypto_sax_xsecuritysaxeventkeeper_idl_
30
31#include <com/sun/star/uno/XInterface.idl>
32#include <com/sun/star/uno/Exception.idl>
33#include <com/sun/star/xml/crypto/sax/XSAXEventKeeper.idl>
34#include <com/sun/star/xml/crypto/sax/ConstOfSecurityId.idl>
35#include <com/sun/star/xml/crypto/sax/ElementMarkPriority.idl>
36#include <com/sun/star/xml/crypto/sax/ElementMarkType.idl>
37
38module com { module sun { module star { module xml { module crypto { module sax {
39
40/**
41 * Interface of Security SAX Event Keeper.
42 * <p>
43 * This interface is an extension of the XSAXEventKeeper interface,
44 * some security related features are added.
45 */
46interface XSecuritySAXEventKeeper : XSAXEventKeeper
47{
48    /**
49     * Adds a new element collector on the next element in the SAX event
50     * stream.
51     *
52     * @param priority                       the priority of the element collector. See
53     *                                       ConstOfPriority
54     * @param modifyElement                  a flag representing whether the element
55     *                                       collector will modify the content of its
56     *                                       element after notification
57     * @return                               the keeper id of the new element collector
58     */
59    long addSecurityElementCollector(
60        [in] ElementMarkPriority priority,
61        [in] boolean modifyElement);
62
63    /**
64     * Clones an element collector.
65     *
66     * @param referenceId                    the keeper id of the element collector to
67     *                                       be cloned
68     * @param priority                       the priority of new element collector. See
69     *                                       ConstOfPriority
70     * @return                               the keeper id of the new element collector
71     */
72    long cloneElementCollector(
73        [in] long referenceId,
74        [in] ElementMarkPriority priority);
75
76    /**
77     * Sets security id for an element mark.
78     *
79     * @param id           the keeper id of the element collector to be set
80     * @param securityId   the security id to be set
81     */
82    void setSecurityId([in] long id, [in] long securityId);
83};
84
85} ; } ; } ; } ; } ; } ;
86
87
88#endif
89
90