/// <summary>
/// Retrieves details about the identified record from the server.
/// </summary>
/// <param name='uid'>
/// The UID of the record to be read.
/// </param>
/// <param name='read_key'>
/// A token that grants permission to read the record.
/// </param>
/// <param name='timeout'>
/// The number of seconds to wait for a response; defaults to 2.5.
/// </param>
/// <exception cref="System.Exception">
/// Some unknown problem occurred.
/// </exception>
/// <exception cref="Exceptions.ProtocolError">
/// A problem occurred related to the transport protocol.
/// </exception>
/// <exception cref="Exceptions.UrlError">
/// A problem occurred related to the network environment.
/// </exception>
/// <exception cref="Exceptions.NotFoundError">
/// The requested record was not found.
/// </exception>
/// <exception cref="Exceptions.NotPresentError">
/// The requested record was found, but no content is available.
/// </exception>
/// <exception cref="Exceptions.NotAuthorisedError">
/// The requested record was not accessible with the given credentials.
/// </exception>
public Structures.Internal.Description Describe(string uid, string read_key, float timeout=2.5f)
{
Jayrock.Json.JsonObject describe = new Jayrock.Json.JsonObject();
describe.Add("uid", uid);
Jayrock.Json.JsonObject keys = new Jayrock.Json.JsonObject();
keys.Add("read", read_key);
describe.Add("keys", keys);
System.Net.HttpWebRequest request = Libraries.Communication.AssembleRequest(this.server.GetHost() + Libraries.Communication.SERVER_DESCRIBE, describe);
Structures.Internal.Description description = new Structures.Internal.Description(Libraries.Communication.SendRequest(request, timeout:timeout).ToDictionary());
if(!description.Physical.Exists){
throw new Exceptions.NotPresentError(description);
}
return description;
}
/// <summary>
/// Stores the content of <c>data</c> in the proxy's buffers, returning information about how to access it later.
///
/// It is important to note that the data is NOT actually stored when this pointer is returned,
/// but rather that the pointer will be valid at some point in the future (typically very soon,
/// but not within a predictable timeframe).
/// </summary>
/// <param name='data'>
/// The path to the content to be stored.
/// </param>
/// <param name='mime'>
/// The MIME-type of the content being stored.
/// </param>
/// <param name='family'>
/// The case-sensitive, arbitrary family to which the data belongs; defaults to <c>null</c>, for the
/// generic family.
/// </param>
/// <param name='compression'>
/// The type of compression to apply when storing the file; defaults to <c>COMPRESSION.NONE</c>
/// </param>
/// <param name='compress_on_server'>
/// Indicates whether the proxy should require the server to perform compression, rather than trying
/// locally; defaults to <c>false</c>.
/// </param>
/// <param name='deletion_policy'>
/// May either be <c>null</c>, the default, which means the file is never removed or a <see cref="Structures.DeletionPolicy"/>
/// instance.
/// </param>
/// <param name='compression_policy'>
/// May either be <c>null</c>, the default, which means the file is never compressed or a <see cref="Structures.CompressionPolicy"/>
/// instance.
/// </param>
/// <param name='meta'>
/// Any additional metadata with which to tag the file; defaults to <c>null</c>, meaning no metadata.
/// </param>
/// <param name='uid'>
/// If not implementing a proxy, leave this value at its default of <c>null</c> to have an identifier auto-generated or pick something that
/// has no chance of colliding with a UUID(1).
/// </param>
/// <param name='keys'>
/// In general, you should not need to specify anything, leaving it at <c>null</c>, but if you have a homogenous
/// or anonymous access policy, a <see cref="Structures.Keys"/> instance may be used, with either key set to an arbitrary string or
/// <c>null</c>, with <c>null</c> granting anonymous access to the corresponding facet.
///
/// Either element may be omitted to have it generated by the server.
/// </param>
/// <param name='timeout'>
/// The number of seconds to wait for a response; defaults to 3.
/// </param>
/// <exception cref="System.Exception">
/// Some unknown problem occurred.
/// </exception>
/// <exception cref="Exceptions.ProtocolError">
/// A problem occurred related to the transport protocol.
/// </exception>
/// <exception cref="Exceptions.UrlError">
/// A problem occurred related to the network environment.
/// </exception>
public Structures.Storage Put(
string data, string mime, string family=null,
COMPRESSION compression=COMPRESSION.NONE, bool compress_on_server=false,
Structures.DeletionPolicy deletion_policy=null,
Structures.CompressionPolicy compression_policy=null,
COMPRESSION compression_policy_format=COMPRESSION.NONE,
System.Collections.Generic.IDictionary<string, object> meta=null,
string uid=null, Structures.Keys keys=null,
float timeout=3.0f
)
{
Jayrock.Json.JsonObject put = new Jayrock.Json.JsonObject();
put.Add("uid", uid);
put.Add("keys", keys);
put.Add("meta", meta);
Jayrock.Json.JsonObject physical = new Jayrock.Json.JsonObject();
physical.Add("family", family);
Jayrock.Json.JsonObject format = new Jayrock.Json.JsonObject();
format.Add("mime", mime);
format.Add("comp", compression != COMPRESSION.NONE ? compression.ToString().ToLower() : null);
physical.Add("format", format);
put.Add("physical", physical);
Jayrock.Json.JsonObject policy = new Jayrock.Json.JsonObject();
policy.Add("delete", deletion_policy != null ? deletion_policy.ToDictionary() : null);
policy.Add("compress", compression_policy != null ? compression_policy.ToDictionary() : null);
put.Add("policy", policy);
Jayrock.Json.JsonObject proxy = new Jayrock.Json.JsonObject();
proxy.Add("server", this.server.ToDictionary());
proxy.Add("data", data);
put.Add("proxy", proxy);
System.Net.HttpWebRequest request = Libraries.Communication.AssembleRequest(this.proxy + Libraries.Communication.SERVER_PUT, put);
return new Structures.Storage(Libraries.Communication.SendRequest(request, timeout:timeout).ToDictionary());
}
/// <summary>
/// Unlinks the identified data on the server.
/// </summary>
/// <param name='uid'>
/// The UID of the record to be unlinked.
/// </param>
/// <param name='write_key'>
/// A token that grants permission to modify the record.
/// </param>
/// <param name='timeout'>
/// The number of seconds to wait for a response; defaults to 2.5.
/// </param>
/// <exception cref="System.Exception">
/// Some unknown problem occurred.
/// </exception>
/// <exception cref="Exceptions.ProtocolError">
/// A problem occurred related to the transport protocol.
/// </exception>
/// <exception cref="Exceptions.UrlError">
/// A problem occurred related to the network environment.
/// </exception>
/// <exception cref="Exceptions.NotFoundError">
/// The requested record was not found.
/// </exception>
/// <exception cref="Exceptions.NotAuthorisedError">
/// The requested record was not accessible with the given credentials.
/// </exception>
public void Unlink(string uid, string write_key, float timeout=2.5f)
{
Jayrock.Json.JsonObject unlink = new Jayrock.Json.JsonObject();
unlink.Add("uid", uid);
Jayrock.Json.JsonObject keys = new Jayrock.Json.JsonObject();
keys.Add("write", write_key);
unlink.Add("keys", keys);
System.Net.HttpWebRequest request = Libraries.Communication.AssembleRequest(this.server.GetHost() + Libraries.Communication.SERVER_UNLINK, unlink);
Libraries.Communication.SendRequest(request, timeout:timeout);
}
/// <summary>
/// Updates attributes of an existing record on a server.
/// </summary>
/// <param name='uid'>
/// The UID of the record to be updated.
/// </param>
/// <param name='write_key'>
/// A token that grants permission to modify the record.
/// </param>
/// <param name='new_meta'>
/// Any newly added metadata; defaults to <c>null</c>.
/// </param>
/// <param name='removed_meta'>
/// A list of all metadata to be removed; defaults to <c>null</c>.
/// </param>
/// <param name='deletion_policy'>
/// May either be <c>null</c>, the default, which means no change, or a
/// dictionary containing one or both of the following:
/// <list>
/// <item>'fixed': The number of seconds to retain the file from the time it was uploaded</item>
/// <item>'stale': The number of seconds that must elapse after the file was last downloaded to qualify it for deletion</item>
/// </list>
/// </param>
/// <param name='compression_policy'>
/// May either be <c>null</c>, the default, which means the file is never compressed, or a
/// dictionary containing one or both of the following:
/// <list>
/// <item>'fixed': The number of seconds to leave the file alone from the time it was uploaded</item>
/// <item>'stale': The number of seconds that must elapse after the file was last downloaded to qualify it for compression</item>
/// </list>
/// </param>
/// <param name='compression_policy_format'>
/// The format into which the file will be compressed once the compression policy activates; defaults to <c>COMPRESSION.NONE</c>.
/// </param>
/// <param name='timeout'>
/// The number of seconds to wait for a response; defaults to 2.5.
/// </param>
/// <exception cref="System.Exception">
/// Some unknown problem occurred.
/// </exception>
/// <exception cref="Exceptions.ProtocolError">
/// A problem occurred related to the transport protocol.
/// </exception>
/// <exception cref="Exceptions.UrlError">
/// A problem occurred related to the network environment.
/// </exception>
/// <exception cref="Exceptions.NotFoundError">
/// The requested record was not found.
/// </exception>
/// <exception cref="Exceptions.NotAuthorisedError">
/// The requested record was not accessible with the given credentials.
/// </exception>
public void Update(string uid, string write_key,
System.Collections.Generic.IDictionary<string, object> new_meta=null,
System.Collections.Generic.IList<string> removed_meta=null,
Structures.DeletionPolicy deletion_policy=null,
Structures.CompressionPolicy compression_policy=null,
float timeout=2.5f
)
{
Jayrock.Json.JsonObject update = new Jayrock.Json.JsonObject();
update.Add("uid", uid);
Jayrock.Json.JsonObject keys = new Jayrock.Json.JsonObject();
keys.Add("write", write_key);
update.Add("keys", keys);
Jayrock.Json.JsonObject policy = new Jayrock.Json.JsonObject();
policy.Add("delete", deletion_policy != null ? deletion_policy.ToDictionary() : null);
policy.Add("compress", compression_policy != null ? compression_policy.ToDictionary() : null);
update.Add("policy", policy);
Jayrock.Json.JsonObject meta = new Jayrock.Json.JsonObject();
meta.Add("new", new_meta != null ? new_meta : new System.Collections.Generic.Dictionary<string, object>());
meta.Add("removed", removed_meta != null ? removed_meta : new System.Collections.Generic.List<string>());
update.Add("meta", meta);
System.Net.HttpWebRequest request = Libraries.Communication.AssembleRequest(this.server.GetHost() + Libraries.Communication.SERVER_UPDATE, update);
Libraries.Communication.SendRequest(request, timeout:timeout);
}
/// <summary>
/// Stores the content of <c>data</c> on the server, returning information about how to access it later.
/// </summary>
/// <param name='data'>
/// The content to be stored.
/// </param>
/// <param name='mime'>
/// The MIME-type of the content being stored.
/// </param>
/// <param name='family'>
/// The case-sensitive, arbitrary family to which the data belongs; defaults to <c>null</c>, for the
/// generic family.
/// </param>
/// <param name='compression'>
/// The type of compression to apply when storing the file; defaults to <c>COMPRESSION.NONE</c>
/// </param>
/// <param name='compress_on_server'>
/// Indicates whether the client should require the server to perform compression, rather than trying
/// locally; defaults to <c>false</c>.
/// </param>
/// <param name='deletion_policy'>
/// May either be <c>null</c>, the default, which means the file is never removed or a <see cref="Structures.DeletionPolicy"/>
/// instance.
/// </param>
/// <param name='compression_policy'>
/// May either be <c>null</c>, the default, which means the file is never compressed or a <see cref="Structures.CompressionPolicy"/>
/// instance.
/// </param>
/// <param name='meta'>
/// Any additional metadata with which to tag the file; defaults to <c>null</c>, meaning no metadata.
/// </param>
/// <param name='uid'>
/// If not implementing a proxy, leave this value at its default of <c>null</c> to have an identifier auto-generated or pick something that
/// has no chance of colliding with a UUID(1).
/// </param>
/// <param name='keys'>
/// In general, you should not need to specify anything, leaving it at <c>null</c>, but if you have a homogenous
/// or anonymous access policy, a <see cref="Structures.Keys"/> instance may be used, with either key set to an arbitrary string or
/// <c>null</c>, with <c>null</c> granting anonymous access to the corresponding facet.
///
/// Either element may be omitted to have it generated by the server.
/// </param>
/// <param name='timeout'>
/// The number of seconds to wait for a response; defaults to 10.
/// </param>
/// <exception cref="System.Exception">
/// Some unknown problem occurred.
/// </exception>
/// <exception cref="Exceptions.ProtocolError">
/// A problem occurred related to the transport protocol.
/// </exception>
/// <exception cref="Exceptions.UrlError">
/// A problem occurred related to the network environment.
/// </exception>
public Structures.Storage Put(
System.IO.Stream data, string mime, string family=null,
COMPRESSION compression=COMPRESSION.NONE, bool compress_on_server=false,
Structures.DeletionPolicy deletion_policy=null,
Structures.CompressionPolicy compression_policy=null,
System.Collections.Generic.IDictionary<string, object> meta=null,
string uid=null, Structures.Keys keys=null,
float timeout=10.0f
)
{
Jayrock.Json.JsonObject put = new Jayrock.Json.JsonObject();
put.Add("uid", uid);
put.Add("keys", keys);
put.Add("meta", meta);
Jayrock.Json.JsonObject physical = new Jayrock.Json.JsonObject();
physical.Add("family", family);
Jayrock.Json.JsonObject format = new Jayrock.Json.JsonObject();
format.Add("mime", mime);
format.Add("comp", compression != COMPRESSION.NONE ? compression.ToString().ToLower() : null);
physical.Add("format", format);
put.Add("physical", physical);
Jayrock.Json.JsonObject policy = new Jayrock.Json.JsonObject();
policy.Add("delete", deletion_policy != null ? deletion_policy.ToDictionary() : null);
policy.Add("compress", compression_policy != null ? compression_policy.ToDictionary() : null);
put.Add("policy", policy);
System.Collections.Generic.Dictionary<string, string> headers = new System.Collections.Generic.Dictionary<string, string>();
if(!compress_on_server){
try{
data = Libraries.Compression.GetCompressor(compression).Invoke(data);
headers.Add(Libraries.Communication.HEADER_COMPRESS_ON_SERVER, Libraries.Communication.HEADER_COMPRESS_ON_SERVER_FALSE);
}catch(System.Exception){
headers.Add(Libraries.Communication.HEADER_COMPRESS_ON_SERVER, Libraries.Communication.HEADER_COMPRESS_ON_SERVER_TRUE);
}
}else{
headers.Add(Libraries.Communication.HEADER_COMPRESS_ON_SERVER, Libraries.Communication.HEADER_COMPRESS_ON_SERVER_TRUE);
}
System.Net.HttpWebRequest request = Libraries.Communication.AssembleRequest(this.server.GetHost() + Libraries.Communication.SERVER_PUT, put, headers:headers, data:data);
return new Structures.Storage(Libraries.Communication.SendRequest(request, timeout:timeout).ToDictionary());
}
/// <summary>
/// Retrieves the identified data from the server.
/// </summary>
/// <returns>
/// Returns the content's MIME and the decompressed data as a stream (optionally that
/// supplied as <c>output_file</c>), along with the length of the content in bytes.
/// </returns>
/// <param name='uid'>
/// The UID of the record to be retrieved.
/// </param>
/// <param name='read_key'>
/// A token that grants permission to read the record.
/// </param>
/// <param name='output_file'>
/// An optional stream into which retrieved content may be written; if <c>null</c>, the
/// default, an on-disk, self-cleaning tempfile, is used instead.
/// </param>
/// <param name='decompress_on_server'>
/// Favours decompression of content on the server; defaults to <c>false</c>.
/// </param>
/// <param name='timeout'>
/// The number of seconds to wait for a response; defaults to 5.
/// </param>
/// <exception cref="System.Exception">
/// Some unknown problem occurred.
/// </exception>
/// <exception cref="Exceptions.ProtocolError">
/// A problem occurred related to the transport protocol.
/// </exception>
/// <exception cref="Exceptions.UrlError">
/// A problem occurred related to the network environment.
/// </exception>
/// <exception cref="Exceptions.NotFoundError">
/// The requested record was not found.
/// </exception>
/// <exception cref="Exceptions.NotAuthorisedError">
/// The requested record was not accessible with the given credentials.
/// </exception>
public Structures.Internal.Content Get(string uid, string read_key, System.IO.Stream output_file=null, bool decompress_on_server=false, float timeout=5.0f)
{
Jayrock.Json.JsonObject get_json = new Jayrock.Json.JsonObject();
get_json.Add("uid", uid);
Jayrock.Json.JsonObject keys = new Jayrock.Json.JsonObject();
keys.Add("read", read_key);
get_json.Add("keys", keys);
System.Collections.Generic.Dictionary<string, string> headers = new System.Collections.Generic.Dictionary<string, string>();
if(!decompress_on_server){
headers.Add(Libraries.Communication.HEADER_SUPPORTED_COMPRESSION, string.Join(Libraries.Communication.HEADER_SUPPORTED_COMPRESSION_DELIMITER.ToString(), Libraries.Compression.SupportedFormats));
}
System.Net.HttpWebRequest request = Libraries.Communication.AssembleRequest(this.server.GetHost() + Libraries.Communication.SERVER_GET, get_json, headers:headers);
System.IO.Stream output;
if(output_file != null){
output = output_file;
}else{
output = new Libraries.TempFileStream();
}
Libraries.Communication.Response response = Libraries.Communication.SendRequest(request, output:output, timeout:timeout);
Structures.Internal.Content content = new Structures.Internal.Content();
content.Data = response.Data;
content.Mime = (string)response.Properties[Libraries.Communication.PROPERTY_CONTENT_TYPE];
content.Length = (long)response.Properties[Libraries.Communication.PROPERTY_CONTENT_LENGTH];
//Evaluate decompression requirements
object applied_compression = response.Properties[Libraries.Communication.PROPERTY_APPLIED_COMPRESSION];
if(applied_compression != null){
System.IO.Stream decompressed_data = Libraries.Compression.GetDecompressor((COMPRESSION)applied_compression).Invoke(content.Data);
if(output_file != null){ //Write to the given stream, since the caller might expect to use that
output_file.Seek(0, System.IO.SeekOrigin.Begin);
output_file.SetLength(0); //Truncate the file
decompressed_data.CopyTo(output_file);
output_file.Seek(0, System.IO.SeekOrigin.Begin);
content.Data = output_file;
content.Length = output_file.Length;
}
}
return content;
}
/// <summary>
/// Serialises the query object as a media-storage-query-compatible, JSON-friendly data-structure.
/// </summary>
/// <returns>
/// A JSON-friendly dictionary representation of the query object in its current state.
/// </returns>
internal System.Collections.Generic.IDictionary<string, object> ToDictionary()
{
Jayrock.Json.JsonObject json_struct = new Jayrock.Json.JsonObject();
Jayrock.Json.JsonObject ctime = new Jayrock.Json.JsonObject();
ctime.Add("min", Libraries.Structures.ToUnixTimestamp(this.CtimeMin));
ctime.Add("max", Libraries.Structures.ToUnixTimestamp(this.CtimeMax));
json_struct.Add("ctime", ctime);
Jayrock.Json.JsonObject atime = new Jayrock.Json.JsonObject();
atime.Add("min", Libraries.Structures.ToUnixTimestamp(this.AtimeMin));
atime.Add("max", Libraries.Structures.ToUnixTimestamp(this.AtimeMax));
json_struct.Add("atime", atime);
Jayrock.Json.JsonObject accesses = new Jayrock.Json.JsonObject();
accesses.Add("min", this.AccessesMin);
accesses.Add("max", this.AccessesMax);
json_struct.Add("accesses", accesses);
json_struct.Add("family", this.Family);
json_struct.Add("mime", this.Mime);
json_struct.Add("meta", this.Meta);
return json_struct;
}
/// <summary>
/// Retrieves details about the requested record from the cache.
///
/// The provided details may not be entirely current, since cached copies will be used when possible.
/// </summary>
/// <param name='uid'>
/// The UID of the record to be read.
/// </param>
/// <param name='read_key'>
/// A token that grants permission to read the record.
/// </param>
/// <param name='timeout'>
/// The number of seconds to wait for a response; defaults to 2.5.
/// </param>
/// <exception cref="System.Exception">
/// Some unknown problem occurred.
/// </exception>
/// <exception cref="Exceptions.ProtocolError">
/// A problem occurred related to the transport protocol.
/// </exception>
/// <exception cref="Exceptions.UrlError">
/// A problem occurred related to the network environment.
/// </exception>
/// <exception cref="Exceptions.NotFoundError">
/// The requested record was not found.
/// </exception>
/// <exception cref="Exceptions.NotAuthorisedError">
/// The requested record was not accessible with the given credentials.
/// </exception>
public Structures.Internal.Description Describe(string uid, string read_key, float timeout=2.5f)
{
Jayrock.Json.JsonObject describe = new Jayrock.Json.JsonObject();
describe.Add("uid", uid);
Jayrock.Json.JsonObject keys = new Jayrock.Json.JsonObject();
keys.Add("read", read_key);
describe.Add("keys", keys);
Jayrock.Json.JsonObject proxy = new Jayrock.Json.JsonObject();
proxy.Add("server", this.server.ToDictionary());
describe.Add("proxy", proxy);
System.Net.HttpWebRequest request = Libraries.Communication.AssembleRequest(this.proxy + Libraries.Communication.SERVER_DESCRIBE, describe);
return new Structures.Internal.Description(Libraries.Communication.SendRequest(request, timeout:timeout).ToDictionary());
}
/// <summary>
/// Retrieves the requested data from the cache.
/// </summary>
/// <returns>
/// Returns the content's MIME and the decompressed data as a stream (optionally that
/// supplied as <c>output_file</c>), along with the length of the content in bytes.
/// </returns>
/// <param name='uid'>
/// The UID of the record to be retrieved.
/// </param>
/// <param name='read_key'>
/// A token that grants permission to read the record.
/// </param>
/// <param name='output_file'>
/// An optional stream into which retrieved content may be written; if <c>null</c>, the
/// default, an on-disk, self-cleaning tempfile, is used instead.
/// </param>
/// <param name='decompress_on_server'>
/// Ignored, since this decision is up to the proxy.
/// </param>
/// <param name='timeout'>
/// The number of seconds to wait for a response; defaults to 5.
/// </param>
/// <exception cref="System.Exception">
/// Some unknown problem occurred.
/// </exception>
/// <exception cref="Exceptions.ProtocolError">
/// A problem occurred related to the transport protocol.
/// </exception>
/// <exception cref="Exceptions.UrlError">
/// A problem occurred related to the network environment.
/// </exception>
/// <exception cref="Exceptions.NotFoundError">
/// The requested record was not found.
/// </exception>
/// <exception cref="Exceptions.NotAuthorisedError">
/// The requested record was not accessible with the given credentials.
/// </exception>
public Structures.Internal.Content Get(string uid, string read_key, System.IO.Stream output_file=null, bool decompress_on_server=false, float timeout=5.0f)
{
Jayrock.Json.JsonObject get_json = new Jayrock.Json.JsonObject();
get_json.Add("uid", uid);
Jayrock.Json.JsonObject keys = new Jayrock.Json.JsonObject();
keys.Add("read", read_key);
get_json.Add("keys", keys);
Jayrock.Json.JsonObject proxy = new Jayrock.Json.JsonObject();
proxy.Add("server", this.server.ToDictionary());
get_json.Add("proxy", proxy);
System.Net.HttpWebRequest request = Libraries.Communication.AssembleRequest(this.proxy + Libraries.Communication.SERVER_GET, get_json);
Libraries.Communication.Response response = Libraries.Communication.SendRequest(request, timeout:timeout);
Structures.Internal.Content content = new Structures.Internal.Content();
if(output_file != null){
content.Data = output_file;
}else{
content.Data = new Libraries.TempFileStream();
}
response.Data.CopyTo(content.Data);
content.Length = content.Data.Length;
content.Data.Seek(0, System.IO.SeekOrigin.Begin);
content.Mime = (string)response.Properties[Libraries.Communication.PROPERTY_CONTENT_TYPE];
return content;
}
