summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl
blob: 3203cefd704b652e3b09289d5d38817512b883ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
#define __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__

#include <com/sun/star/ucb/XCommandEnvironment.idl>
#include <com/sun/star/ucb/WebDAVHTTPMethod.idl>
#include <com/sun/star/beans/StringPair.idl>


module com { module sun { module star { module ucb {

/** A command environment that can be used to deal with WebDAV/HTTP specific
    commands.
*/
interface XWebDAVCommandEnvironment : XCommandEnvironment
{
    /** This method gets called while assembling a WebDAV/HTTP request.
        The returned headername-headervalue pairs will be appended to
        the list of request headers before the request is dispatched.

    @param aURI
    The request URI.

    @param eMethod
    The WebDAV/HTTP method ("GET","PUT","MKCOL",...) as defined in WebDAVHTTPMethod.

    @return
        A sequence of header name, header value pairs. The header
        names must be the plain names and contain no trailing ":".
    */
    sequence<com::sun::star::beans::StringPair> getUserRequestHeaders(
        [in] string             aURI,
        [in] WebDAVHTTPMethod   eMethod);
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */