offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
  28 #define __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33 #ifndef __com_sun_star_beans_NamedValue_idl__
  34 #include <com/sun/star/beans/NamedValue.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module ucb {
  40
  41 //=============================================================================
  42 /** A command environment that can be used to deal with WebDAV/HTTP specific
  43     commands.
  44
  45     <p>Supply an implementation of this interface together with an
  46     <type>XCommandEnvironment</type> implementation, when executing a command
  47     using <type>XCommandProcessor</type>.
  48 */
  49 /* published */
  50 interface XWebDAVCommandEnvironment : com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53     /** This method gets called while assembling an WebDAV/HTTP request.
  54         The returned headername-headervalue pairs will be appended to
  55         the list of request headers before the request is dispatched.
  56
  57     @param aURI
  58     The request URI.
  59
  60     @param aMethod
  61     The WebDAV/HTTP method ("GET","PUT","MKCOL",...).
  62
  63     @return
  64         A sequence of header name, header value pairs. The header
  65         names must be the plain names and contain no trailing ":".
  66         The header value must be an Any containing a string.
  67     */
  68     sequence<com::sun::star::beans::NamedValue> getUserRequestHeaders(
  69     [in] string aURI,
  70     [in] string aMethod);
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif