offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.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: XWebDAVCommandEnvironment.idl,v $
  10  * $Revision: 1.3 $
  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 #ifndef __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
  31 #define __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_beans_NamedValue_idl__
  37 #include <com/sun/star/beans/NamedValue.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42 module com { module sun { module star { module ucb {
  43
  44 //=============================================================================
  45 /** A command environment that can be used to deal with WebDAV/HTTP specific
  46     commands.
  47
  48     <p>Supply an implementation of this interface together with an
  49     <type>XCommandEnvironment</type> implementation, when executing a command
  50     using <type>XCommandProcessor</type>.
  51 */
  52 /* published */
  53 interface XWebDAVCommandEnvironment : com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56     /** This method gets called while assembling an WebDAV/HTTP request.
  57         The returned headername-headervalue pairs will be appended to
  58         the list of request headers before the request is dispatched.
  59
  60     @param aURI
  61     The request URI.
  62
  63     @param aMethod
  64     The WebDAV/HTTP method ("GET","PUT","MKCOL",...).
  65
  66     @return
  67         A sequence of header name, header value pairs. The header
  68         names must be the plain names and contain no trailing ":".
  69         The header value must be an Any containing a string.
  70     */
  71     sequence<com::sun::star::beans::NamedValue> getUserRequestHeaders(
  72     [in] string aURI,
  73     [in] string aMethod);
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif