/* -*- 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 .
*/
#pragma once
#include <memory>
#include <rtl/ustring.hxx>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
#include <utility>
#include "DAVResource.hxx"
#include "DAVSessionFactory.hxx"
#include "DAVTypes.hxx"
#include "DAVRequestEnvironment.hxx"
namespace com {
namespace sun {
namespace star {
namespace beans {
struct NamedValue;
} } } }
namespace com::sun::star::ucb {
struct Lock;
}
namespace http_dav_ucp
{
class DAVSession
{
public:
void acquire()
{
osl_atomic_increment( &m_nRefCount );
}
void release()
{
if ( osl_atomic_decrement( &m_nRefCount ) == 0 )
{
m_xFactory->releaseElement(
this );
delete this;
}
}
virtual bool CanUse(
const OUString & rURI,
const css::uno::Sequence<css::beans::NamedValue>& rFlags ) = 0;
virtual bool UsesProxy() = 0;
// DAV methods
virtual void OPTIONS(
const OUString & inPath,
DAVOptions & rOptions,
const DAVRequestEnvironment & rEnv ) = 0;
// allprop & named
/// @throws DAVException
virtual void PROPFIND(
const OUString & inPath,
const Depth inDepth,
const std::vector< OUString > & inPropertyNames,
std::vector< DAVResource > & ioResources,
const DAVRequestEnvironment & rEnv ) = 0;
// propnames
/// @throws DAVException
virtual void PROPFIND(
const OUString & inPath,
const Depth inDepth,
std::vector< DAVResourceInfo > & ioResInfo,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void PROPPATCH(
const OUString & inPath,
const std::vector< ProppatchValue > & inValues,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void HEAD(
const OUString & inPath,
const std::vector< OUString > & inHeaderNames,
DAVResource & ioResource,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual css::uno::Reference< css::io::XInputStream >
GET(
const OUString & inPath,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void GET(
const OUString & inPath,
css::uno::Reference< css::io::XOutputStream >& o,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual css::uno::Reference< css::io::XInputStream >
GET(
const OUString & inPath,
const std::vector< OUString > & inHeaderNames,
DAVResource & ioResource,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void
GET(
const OUString & inPath,
css::uno::Reference< css::io::XOutputStream >& o,
const std::vector< OUString > & inHeaderNames,
DAVResource & ioResource,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void PUT(
const OUString & inPath,
const css::uno::Reference< css::io::XInputStream >& s,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual css::uno::Reference< css::io::XInputStream >
POST(
const OUString & inPath,
const OUString & rContentType,
const OUString & rReferer,
const css::uno::Reference< css::io::XInputStream > & inInputStream,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void POST(
const OUString & inPath,
const OUString & rContentType,
const OUString & rReferer,
const css::uno::Reference< css::io::XInputStream > & inInputStream,
css::uno::Reference< css::io::XOutputStream > & oOutputStream,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void MKCOL(
const OUString & inPath,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void COPY(
const OUString & inSource,
const OUString & inDestination,
const DAVRequestEnvironment & rEnv,
bool inOverwrite =
false ) = 0;
/// @throws DAVException
virtual void MOVE(
const OUString & inSource,
const OUString & inDestination,
const DAVRequestEnvironment & rEnv,
bool inOverwrite =
false ) = 0;
/// @throws DAVException
virtual void DESTROY(
const OUString & inPath,
const DAVRequestEnvironment & rEnv ) = 0;
// set new lock.
/// @throws DAVException
virtual void LOCK(
const OUString & inPath,
css::ucb::Lock & inLock,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void UNLOCK(
const OUString & inPath,
const DAVRequestEnvironment & rEnv ) = 0;
/// @throws DAVException
virtual void abort() = 0;
protected:
explicit DAVSession( rtl::Reference< DAVSessionFactory > xFactory )
: m_xFactory(std::move( xFactory )), m_nRefCount( 0 ) {}
virtual ~DAVSession() {}
private:
rtl::Reference< DAVSessionFactory > m_xFactory;
DAVSessionFactory::Map::iterator m_aContainerIt;
oslInterlockedCount m_nRefCount;
friend class DAVSessionFactory;
friend struct std::default_delete< DAVSession >;
};
}
// namespace http_dav_ucp
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */