diff options
Diffstat (limited to 'include/ucbhelper/content.hxx')
| -rw-r--r-- | include/ucbhelper/content.hxx | 680 |
1 files changed, 680 insertions, 0 deletions
diff --git a/include/ucbhelper/content.hxx b/include/ucbhelper/content.hxx new file mode 100644 index 000000000..6f4a7b2d4 --- /dev/null +++ b/include/ucbhelper/content.hxx @@ -0,0 +1,680 @@ +/* -*- 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 INCLUDED_UCBHELPER_CONTENT_HXX +#define INCLUDED_UCBHELPER_CONTENT_HXX + +#include <rtl/ref.hxx> +#include <com/sun/star/uno/Reference.h> +#include <com/sun/star/uno/Sequence.h> +#include <ucbhelper/ucbhelperdllapi.h> + +namespace com::sun::star::beans +{ +class XPropertySetInfo; +} + +namespace com::sun::star::io +{ +class XActiveDataSink; +class XOutputStream; +class XInputStream; +class XStream; +} + +namespace com::sun::star::sdbc +{ +class XResultSet; +class XRow; +} + +namespace com::sun::star::ucb +{ +class XCommandEnvironment; +class XCommandInfo; +class XContent; +class XDynamicResultSet; +class XAnyCompareFactory; +struct ContentInfo; +struct NumberedSortingInfo; +} + +namespace com::sun::star::uno +{ +class XComponentContext; +} + +namespace com::sun::star::uno +{ +class Any; +} + +namespace ucbhelper +{ +/** + * These are the possible values for the parameter eMode of method + * ucbhelper::Content::createCursor. + */ +enum ResultSetInclude +{ + INCLUDE_FOLDERS_ONLY, + INCLUDE_DOCUMENTS_ONLY, + INCLUDE_FOLDERS_AND_DOCUMENTS +}; + +/** + * These are the possible values for the parameter eOperation of method + * ucbhelper::Content::insertNewContent. + */ +enum class InsertOperation +{ + Copy, // copy source data + Move, // move source data + Checkin // check-in source data +}; + +class Content_Impl; + +/** + * This class simplifies access to UCB contents by providing a more + * convenient API for frequently used functionality then the "raw" + * UCB-API does. + */ +class UCBHELPER_DLLPUBLIC Content final +{ + rtl::Reference<Content_Impl> m_xImpl; + + /// @throws css::ucb::CommandAbortedException + /// @throws css::uno::RuntimeException, + /// @throws css::uno::Exception + css::uno::Any createCursorAny(const css::uno::Sequence<OUString>& rPropertyNames, + ResultSetInclude eMode); + +public: + /** + * Constructor. + */ + Content(); + + /** + * Constructor. + * + * @param rURL is the URL of the content to create. + * @param rEnv is the environment to use for commands executed by the + * content. The command environment is used by the content + * implementation to interact with the client and to propagate + * errors. + * @throws css::ucb::ContentCreationException + * @throws css::uno::RuntimeException + */ + Content(const OUString& rURL, const css::uno::Reference<css::ucb::XCommandEnvironment>& rEnv, + const css::uno::Reference<css::uno::XComponentContext>& rCtx); + /** + * Constructor. + * + * @param rContent is the content object of the content to create. + * @param rEnv is the environment to use for commands executed by the + * content. The command environment is used by the content + * implementation to interact with the client and to propagate + * errors. + * @throws css::ucb::ContentCreationException + * @throws css::uno::RuntimeException + */ + Content(const css::uno::Reference<css::ucb::XContent>& rContent, + const css::uno::Reference<css::ucb::XCommandEnvironment>& rEnv, + const css::uno::Reference<css::uno::XComponentContext>& rCtx); + /** + * Copy Constructor. + * + * @param rContent is the content this content shall be a copy of. + */ + Content(const Content& rOther); + + /** + * Move constructor. + */ + Content(Content&& rOther) noexcept; + + /** + * Destructor. + */ + ~Content(); + + /** + * Assignment operator. + * + * @param rContent is the content this content shall be a copy of. + */ + Content& operator=(const Content& rOther); + + /** + * Move assignment operator. + */ + Content& operator=(Content&& rOther) noexcept; + + /** + * Constructor. This method should be used, if the exception thrown + * by the direct ctors of this class are to 'expensive' for your + * application + * + * @param rURL is the URL of the content to create. + * @param rEnv is the environment to use for commands executed by the + * content. The command environment is used by the content + * implementation to interact with the client and to propagate + * errors. + * @param rContent will be filled by this method with the content created. + * @return true, if the operation was successful - false, otherwise. + */ + static bool create(const OUString& rURL, + const css::uno::Reference<css::ucb::XCommandEnvironment>& rEnv, + const css::uno::Reference<css::uno::XComponentContext>& rCtx, + Content& rContent); + + // Direct access to UCB content. + + /** + * This method provides access to the "native" UCB content interface(s). + * This is useful in case the convenience methods provided by this + * class are insufficient for your needs. You may obtain all interfaces + * supported by the underlying UCB content by calling this method and + * after that doing a queryInterface call. + * + * @return the XContent interface of the underlying UCB content. + */ + css::uno::Reference<css::ucb::XContent> get() const; + + // Object identity. + + /** + * This method returns the URL of the content. + * + * @return the URL of the content. + */ + const OUString& getURL() const; + + // Command environment. + + /** + * This method returns the environment to use when executing commands. + * + * @return the command environment. + */ + const css::uno::Reference<css::ucb::XCommandEnvironment>& getCommandEnvironment() const; + + /** + * This method sets a new command environment. + * + * @param xNewEnv is the new command environment. + */ + void setCommandEnvironment(const css::uno::Reference<css::ucb::XCommandEnvironment>& xNewEnv); + + // Access to supported commands/properties. + + /** + * This methods provides access to meta data of the commands supported + * by this content. + * + * @return an XCommandInfo interface implementation, which can be used + * to obtain meta data of the commands supported by this content. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Reference<css::ucb::XCommandInfo> getCommands(); + /** + * This methods provides access to meta data of the properties supported + * by this content. + * + * @return an XPropertSetInfo interface implementation, which can be used + * to obtain meta data of the properties supported by this content. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Reference<css::beans::XPropertySetInfo> getProperties(); + + // Access to property value(s). + + /** + * This method can be used to read a single property value. + * + * @param rPropertyName is the name of the property for that the value + * shall be obtained. + * @return the property value. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Any getPropertyValue(const OUString& rPropertyName); + /** + * This method can be used to set a single property value. + * + * @param rPropertyName is the name of the property for that the + * value shall be set. + * @return an any containing: + * - No value indicates, that the property value was set + * successfully. + * - css::beans::UnknownPropertyException indicates, + * that the property is not known to the content implementation. + * - css::beans::IllegalTypeException indicates, that + * the data type of the property value is not acceptable. + * - css::lang::IllegalAccessException indicates, that + * the property is constant. + * - css::lang::IllegalArgumentException indicates, + * that the property value is not acceptable. For instance, + * setting an empty title may be illegal. + * - Any other exception derived from + * css::uno::Exception indicates, that the value was + * not set successfully. For example, this can be a + * com::sun:star::ucb::InteractiveAugmentedIOException + * transporting the error code + * css::ucb::IOErrorCode::ACCESS_DENIED. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Any setPropertyValue(const OUString& rPropertyName, const css::uno::Any& rValue); + /** + * This method can be used to read multiple property values. + * + * @param rPropertyNames is a sequence of names of properties for + * that the values shall be obtained. + * @return the property values. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Sequence<css::uno::Any> + getPropertyValues(const css::uno::Sequence<OUString>& rPropertyNames); + /** + * This method can be used to read multiple property values. + * + * @param rPropertyNames is a sequence of names of properties for + * that the values shall be obtained. + * @return the property values. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Reference<css::sdbc::XRow> + getPropertyValuesInterface(const css::uno::Sequence<OUString>& rPropertyNames); + + /** + * This method can be used to set multiple property values. + * + * @param rPropertyNames is a sequence of names of properties for + * that values shall be set. + * @return a sequence of any's which has exactly the same number + * of elements as the number of properties to set. Every + * sequence element contains the status for a property. The + * first sequence elements corresponds to the first element in + * the sequence of property names and so on. + * + * An any containing: + * - No value indicates, that the property value was set + * successfully. + * - css::beans::UnknownPropertyException indicates, + * that the property is not known to the content implementation. + * - css::beans::IllegalTypeException indicates, that + * the data type of the property value is not acceptable. + * - css::lang::IllegalAccessException indicates, that + * the property is constant. + * - css::lang::IllegalArgumentException indicates, + * that the property value is not acceptable. For instance, + * setting an empty title may be illegal. + * - Any other exception derived from + * css::uno::Exception indicates, that the value was + * not set successfully. For example, this can be a + * com::sun:star::ucb::InteractiveAugmentedIOException + * transporting the error code + * css::ucb::IOErrorCode::ACCESS_DENIED. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Sequence<css::uno::Any> + setPropertyValues(const css::uno::Sequence<OUString>& rPropertyNames, + const css::uno::Sequence<css::uno::Any>& rValues); + + // General command execution. + + /** + * This method can be used to execute any command supported by the + * content. + * + * @param rCommandName is the name of the command to execute. + * @param rCommandArgument is the argument for the command. Type and + * values of this parameter must correspond to the command + * specification. + * @return the result of the command according to its specification. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Any executeCommand(const OUString& rCommandName, + const css::uno::Any& rCommandArgument); + + // Special commands. + + /** + * This methods gives access to the children of a folder content. + * Additionally, the result set returned provides efficient access to + * preselected property values of the children. + * Internally it executes the command "open" at the content. + * + * @param rPropertyNames is a sequence of names of properties for + * that the values should be accessible via the resultset + * returned by this method. + * @param eMode is a very simple filter for the children contained + * in the resultset. + * @return an implementation of the service + * com.cun.star.ucb.ContentResultSet, which can be used to + * get access to the children of a content. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Reference<css::sdbc::XResultSet> + createCursor(const css::uno::Sequence<OUString>& rPropertyNames, + ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS); + /** + * This methods gives access to the children of a folder content. + * Additionally, the result set returned provides efficient access to + * preselected property values of the children. + * Internally it executes the command "open" at the content. + * + * @param rPropertyNames is a sequence of names of properties for + * that the values should be accessible via the resultset + * returned by this method. + * @param eMode is a very simple filter for the children contained + * in the resultset. + * @return an implementation of the service + * com.cun.star.ucb.DynamicResultSet, which can be used to + * get access to the children of a content. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Reference<css::ucb::XDynamicResultSet> + createDynamicCursor(const css::uno::Sequence<OUString>& rPropertyNames, + ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS); + + /// @throws css::ucb::CommandAbortedException + /// @throws css::uno::RuntimeException + /// @throws css::uno::Exception + css::uno::Reference<css::sdbc::XResultSet> + createSortedCursor(const css::uno::Sequence<OUString>& rPropertyNames, + const css::uno::Sequence<css::ucb::NumberedSortingInfo>& rSortInfo, + const css::uno::Reference<css::ucb::XAnyCompareFactory>& rAnyCompareFactory, + ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS); + + /** + * This methods gives read access to the content stream of a content (i.e + * the content of a file located at the local file system). + * Internally it executes the command "open" at the content. + * + * @return an implementation of the interface XInputStream, which can + * be used to read the content's data. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Reference<css::io::XInputStream> openStream(); + /** + * This methods gives read access to the content stream of a content (i.e + * the content of a file located at the local file system). + * Internally it executes the command "open" at the content. + * The method requests opening without locking. + * + * @return an implementation of the interface XInputStream, which can + * be used to read the content's data. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Reference<css::io::XInputStream> openStreamNoLock(); + + /** + * This methods gives read/write access to the content stream of a content (i.e + * the content of a file located at the local file system). + * Internally it executes the command "open" at the content. + * + * @return an implementation of the interface XStream, which can + * be used to read/write the content's data. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Reference<css::io::XStream> openWriteableStream(); + /** + * This methods gives read/write access to the content stream of a content (i.e + * the content of a file located at the local file system). + * Internally it executes the command "open" at the content. + * The method requests opening without locking. + * + * @return an implementation of the interface XStream, which can + * be used to read/write the content's data. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Reference<css::io::XStream> openWriteableStreamNoLock(); + + /** + * This methods gives read access to the content stream of a content (i.e + * the content of a file located at the local file system). + * Internally it executes the command "open" at the content. + * + * @param rSink is the implementation of an XActiveDataSink interface, + * which shall be used by the content to deliver the data. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + bool openStream(const css::uno::Reference<css::io::XActiveDataSink>& rSink); + /** + * This methods gives read access to the content stream of a content (i.e + * the content of a file located at the local file system). + * Internally it executes the command "open" at the content. + * + * @param rStream is the implementation of an XOutputStream interface, + * which shall be used by the content to deliver the data. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + bool openStream(const css::uno::Reference<css::io::XOutputStream>& rStream); + /** + * This methods gives write access to the content stream of a content (i.e + * the content of a file located at the local file system). + * Internally it executes the command "insert" at the content. + * + * @param rStream is the implementation of an XInputStream interface, + * which contains the content data to write. + * @param bReplaceExisting specifies, whether any existing content data + * shall be overwritten. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + void writeStream(const css::uno::Reference<css::io::XInputStream>& rStream, + bool bReplaceExisting); + + /** + * This method returns the different types of contents this content + * can create. + * + * @return the content types or an empty sequence if no contents can be + * created by this content. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + css::uno::Sequence<css::ucb::ContentInfo> queryCreatableContentsInfo(); + + /** + * This method creates, initializes and inserts ( commits ) a new content + * (i.e. it could be used to create a new file system folder). + * Internally this method does a + * XCommandProcessor::execute( "createNewContent", ... ); + * XCommandProcessor::execute( "setPropertyValues", ... ); + * XCommandProcessor::execute( "insert", ... ); calling sequence. + * + * @param rContentType is the type for the new UCB content. Each content + * provider implementation may introduce own types for its content + * objects (See queryCreatableContentsInfo()). + * @param rPropertyNames is a sequence of names of properties for that + * values are to set at the new content before it will be inserted + * ( committed ). + * The order of the names must correspond to the order of the + * property values. + * @param rPropertyValues is a sequence of property values that are to + * set at the new content before it will be inserted ( committed ). + * The order of the values must correspond to the order of the + * property names. + * @param rNewContent will be filled by the implementation of this method + * with the new content. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + bool insertNewContent(const OUString& rContentType, + const css::uno::Sequence<OUString>& rPropertyNames, + const css::uno::Sequence<css::uno::Any>& rPropertyValues, + Content& rNewContent); + /** + * This method creates, initializes and inserts (commits) a new content + * inside this (the target folder) content. For example, it can be used to + * create a new file system file. + * Internally this method does a + * XCommandProcessor::execute( "createNewContent", ... ); + * XCommandProcessor::execute( "setPropertyValues", ... ); + * XCommandProcessor::execute( "insert", ... ); calling sequence. + * + * @param rContentType is the type for the new UCB content. Each content + * provider implementation may introduce own types for its content + * objects (See queryCreatableContentsInfo()). + * @param rPropertyNames is a sequence of names of properties for that + * values are to set at the new content before it will be inserted + * ( committed ). + * The order of the names must correspond to the order of the + * property values. + * @param rPropertyValues is a sequence of property values that are to + * set at the new content before it will be inserted ( committed ). + * The order of the values must correspond to the order of the + * property names. + * @param rStream is a stream containing the content data for the new + * content (i.e. the content of a file to create) + * @param rNewContent will be filled by the implementation of this method + * with the new content. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + bool insertNewContent(const OUString& rContentType, + const css::uno::Sequence<OUString>& rPropertyNames, + const css::uno::Sequence<css::uno::Any>& rPropertyValues, + const css::uno::Reference<css::io::XInputStream>& rStream, + Content& rNewContent); + + /** + * This method transfers (copies/moves) a content. It creates a new + * resource inside this (the target folder) content. + * The implementation is able to do cross-provider transfers (like copying + * a file from the local file system to a directory located on an HTTP + * server). + * Internally this method executes the command "globalTransfer" at the UCB. + * + * @param rSourceContent is the content that contains the data for the + * new UCB content. + * @param eOperation defines what shall be done with the source data + * ( COPY, MOVE, LINK ). + * @param rTitle contains a title for the new content. If this is an empty + * string, the new content will have the same title as the source + * content. + * @param rNameClashAction describes how the implementation shall behave + * in case a content with a clashing name exists in the target + * folder. + * NameClash::ERROR will abort the operation, NameClash::OVERWRITE + * will overwrite the clashing content and all its data, + * NameClash::RENAME will generate and supply a non-clashing title. + * @see com/sun/star/ucb/NameClash.idl + * @param rMimeType contains the MIME type of the document to write. + * @param bMajorVersion tells to create a new major version for checkin operations + * @param rCommentVersion contains the comment to use for checkin operations + * @param rResultURL is a hacky way to get the update URL after the operation in + * case there was a change (introduced for the checkin operation) + * @param rDocumentId is the document Id ( in case of CMIS ). + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + void transferContent(const Content& rSourceContent, InsertOperation eOperation, + const OUString& rTitle, const sal_Int32 nNameClashAction, + const OUString& rMimeType = OUString(), bool bMajorVersion = false, + const OUString& rCommentVersion = OUString(), + OUString* pResultURL = nullptr, + const OUString& rDocumentId = OUString()) const; + + /** + * This method lock the resource. + * + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + void lock(); + + /** + * This method unlock the resource. + * + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + void unlock(); + + // Required properties. + + /** + * This method returns the value of the content's property "IsFolder". + * + * @return true, if the content is a folder ( it can contain other + * UCB contents). false, otherwise. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + bool isFolder(); + /** + * This method returns the value of the content's property "IsDocument". + * + * @return true, if the content is a document ( it has a content stream ). + * false, otherwise. + * @throws css::ucb::CommandAbortedException + * @throws css::uno::RuntimeException + * @throws css::uno::Exception + */ + bool isDocument(); +}; + +} /* namespace ucbhelper */ + +#endif /* ! INCLUDED_UCBHELPER_CONTENT_HXX */ + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |