websocket-sharp/websocket-sharp/Net/NetworkCredential.cs

#region License
/*
 * NetworkCredential.cs
 *
 * The MIT License
 *
 * Copyright (c) 2014-2023 sta.blockhead
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#endregion

using System;

namespace WebSocketSharp.Net
{
  /// <summary>
  /// Provides the credentials for the password-based authentication.
  /// </summary>
  public class NetworkCredential
  {
    #region Private Fields

    private string                   _domain;
    private static readonly string[] _noRoles;
    private string                   _password;
    private string[]                 _roles;
    private string                   _username;

    #endregion

    #region Static Constructor

    static NetworkCredential ()
    {
      _noRoles = new string[0];
    }

    #endregion

    #region Public Constructors

    /// <summary>
    /// Initializes a new instance of the <see cref="NetworkCredential"/> class
    /// with the specified username and password.
    /// </summary>
    /// <param name="username">
    /// A <see cref="string"/> that specifies the username associated with
    /// the credentials.
    /// </param>
    /// <param name="password">
    /// A <see cref="string"/> that specifies the password for the username
    /// associated with the credentials.
    /// </param>
    /// <exception cref="ArgumentException">
    /// <paramref name="username"/> is an empty string.
    /// </exception>
    /// <exception cref="ArgumentNullException">
    /// <paramref name="username"/> is <see langword="null"/>.
    /// </exception>
    public NetworkCredential (string username, string password)
      : this (username, password, null, null)
    {
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="NetworkCredential"/> class
    /// with the specified username, password, domain and roles.
    /// </summary>
    /// <param name="username">
    /// A <see cref="string"/> that specifies the username associated with
    /// the credentials.
    /// </param>
    /// <param name="password">
    /// A <see cref="string"/> that specifies the password for the username
    /// associated with the credentials.
    /// </param>
    /// <param name="domain">
    /// A <see cref="string"/> that specifies the domain associated with
    /// the credentials.
    /// </param>
    /// <param name="roles">
    /// An array of <see cref="string"/> that specifies the roles associated
    /// with the credentials if any.
    /// </param>
    /// <exception cref="ArgumentException">
    /// <paramref name="username"/> is an empty string.
    /// </exception>
    /// <exception cref="ArgumentNullException">
    /// <paramref name="username"/> is <see langword="null"/>.
    /// </exception>
    public NetworkCredential (
      string username,
      string password,
      string domain,
      params string[] roles
    )
    {
      if (username == null)
        throw new ArgumentNullException ("username");

      if (username.Length == 0)
        throw new ArgumentException ("An empty string.", "username");

      _username = username;
      _password = password;
      _domain = domain;
      _roles = roles;
    }

    #endregion

    #region Public Properties

    /// <summary>
    /// Gets the domain associated with the credentials.
    /// </summary>
    /// <value>
    ///   <para>
    ///   A <see cref="string"/> that represents the domain name
    ///   to which the username belongs.
    ///   </para>
    ///   <para>
    ///   An empty string if the value was initialized with
    ///   <see langword="null"/>.
    ///   </para>
    /// </value>
    public string Domain {
      get {
        return _domain ?? String.Empty;
      }

      internal set {
        _domain = value;
      }
    }

    /// <summary>
    /// Gets the password for the username associated with the credentials.
    /// </summary>
    /// <value>
    ///   <para>
    ///   A <see cref="string"/> that represents the password.
    ///   </para>
    ///   <para>
    ///   An empty string if the value was initialized with
    ///   <see langword="null"/>.
    ///   </para>
    /// </value>
    public string Password {
      get {
        return _password ?? String.Empty;
      }

      internal set {
        _password = value;
      }
    }

    /// <summary>
    /// Gets the roles associated with the credentials.
    /// </summary>
    /// <value>
    ///   <para>
    ///   An array of <see cref="string"/> that represents the role names
    ///   to which the username belongs.
    ///   </para>
    ///   <para>
    ///   An empty array if the role names were initialized with
    ///   <see langword="null"/>.
    ///   </para>
    /// </value>
    public string[] Roles {
      get {
        return _roles ?? _noRoles;
      }

      internal set {
        _roles = value;
      }
    }

    /// <summary>
    /// Gets the username associated with the credentials.
    /// </summary>
    /// <value>
    /// A <see cref="string"/> that represents the username.
    /// </value>
    public string Username {
      get {
        return _username;
      }

      internal set {
        _username = value;
      }
    }

    #endregion
  }
}