xref: /aoo42x/main/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__
#define __com_sun_star_ucb_XWebDAVCommandEnvironment_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_beans_NamedValue_idl__
#include <com/sun/star/beans/NamedValue.idl>
#endif

//=============================================================================

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

//=============================================================================
/** A command environment that can be used to deal with WebDAV/HTTP specific
    commands.

    <p>Supply an implementation of this interface together with an
    <type>XCommandEnvironment</type> implementation, when executing a command
    using <type>XCommandProcessor</type>.
*/
published interface XWebDAVCommandEnvironment : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** This method gets called while assembling an 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 aMethod
    The WebDAV/HTTP method ("GET","PUT","MKCOL",...).

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

//=============================================================================

}; }; }; };

#endif