using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Nuclex.Networking.Gallery3.Requests {

  /// <summary>Creates requests to read or write resources</summary>
  /// <remarks>
  ///   This interface enables unit tests to mock the requests instead of depending
  ///   on an actual web server to validate request-generating code. It also
  ///   provides a way for the user to set up requests using HTTP authentication
  ///   or adding extra headers to a request.
  /// </remarks>
  public interface IRequestFactory {

    /// <summary>Creates a new request for the specified resource</summary>
    /// <param name="resourceUrl">Resource the request will access</param>
    /// <returns>The new request</returns>
    /// <remarks>
    ///   The <paramref name="resourceUrl" /> parameter contains an URI relative
    ///   to a base URI the request factory is responsible for storing. For
    ///   example, if a factory serves 'http://mygallery.com/' and a request is
    ///   created for the resource 'rest/item/1', the request should query for
    ///   'http://mygallery.com/rest/item/1'.
    /// </remarks>
    IRequest CreateRequest(string resourceUrl);

/*
    /// <summary>Creates a new request with JSON-encoded data appended</summary>
    /// <param name="resourceUrl">Resource the request will access</param>
    /// <typeparam name="AttachmentType">
    ///   Type of the data that will be attached as JSON
    /// </typeparam>
    /// <param name="attachment">The data that will be attached in JSON format</param>
    /// <returns>The new request</returns>
    /// <remarks>
    ///   The <paramref name="resourceUrl" /> parameter contains an URI relative
    ///   to a base URI the request factory is responsible for storing. For
    ///   example, if a factory serves 'http://mygallery.com/' and a request is
    ///   created for the resource 'rest/item/1', the request should query for
    ///   'http://mygallery.com/rest/item/1'.
    /// </remarks>
    IRequest CreateJsonRequest<AttachmentType>(
      string resourceUrl, AttachmentType attachment
    );
*/
  }

} // namespace Nuclex.Networking.Gallery3.Requests