Initial project's source code check-in.

WebsitePanel/Sources/WebsitePanel.Providers.Base/SharePoint/IHostedSharePointServer.cs

@@ -0,0 +1,118 @@
+// Copyright (c) 2011, Outercurve Foundation.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without modification,
+// are permitted provided that the following conditions are met:
+//
+// - Redistributions of source code must  retain  the  above copyright notice, this
+//   list of conditions and the following disclaimer.
+//
+// - Redistributions in binary form  must  reproduce the  above  copyright  notice,
+//   this list of conditions  and  the  following  disclaimer in  the documentation
+//   and/or other materials provided with the distribution.
+//
+// - Neither  the  name  of  the  Outercurve Foundation  nor   the   names  of  its
+//   contributors may be used to endorse or  promote  products  derived  from  this
+//   software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,  BUT  NOT  LIMITED TO, THE IMPLIED
+// WARRANTIES  OF  MERCHANTABILITY   AND  FITNESS  FOR  A  PARTICULAR  PURPOSE  ARE
+// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+// ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+// (INCLUDING, BUT NOT LIMITED TO,  PROCUREMENT  OF  SUBSTITUTE  GOODS OR SERVICES;
+// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)  HOWEVER  CAUSED AND ON
+// ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT  LIABILITY,  OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING  IN  ANY WAY OUT OF THE USE OF THIS
+// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+using System;
+
+namespace WebsitePanel.Providers.SharePoint
+{
+	/// <summary>
+	/// Exposes functionality for share point server provider hosted in conjunction with organization management provider and 
+	/// exchange server.
+	/// </summary>
+	public interface IHostedSharePointServer
+	{
+		/// <summary>
+		/// When implemented gets root web application uri.
+		/// </summary>
+		Uri RootWebApplicationUri
+		{
+			get;
+		}
+
+		/// <summary>
+		/// When implemented gets list of supported languages by this installation of SharePoint.
+		/// </summary>
+		/// <returns>List of supported languages</returns>
+		int[] GetSupportedLanguages();
+
+		/// <summary>
+		/// When implemented gets list of SharePoint collections within root web application.
+		/// </summary>
+		/// <returns>List of SharePoint collections within root web application.</returns>
+		SharePointSiteCollection[] GetSiteCollections();
+
+		/// <summary>
+		/// When implemented gets SharePoint collection within root web application with given name.
+		/// </summary>
+		/// <param name="url">Url that uniquely identifies site collection to be loaded.</param>
+		/// <returns>SharePoint collection within root web application with given name.</returns>
+		SharePointSiteCollection GetSiteCollection(string url);
+
+		/// <summary>
+		/// When implemented creates site collection within predefined root web application.
+		/// </summary>
+		/// <param name="siteCollection">Information about site coolection to be created.</param>
+		void CreateSiteCollection(SharePointSiteCollection siteCollection);
+		
+		/// <summary>
+		/// When implemented deletes site collection under given url.
+		/// </summary>
+		/// <param name="url">Url that uniquely identifies site collection to be deleted.</param>
+		void DeleteSiteCollection(string url);
+
+		/// <summary>
+		/// When implemeneted backups site collection under give url.
+		/// </summary>
+		/// <param name="url">Url that uniquely identifies site collection to be deleted.</param>
+		/// <param name="filename">Resulting backup file name.</param>
+		/// <param name="zip">A value which shows whether created backup must be archived.</param>
+		/// <returns>Created backup full path.</returns>
+		string BackupSiteCollection(string url, string filename, bool zip);
+
+		/// <summary>
+		/// When implemented restores site collection under given url from backup.
+		/// </summary>
+		/// <param name="siteCollection">Site collection to be restored.</param>
+		/// <param name="filename">Backup file name to restore from.</param>
+		void RestoreSiteCollection(SharePointSiteCollection siteCollection, string filename);
+
+		/// <summary>
+		/// When implemented gets binary data chunk of specified size from specified offset.
+		/// </summary>
+		/// <param name="path">Path to file to get bunary data chunk from.</param>
+		/// <param name="offset">Offset from which to start data reading.</param>
+		/// <param name="length">Binary data chunk length.</param>
+		/// <returns>Binary data chunk read from file.</returns>
+		byte[] GetTempFileBinaryChunk(string path, int offset, int length);
+		
+		/// <summary>
+		/// When implemented appends supplied binary data chunk to file.
+		/// </summary>
+		/// <param name="fileName">Non existent file name to append to.</param>
+		/// <param name="path">Full path to existent file to append to.</param>
+		/// <param name="chunk">Binary data chunk to append to.</param>
+		/// <returns>Path to file that was appended with chunk.</returns>
+		string AppendTempFileBinaryChunk(string fileName, string path, byte[] chunk);
+        
+        void UpdateQuotas(string url, long maxStorage, long warningStorage);
+
+	    SharePointSiteDiskSpace[] CalculateSiteCollectionsDiskSpace(string[] urls);
+
+	    long GetSiteCollectionSize(string url);
+	}
+}