/*******************************************************************************
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
* __ _ _ ___
* ( )( \/\/ )/ __)
* /__\ \ / \__ \
* (_)(_) \/\/ (___/
*
* AWS SDK for .NET
* API Version: 2006-03-01
*
*/
using System;
using System.IO;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Text;
using System.Linq;
using Amazon.S3.Model;
using Amazon.Util;
using System.Globalization;
namespace Amazon.S3.Transfer
{
/// <summary>
/// Request object for downloading a directory with the TransferUtility.
/// </summary>
public class TransferUtilityDownloadDirectoryRequest
{
private string bucketName;
private string s3Directory;
private string localDirectory;
private bool downloadFilesConcurrently = false;
private DateTime? modifiedSinceDate;
private DateTime? unmodifiedSinceDate;
private DateTime? modifiedSinceDateUtc;
private DateTime? unmodifiedSinceDateUtc;
private bool disableSlashCorrection = false;
/// <summary>
/// Gets or sets the name of the bucket.
/// </summary>
/// <value>
/// The name of the bucket.
/// </value>
public string BucketName
{
get { return this.bucketName; }
set { this.bucketName = value; }
}
/// <summary>
/// Gets whether or not the bucket name is set.
/// </summary>
/// <returns>
/// A value of <c>true</c> if the bucket name is set.
/// Otherwise, returns <c>false</c>.
/// </returns>
internal bool IsSetBucketName()
{
return !System.String.IsNullOrEmpty(this.bucketName);
}
/// <summary>
/// Gets or sets the local directory where objects from Amazon S3 will be downloaded.
/// If the directory doesn't exist, it will be created.
/// </summary>
/// <value>
/// The local directory where objects from Amazon S3 will be downloaded.
/// </value>
public string LocalDirectory
{
get { return this.localDirectory; }
set { this.localDirectory = value; }
}
/// <summary>
/// Gets whether or not the LocalDirectory property is set.
/// </summary>
/// <returns>
/// A value of <c>true</c> if LocalDirectory property is set.
/// Otherwise, returns <c>false</c>.
/// </returns>
internal bool IsSetLocalDirectory()
{
return !System.String.IsNullOrEmpty(this.localDirectory);
}
/// <summary>
/// Gets or sets the Amazon S3 directory to download from.
/// This is translated to a key prefix; keys that have this prefix will be
/// downloaded.
///
/// The TransferUtility will automatically add a / to the end when listing objects for
/// to be downloaded. This treats S3Directory field as a virtual S3 directory. In some use
/// cases the added / slash can be undesirable. To prevent the TransferUtility from adding
/// the / at the end set the DisableSlashCorrection property to true.
/// </summary>
public string S3Directory
{
get { return this.s3Directory; }
set { this.s3Directory = value; }
}
/// <summary>
/// Gets whether or not the S3Directory property is set.
/// </summary>
/// <returns>
/// A value of <c>true</c> if S3Directory property is set.
/// Otherwise, returns <c>false</c>.
/// </returns>
internal bool IsSetS3Directory()
{
return !System.String.IsNullOrEmpty(this.s3Directory);
}
/// <summary>
/// <para>
/// This property is deprecated. This property doesn't honor the DateTimeKind, please
/// use ModifiedSinceDateUtc instead.
/// </para>
/// Gets or sets the <c>ModifiedSinceDate</c> property.
/// Only objects that have been modified since this date will be
/// downloaded.
/// </summary>
/// <value>
/// The <c>ModifiedSinceDate</c> property.
/// </value>
[Obsolete("This property doesn't honor the DateTimeKind, please use ModifiedSinceDateUtc instead.", false)]
public DateTime ModifiedSinceDate
{
get { return this.modifiedSinceDate.GetValueOrDefault(); }
set { this.modifiedSinceDate = value; }
}
/// <summary>
/// Checks if ModifiedSinceDate property is set.
/// </summary>
/// <returns>A value of <c>true</c> if ModifiedSinceDate property is set.
/// Otherwise, returns <c>false</c>.</returns>
internal bool IsSetModifiedSinceDate()
{
return modifiedSinceDate.HasValue;
}
/// <summary>
/// Gets or sets the <c>ModifiedSinceDateUtc</c> property.
/// Only objects that have been modified since this date will be
/// downloaded.
/// </summary>
/// <value>
/// The <c>ModifiedSinceDateUtc</c> property.
/// </value>
public DateTime ModifiedSinceDateUtc
{
get { return this.modifiedSinceDateUtc.GetValueOrDefault(); }
set { this.modifiedSinceDateUtc = value; }
}
/// <summary>
/// Checks if ModifiedSinceDateUtc property is set.
/// </summary>
/// <returns>A value of <c>true</c> if ModifiedSinceDateUtc property is set.
/// Otherwise, returns <c>false</c>.</returns>
internal bool IsSetModifiedSinceDateUtc()
{
return modifiedSinceDateUtc.HasValue;
}
/// <summary>
/// <para>
/// This property is deprecated. This property doesn't honor the DateTimeKind, please
/// use UnmodifiedSinceDateUtc instead.
/// </para>
/// Gets or sets the <c>UnmodifiedSinceDate</c> property.
/// Only objects that have not been modified since this date will be downloaded.
/// </summary>
/// <value>
/// The <c>UnmodifiedSinceDate</c> property.
/// </value>
[Obsolete("This property doesn't honor the DateTimeKind, please use UnmodifiedSinceDateUtc instead.", false)]
public DateTime UnmodifiedSinceDate
{
get { return this.unmodifiedSinceDate.GetValueOrDefault(); }
set { this.unmodifiedSinceDate = value; }
}
/// <summary>
/// Checks if UnmodifiedSinceDate property is set.
/// </summary>
/// <returns>true if UnmodifiedSinceDate property is set.</returns>
internal bool IsSetUnmodifiedSinceDate()
{
return unmodifiedSinceDate.HasValue;
}
/// <summary>
/// Gets or sets the <c>UnmodifiedSinceDateUtc</c> property.
/// Only objects that have not been modified since this date will be downloaded.
/// </summary>
/// <value>
/// The <c>UnmodifiedSinceDateUtc</c> property.
/// </value>
public DateTime UnmodifiedSinceDateUtc
{
get { return this.unmodifiedSinceDateUtc.GetValueOrDefault(); }
set { this.unmodifiedSinceDateUtc = value; }
}
/// <summary>
/// Checks if UnmodifiedSinceDateUtc property is set.
/// </summary>
/// <returns>true if UnmodifiedSinceDateUtc property is set.</returns>
internal bool IsSetUnmodifiedSinceDateUtc()
{
return unmodifiedSinceDateUtc.HasValue;
}
/// <summary>
/// Gets or sets the DownloadFilesConcurrently property.
/// Specifies if multiple files will be downloaded concurrently.
/// The number of concurrent web requests used is controlled
/// by the TransferUtilityConfig.ConcurrencyLevel property.
/// </summary>
#if BCL45 || NETSTANDARD
public
#else
internal
#endif
bool DownloadFilesConcurrently
{
get { return this.downloadFilesConcurrently; }
set { this.downloadFilesConcurrently = value; }
}
/// <summary>
/// If this is set to true then the TransferUtility will not ensure the S3Directory property has a trailing / for a virtual S3 directory.
/// The default value is false.
/// </summary>
public bool DisableSlashCorrection
{
get { return this.disableSlashCorrection; }
set { this.disableSlashCorrection = value; }
}
/// <summary>
/// The event for DownloadedDirectoryProgressEvent notifications. All
/// subscribers will be notified when a new progress
/// event is raised.
/// <para>
/// The DownloadedDirectoryProgressEvent is fired as data
/// is downloaded from Amazon S3. The delegates attached to the event
/// will be passed information detailing how much data
/// has been downloaded as well as how much will be downloaded.
/// </para>
/// </summary>
/// <remarks>
/// Subscribe to this event if you want to receive
/// DownloadedDirectoryProgressEvent notifications. Here is how:<br />
/// 1. Define a method with a signature similar to this one:
/// <code>
/// private void displayProgress(object sender, DownloadDirectoryProgressArgs args)
/// {
/// Console.WriteLine(args);
/// }
/// </code>
/// 2. Add this method to the DownloadedDirectoryProgressEvent delegate's invocation list
/// <code>
/// TransferUtilityDownloadDirectoryRequest request = new TransferUtilityDownloadDirectoryRequest();
/// request.DownloadedDirectoryProgressEvent += displayProgress;
/// </code>
/// </remarks>
public event EventHandler<DownloadDirectoryProgressArgs> DownloadedDirectoryProgressEvent;
internal void OnRaiseProgressEvent(DownloadDirectoryProgressArgs downloadDirectoryProgress)
{
AWSSDKUtils.InvokeInBackground(DownloadedDirectoryProgressEvent, downloadDirectoryProgress, this);
}
}
/// <summary>
/// Encapsulates the information needed to provide
/// transfer progress to subscribers of the <c>DownloadDirectory</c>
/// event.
/// </summary>
public class DownloadDirectoryProgressArgs : EventArgs
{
/// <summary>
/// Constructs a new instance of <c>DownloadDirectoryProgressArgs</c>.
/// </summary>
/// <param name="numberOfFilesDownloaded">
/// The number of files downloaded.
/// </param>
/// <param name="totalNumberOfFiles">
/// The total number of files to download.
/// </param>
/// <param name="currentFile">
/// The current file being downloaded
/// </param>
/// <param name="transferredBytesForCurrentFile">
/// The number of transferred bytes for the current file.
/// </param>
/// <param name="totalNumberOfBytesForCurrentFile">
/// The size of the current file in bytes.
/// </param>
public DownloadDirectoryProgressArgs(int numberOfFilesDownloaded, int totalNumberOfFiles,
string currentFile, long transferredBytesForCurrentFile, long totalNumberOfBytesForCurrentFile)
{
this.NumberOfFilesDownloaded = numberOfFilesDownloaded;
this.TotalNumberOfFiles = totalNumberOfFiles;
this.CurrentFile = currentFile;
this.TransferredBytesForCurrentFile = transferredBytesForCurrentFile;
this.TotalNumberOfBytesForCurrentFile = totalNumberOfBytesForCurrentFile;
}
/// <summary>
/// Constructs a new instance of <c>DownloadDirectoryProgressArgs</c>.
/// </summary>
/// <param name="numberOfFilesDownloaded">
/// The number of files downloaded.
/// </param>
/// <param name="totalNumberOfFiles">
/// The total number of files to download.
/// </param>
/// <param name="transferredBytes">
/// The bytes transferred across all files being downloaded.
/// </param>
/// <param name="totalBytes">
/// The total number of bytes across all files being downloaded.
/// </param>
/// <param name="currentFile">
/// The current file being downloaded.
/// </param>
/// <param name="transferredBytesForCurrentFile">
/// The number of transferred bytes for the current file.
/// </param>
/// <param name="totalNumberOfBytesForCurrentFile">
/// The size of the current file in bytes.
/// </param>
public DownloadDirectoryProgressArgs(int numberOfFilesDownloaded, int totalNumberOfFiles, long transferredBytes, long totalBytes,
string currentFile, long transferredBytesForCurrentFile, long totalNumberOfBytesForCurrentFile)
{
this.NumberOfFilesDownloaded = numberOfFilesDownloaded;
this.TotalNumberOfFiles = totalNumberOfFiles;
this.TransferredBytes = transferredBytes;
this.TotalBytes = totalBytes;
this.CurrentFile = currentFile;
this.TransferredBytesForCurrentFile = transferredBytesForCurrentFile;
this.TotalNumberOfBytesForCurrentFile = totalNumberOfBytesForCurrentFile;
}
/// <summary>
/// Gets or sets the total number of files.
/// </summary>
/// <value>The total number of files.</value>
public int TotalNumberOfFiles { get; set; }
/// <summary>
/// Gets or sets the number of files downloaded so far.
/// </summary>
/// <value>The number of files downloaded.</value>
public int NumberOfFilesDownloaded { get; set; }
/// <summary>
/// Gets or sets the total number of bytes across all files being downloaded.
/// </summary>
/// <value>The total number of bytes across all files being downloaded.</value>
public long TotalBytes { get; set; }
/// <summary>
/// Gets or sets the bytes transferred across all files being downloaded.
/// </summary>
/// <value>The bytes transferred across all files being downloaded.</value>
public long TransferredBytes { get; set; }
#if BCL45
/// <summary>
/// Gets or sets the current file being downloaded.
/// </summary>
/// <remarks>
/// This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled).
/// If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property
/// will return null.
/// </remarks>
/// <value>The current file being downloaded.</value>
#else
/// <summary>
/// Gets or sets the current file being downloaded.
/// </summary>
/// <value>The current file being downloaded.</value>
#endif
public string CurrentFile { get; set; }
#if BCL45
/// <summary>
/// Gets or sets the transferred bytes for the current file.
/// </summary>
/// <remarks>
/// This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled).
/// If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property
/// will return 0.
/// </remarks>
/// <value>The transferred bytes for the current file.</value>
#else
/// <summary>
/// Gets or sets the transferred bytes for the current file.
/// </summary>
/// <value>The transferred bytes for the current file.</value>
#endif
public long TransferredBytesForCurrentFile { get; set; }
#if BCL45
/// <summary>
/// Gets or sets the total number of bytes for the current file.
/// </summary>
/// <remarks>
/// This property is only valid if DownloadDirectory is used without enabling concurrent file downloads (by default concurrent download is disabled).
/// If concurrent file downloads are enabled by setting TransferUtilityDownloadDirectoryRequest.DownloadFilesConcurrently to true, this property
/// will return 0.
/// </remarks>
/// <value>The total number of bytes for the current file.</value>
#else
/// <summary>
/// Gets or sets the total number of bytes for the current file.
/// </summary>
/// <value>The total number of bytes for the current file.</value>
#endif
public long TotalNumberOfBytesForCurrentFile { get; set; }
/// <summary>
/// The string representation of this instance of DownloadDirectoryProgressArgs.
/// </summary>
/// <returns>The string representation of this instance of DownloadDirectoryProgressArgs.</returns>
public override string ToString()
{
return string.Format(CultureInfo.InvariantCulture, "Total Files: {0}, Downloaded Files {1}, Total Bytes: {2}, Transferred Bytes: {3}",
this.TotalNumberOfFiles, this.NumberOfFilesDownloaded, this.TotalBytes, this.TransferredBytes);
}
}
}