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