1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22#ifndef __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
23#define __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
24
25#include <com/sun/star/ucb/XCommandEnvironment.idl>
26#include <com/sun/star/ucb/WebDAVHTTPMethod.idl>
27#include <com/sun/star/beans/StringPair.idl>
28
29module com { module sun { module star { module ucb {
30
31/** A command environment that can be used to deal with WebDAV/HTTP specific
32    commands.
33*/
34interface XWebDAVCommandEnvironment : XCommandEnvironment
35{
36    /** This method gets called while assembling an WebDAV/HTTP request.
37        The returned headername-headervalue pairs will be appended to
38        the list of request headers before the request is dispatched.
39
40    @param aURI
41    The request URI.
42
43    @param aMethod
44    The WebDAV/HTTP method ("GET","PUT","MKCOL",...) as defined in
45    <type>WebDAVHTTPMethod</type>.
46
47    @return
48        A sequence of header name, header value pairs. The header
49        names must be the plain names and contain no trailing ":".
50    */
51    sequence<com::sun::star::beans::StringPair> getUserRequestHeaders(
52        [in] string             aURI,
53        [in] WebDAVHTTPMethod   eMethod);
54};
55
56}; }; }; };
57
58#endif
59