#region License
/*
* NetworkCredential.cs
*
* The MIT License
*
* Copyright (c) 2014-2017 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
{
///
/// Provides the credentials for the password-based authentication.
///
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
///
/// Initializes a new instance of the class with
/// the specified and .
///
///
/// A that represents the username associated with
/// the credentials.
///
///
/// A that represents the password for the username
/// associated with the credentials.
///
///
/// is .
///
///
/// is empty.
///
public NetworkCredential (string username, string password)
: this (username, password, null, null)
{
}
///
/// Initializes a new instance of the class with
/// the specified , ,
/// and .
///
///
/// A that represents the username associated with
/// the credentials.
///
///
/// A that represents the password for the username
/// associated with the credentials.
///
///
/// A that represents the domain associated with
/// the credentials.
///
///
/// An array of that represents the roles
/// associated with the credentials if any.
///
///
/// is .
///
///
/// is empty.
///
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
///
/// Gets the domain associated with the credentials.
///
///
/// This property returns an empty string if the domain was
/// initialized with .
///
///
/// A that represents the domain name
/// to which the username belongs.
///
public string Domain {
get {
return _domain ?? String.Empty;
}
internal set {
_domain = value;
}
}
///
/// Gets the password for the username associated with the credentials.
///
///
/// This property returns an empty string if the password was
/// initialized with .
///
///
/// A that represents the password.
///
public string Password {
get {
return _password ?? String.Empty;
}
internal set {
_password = value;
}
}
///
/// Gets the roles associated with the credentials.
///
///
/// This property returns an empty array if the roles were
/// initialized with .
///
///
/// An array of that represents the role names
/// to which the username belongs.
///
public string[] Roles {
get {
return _roles ?? _noRoles;
}
internal set {
_roles = value;
}
}
///
/// Gets the username associated with the credentials.
///
///
/// A that represents the username.
///
public string Username {
get {
return _username;
}
internal set {
_username = value;
}
}
#endregion
}
}