INTEGRATION: CWS xmlsec05 (1.1.4); FILE ADDED

2004/07/09 11:45:40 mt 1.1.4.1: XMLSecurity

1 files changed, 181 insertions, 0 deletions

diff --git a/offapi/com/sun/star/xml/crypto/sax/XSAXEventKeeper.idl b/offapi/com/sun/star/xml/crypto/sax/XSAXEventKeeper.idl
new file mode 100644
index 000000000000..d590f007d02c
--- /dev/null
+++ b/offapi/com/sun/star/xml/crypto/sax/XSAXEventKeeper.idl
@@ -0,0 +1,181 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XSAXEventKeeper.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2004-08-31 10:03:25 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 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
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+//i20156 - new file for xmlsecurity module
+
+/** -- idl definition -- **/
+
+#ifndef __com_sun_star_xml_crypto_sax_xsaxeventkeeper_idl_
+#define __com_sun_star_xml_crypto_sax_xsaxeventkeeper_idl_
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/uno/Exception.idl>
+#include <com/sun/star/xml/sax/XDocumentHandler.idl>
+
+#include <com/sun/star/xml/wrapper/XXMLDocumentWrapper.idl>
+#include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
+
+module com { module sun { module star { module xml { module crypto { module sax {
+
+/**
+ * Interface of SAX Event Keeper.
+ * <p>
+ * This interface is used to manipulate element marks in a SAX event stream.
+ * <p>
+ * There are two kinds of element mark, one is element collector, which is
+ * used to collect a particular element from the SAX event stream; the other
+ * is blocker, which is used to block the SAX event stream.
+ */
+interface XSAXEventKeeper : com::sun::star::uno::XInterface
+{
+    /**
+     * Adds a new element collector on the next element in the SAX event
+     * stream.
+     *
+     * @return   the keeper id of the new element collector
+     */
+    long addElementCollector();
+
+    /**
+     * Removes an element collector.
+     *
+     * @param id   the keeper id of the element collector to be removed
+     */
+    void removeElementCollector([in] long id);
+
+    /**
+     * Adds a new blocker on the next element in the SAX event stream.
+     * <p>
+     * No SAX event starting from the next element will be forwarded until
+     * this blocker is removed.
+     *
+     * @return   the keeper id of the new blocker
+     */
+    long addBlocker();
+
+    /**
+     * Removes a blocker
+     *
+     * @param id   the keeper id of the blocker to be removed
+     */
+    void removeBlocker([in] long id);
+
+    /**
+     * Checks whether the SAX event stream is blocking.
+     *
+     * @return   <code>true</code> if blocking, <code>false</code> otherwise
+     */
+    boolean isBlocking();
+
+    /**
+     * Gets the element of an element mark.
+     *
+     * @param id   the keeper id of the element mark, it can be a element
+     *             collector or a blocker
+     */
+    com::sun::star::xml::wrapper::XXMLElementWrapper getElement([in] long id);
+
+    /**
+     * Sets the element of an element mark.
+     * <p>
+     * When an element is replaced outside of this interface, then uses this method
+     * can restore the link between an element mark and its working element.
+     *
+     * @param id         the keeper id of the element mark to be set
+     * @param aElement   the new element for this element mark.
+     */
+    void setElement(
+        [in] long id,
+        [in] com::sun::star::xml::wrapper::XXMLElementWrapper aElement);
+
+    /**
+     * Sets the next document handler in the SAX chain.
+     * <p>
+     * This handler will receive SAX events forwarded by the SAXEventKeeper.
+     *
+     * @param nextHandler   the next handler in the SAX chain
+     * @return              the old next handler
+     */
+    com::sun::star::xml::sax::XDocumentHandler setNextHandler(
+        [in] com::sun::star::xml::sax::XDocumentHandler nextHandler);
+
+    /**
+     * Prints information about all bufferred elements.
+     *
+     * @return   a tree-style string including all buffer informtion
+     */
+    string printBufferNodeTree();
+
+    /**
+     * Gets the element which current blocking happens.
+     * <p>
+     * This element is the working element of the first blocker in tree order.
+     *
+     * @return   the current blocking element
+     */
+    com::sun::star::xml::wrapper::XXMLElementWrapper getCurrentBlockingNode();
+};
+
+} ; } ; } ; } ; } ; } ;
+
+
+#endif
+