offapi/com/sun/star/xml/crypto/XUriBinding.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XUriBinding.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 //i20156 - new file for xmlsecurity module
  32
  33 /** -- idl definition -- **/
  34
  35 #ifndef __com_sun_star_xml_crypto_xuribinding_idl_
  36 #define __com_sun_star_xml_crypto_xuribinding_idl_
  37
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #include <com/sun/star/uno/Exception.idl>
  40 #include <com/sun/star/io/XInputStream.idl>
  41
  42 module com { module sun { module star { module xml { module crypto {
  43
  44 /**
  45  * Interface of Uri Binding.
  46  * <p>
  47  * This interface is used to dynamically bind a uri with a
  48  * XInputStream interface.
  49  */
  50 interface XUriBinding : com::sun::star::uno::XInterface
  51 {
  52     /**
  53      * Sets the XInputStream interface for a uri.
  54      *
  55      * @param uri       the uri to bind
  56      * @param aStream   the XInputStream to be binded
  57      */
  58     void setUriBinding([in] string uri, [in] com::sun::star::io::XInputStream aInputStream)
  59         raises( com::sun::star::uno::Exception );
  60
  61     /**
  62      * Gets the XInputStream interface for a uri.
  63      *
  64      * @param uri   the uri whose binding is to get
  65      * @return      the XInputStream binded with the uri
  66      */
  67     com::sun::star::io::XInputStream getUriBinding([in] string uri)
  68         raises( com::sun::star::uno::Exception );
  69 };
  70
  71 } ; } ; } ; } ; } ;
  72
  73
  74 #endif
  75