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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
  20 #define __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
  21
  22 #include <com/sun/star/ucb/XCommandEnvironment.idl>
  23 #include <com/sun/star/ucb/WebDAVHTTPMethod.idl>
  24 #include <com/sun/star/beans/StringPair.idl>
  25
  26
  27 module com { module sun { module star { module ucb {
  28
  29 /** A command environment that can be used to deal with WebDAV/HTTP specific
  30     commands.
  31 */
  32 interface XWebDAVCommandEnvironment : XCommandEnvironment
  33 {
  34     /** This method gets called while assembling an WebDAV/HTTP request.
  35         The returned headername-headervalue pairs will be appended to
  36         the list of request headers before the request is dispatched.
  37
  38     @param aURI
  39     The request URI.
  40
  41     @param eMethod
  42     The WebDAV/HTTP method ("GET","PUT","MKCOL",...) as defined in WebDAVHTTPMethod.
  43
  44     @return
  45         A sequence of header name, header value pairs. The header
  46         names must be the plain names and contain no trailing ":".
  47     */
  48     sequence<com::sun::star::beans::StringPair> getUserRequestHeaders(
  49         [in] string             aURI,
  50         [in] WebDAVHTTPMethod   eMethod);
  51 };
  52
  53 }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */