#include "libcmis/exception.hxx"
#include "libcmis/libcmis-api.h"
#include "libcmis/object.hxx"
namespace libcmis
{
class Folder;
class Session;
/** Interface for a CMIS Document object.
*/
class LIBCMIS_API Document : public virtual Object
{
public:
Document( Session* session ) : Object( session ) { }
virtual ~Document( ) { }
/** Get the folder parents for the document.
Note that an unfiled document will have no parent folder.
@return the parents folder if any.
*/
virtual std::vector< boost::shared_ptr< Folder > > getParents( ) = 0;
/** Get the content stream without using a temporary file.
The stream may not contain anything if there is
no content or if something wrong happened during the
download.
@param streamId of the rendition
@return
An input stream to read the data from.
@throws Exception
if anything wrong happened during the file transfer.
In such a case, the content of the stream can't be
guaranteed.
*/
virtual boost::shared_ptr< std::istream > getContentStream( std::string streamId = std::string( ) )
= 0;
/** Set or replace the content stream of the document.
@param is the output stream containing the new data for the content stream
@param contentType the mime-type of the new content stream
@param filename the filename to set for the file
@param overwrite if set to false, don't overwrite the content stream if one is already set.
@throw Exception if anything happens during the upload like a wrong authentication,
no rights to set the stream, server doesn't have the ContentStreamUpdatability
capability.
*/
virtual void setContentStream( boost::shared_ptr< std::ostream > os, std::string contentType,
std::string filename, bool overwrite = true ) = 0;
/** Get the content mime type.
*/
virtual std::string getContentType( );
/** Get the content stream filename.
*/
virtual std::string getContentFilename( );
/** Get the content length in bytes.
*/
virtual long getContentLength( );
/** Checks out the document and returns the object corresponding to the
created Private Working Copy.
\return the Private Working Copy document
*/
virtual boost::shared_ptr< Document > checkOut( ) = 0;
/** Cancels the checkout if the document is a private working copy, or
throws an exception.
*/
virtual void cancelCheckout( ) = 0;
/** Check in the private working copy and create a new version or throw
an exception.
The current object will be updated to reflect the changes performed
on the server side.
\param isMajor defines it the version to create is a major or minor one
\param comment contains the checkin comment
\param properties the properties to set the new version
\param stream the content stream to set for the new version
\param contentType the mime type of the stream to set
\return the document with the new version
*/
virtual boost::shared_ptr< Document > checkIn( bool isMajor, std::string comment,
const std::map< std::string, PropertyPtr >& properties,
boost::shared_ptr< std::ostream > stream,
std::string contentType, std::string fileName ) = 0;
virtual std::vector< boost::shared_ptr< Document > > getAllVersions( ) = 0;
// virtual methods form Object
virtual std::vector< std::string > getPaths( );
virtual std::string toString( );
};
typedef boost::shared_ptr< Document > DocumentPtr;
}
#endif
libcmis-0.6.2/inc/libcmis/exception.hxx 0000664 0000000 0000000 00000003443 14524500742 0020072 0 ustar 00root root 0000000 0000000 /* libcmis
* Version: MPL 1.1 / GPLv2+ / LGPLv2+
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License or as specified alternatively below. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Major Contributor(s):
* Copyright (C) 2011 SUSE
*
*
* All Rights Reserved.
*
* For minor contributions see the git repository.
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPLv2+"), or
* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
* in which case the provisions of the GPLv2+ or the LGPLv2+ are applicable
* instead of those above.
*/
#ifndef _EXCEPTION_HXX_
#define _EXCEPTION_HXX_
#include
#include
#include "libcmis/libcmis-api.h"
namespace libcmis
{
class LIBCMIS_API Exception : public std::exception
{
private:
std::string m_message;
std::string m_type;
public:
Exception( std::string message, std::string type = "runtime" ) :
exception( ),
m_message( message ),
m_type( type )
{
}
~Exception( ) noexcept { }
virtual const char* what() const noexcept
{
return m_message.c_str( );
}
std::string getType( ) const { return m_type; }
};
}
#endif
libcmis-0.6.2/inc/libcmis/folder.hxx 0000664 0000000 0000000 00000005310 14524500742 0017342 0 ustar 00root root 0000000 0000000 /* libcmis
* Version: MPL 1.1 / GPLv2+ / LGPLv2+
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License or as specified alternatively below. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Major Contributor(s):
* Copyright (C) 2011 SUSE
*
*
* All Rights Reserved.
*
* For minor contributions see the git repository.
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPLv2+"), or
* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
* in which case the provisions of the GPLv2+ or the LGPLv2+ are applicable
* instead of those above.
*/
#ifndef _FOLDER_HXX_
#define _FOLDER_HXX_
#include